Update docs for 1.4.1 release
diff --git a/docs/dyn/adexchangebuyer_v1_3.creatives.html b/docs/dyn/adexchangebuyer_v1_3.creatives.html
index fd161ca..4723382 100644
--- a/docs/dyn/adexchangebuyer_v1_3.creatives.html
+++ b/docs/dyn/adexchangebuyer_v1_3.creatives.html
@@ -134,7 +134,7 @@
],
},
],
- "filteringReasons": { # The filtering reasons for the creative. If this feature is not enabled, please ask your technical account manager. Read-only. This field should not be set in requests.
+ "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.
{
@@ -202,7 +202,7 @@
],
},
],
- "filteringReasons": { # The filtering reasons for the creative. If this feature is not enabled, please ask your technical account manager. Read-only. This field should not be set in requests.
+ "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.
{
@@ -265,7 +265,7 @@
],
},
],
- "filteringReasons": { # The filtering reasons for the creative. If this feature is not enabled, please ask your technical account manager. Read-only. This field should not be set in requests.
+ "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.
{
@@ -346,7 +346,7 @@
],
},
],
- "filteringReasons": { # The filtering reasons for the creative. If this feature is not enabled, please ask your technical account manager. Read-only. This field should not be set in requests.
+ "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.
{
diff --git a/docs/dyn/adexchangebuyer_v1_3.html b/docs/dyn/adexchangebuyer_v1_3.html
index a388f8a..51d5a85 100644
--- a/docs/dyn/adexchangebuyer_v1_3.html
+++ b/docs/dyn/adexchangebuyer_v1_3.html
@@ -109,4 +109,25 @@
</p>
<p class="firstline">Returns the pretargetingConfig 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/adexchangebuyer_v1_3.performanceReport.html b/docs/dyn/adexchangebuyer_v1_3.performanceReport.html
index b51f52f..2764e41 100644
--- a/docs/dyn/adexchangebuyer_v1_3.performanceReport.html
+++ b/docs/dyn/adexchangebuyer_v1_3.performanceReport.html
@@ -96,10 +96,14 @@
"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.
+ "bidRequestRate": 3.14, # The number of bid requests sent to your bidder.
+ "unsuccessfulRequestRate": 3.14, # The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.
+ "successfulRequestRate": 3.14, # The number of properly formed bid responses received by our servers within the deadline.
"hostedMatchStatusRate": [ # Average QPS for hosted match operations.
"",
],
- "kind": "adexchangebuyer#performanceReport", # Resource type.
+ "bidRate": 3.14, # The number of bid responses with an ad.
+ "quotaThrottledLimit": 3.14, # The throttled quota limits for this account.
"cookieMatcherStatusRate": [ # Average QPS for cookie matcher operations.
"",
],
@@ -108,17 +112,19 @@
],
"noQuotaInRegion": 3.14, # Rate of various quota account statuses per quota check.
"timestamp": "A String", # The unix timestamp of the starting time of this performance data.
- "region": "A String", # The trading location of this data.
- "quotaConfiguredLimit": 3.14, # The configured quota limits for this account.
"latency50thPercentile": 3.14, # The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
"latency85thPercentile": 3.14, # The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
"pixelMatchResponses": 3.14, # Average QPS for pixel match responses from clients.
- "outOfQuota": 3.14, # Rate of various quota account statuses per quota check.
"creativeStatusRate": [ # Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.
"",
],
- "quotaThrottledLimit": 3.14, # The throttled quota limits for this account.
"latency95thPercentile": 3.14, # The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
+ "kind": "adexchangebuyer#performanceReport", # Resource type.
+ "inventoryMatchRate": 3.14, # The number of potential queries based on your pretargeting settings.
+ "region": "A String", # The trading location of this data.
+ "quotaConfiguredLimit": 3.14, # The configured quota limits for this account.
+ "outOfQuota": 3.14, # Rate of various quota account statuses per quota check.
+ "filteredBidRate": 3.14, # The number of bid responses that were filtered due to a policy violation or other errors.
"pixelMatchRequests": 3.14, # Average QPS for pixel match requests from clients.
},
],
diff --git a/docs/dyn/adexchangeseller_v2_0.html b/docs/dyn/adexchangeseller_v2_0.html
index 8649935..18c50b5 100644
--- a/docs/dyn/adexchangeseller_v2_0.html
+++ b/docs/dyn/adexchangeseller_v2_0.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the accounts 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_reports_v1.html b/docs/dyn/admin_reports_v1.html
index a0a2b49..7958285 100644
--- a/docs/dyn/admin_reports_v1.html
+++ b/docs/dyn/admin_reports_v1.html
@@ -94,4 +94,25 @@
</p>
<p class="firstline">Returns the userUsageReport 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/adsense_v1_4.html b/docs/dyn/adsense_v1_4.html
index 8ef7582..8455a19 100644
--- a/docs/dyn/adsense_v1_4.html
+++ b/docs/dyn/adsense_v1_4.html
@@ -124,4 +124,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/adsensehost_v4_1.html b/docs/dyn/adsensehost_v4_1.html
index 52a5227..3dd7ce1 100644
--- a/docs/dyn/adsensehost_v4_1.html
+++ b/docs/dyn/adsensehost_v4_1.html
@@ -104,4 +104,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/analytics_v3.html b/docs/dyn/analytics_v3.html
index 25a0abc..890cfac 100644
--- a/docs/dyn/analytics_v3.html
+++ b/docs/dyn/analytics_v3.html
@@ -94,4 +94,25 @@
</p>
<p class="firstline">Returns the provisioning 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/analytics_v3.management.filters.html b/docs/dyn/analytics_v3.management.filters.html
index eacfa53..1984653 100644
--- a/docs/dyn/analytics_v3.management.filters.html
+++ b/docs/dyn/analytics_v3.management.filters.html
@@ -110,28 +110,31 @@
"created": "A String", # Time this filter was created.
"uppercaseDetails": { # Details for the filter of the type UPPER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"updated": "A String", # Time this filter was last modified.
"advancedDetails": { # Details for the filter of the type ADVANCED.
+ "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractB": "A String", # Expression to extract from field B.
"overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
+ "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"fieldARequired": True or False, # Indicates if field A is required to match.
"fieldB": "A String", # Field B.
"outputConstructor": "A String", # Expression used to construct the output value.
"fieldBRequired": True or False, # Indicates if field B is required to match.
"caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
+ "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractA": "A String", # Expression to extract from field A.
"fieldA": "A String", # Field A.
"outputToField": "A String", # Output field.
},
"lowercaseDetails": { # Details for the filter of the type LOWER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"selfLink": "A String", # Link for this filter.
"excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -218,11 +221,14 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -309,6 +315,11 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
"href": "A String", # Link to the account to which this filter belongs.
@@ -318,6 +329,7 @@
"id": "A String", # Filter ID.
"searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
"caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"searchString": "A String", # Term to search.
"replaceString": "A String", # Term to replace the search term with.
"field": "A String", # Field to use in the filter.
@@ -343,28 +355,31 @@
"created": "A String", # Time this filter was created.
"uppercaseDetails": { # Details for the filter of the type UPPER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"updated": "A String", # Time this filter was last modified.
"advancedDetails": { # Details for the filter of the type ADVANCED.
+ "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractB": "A String", # Expression to extract from field B.
"overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
+ "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"fieldARequired": True or False, # Indicates if field A is required to match.
"fieldB": "A String", # Field B.
"outputConstructor": "A String", # Expression used to construct the output value.
"fieldBRequired": True or False, # Indicates if field B is required to match.
"caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
+ "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractA": "A String", # Expression to extract from field A.
"fieldA": "A String", # Field A.
"outputToField": "A String", # Output field.
},
"lowercaseDetails": { # Details for the filter of the type LOWER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"selfLink": "A String", # Link for this filter.
"excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -451,11 +466,14 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -542,6 +560,11 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
"href": "A String", # Link to the account to which this filter belongs.
@@ -551,6 +574,7 @@
"id": "A String", # Filter ID.
"searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
"caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"searchString": "A String", # Term to search.
"replaceString": "A String", # Term to replace the search term with.
"field": "A String", # Field to use in the filter.
@@ -574,28 +598,31 @@
"created": "A String", # Time this filter was created.
"uppercaseDetails": { # Details for the filter of the type UPPER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"updated": "A String", # Time this filter was last modified.
"advancedDetails": { # Details for the filter of the type ADVANCED.
+ "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractB": "A String", # Expression to extract from field B.
"overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
+ "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"fieldARequired": True or False, # Indicates if field A is required to match.
"fieldB": "A String", # Field B.
"outputConstructor": "A String", # Expression used to construct the output value.
"fieldBRequired": True or False, # Indicates if field B is required to match.
"caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
+ "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractA": "A String", # Expression to extract from field A.
"fieldA": "A String", # Field A.
"outputToField": "A String", # Output field.
},
"lowercaseDetails": { # Details for the filter of the type LOWER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"selfLink": "A String", # Link for this filter.
"excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -682,11 +709,14 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -773,6 +803,11 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
"href": "A String", # Link to the account to which this filter belongs.
@@ -782,6 +817,7 @@
"id": "A String", # Filter ID.
"searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
"caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"searchString": "A String", # Term to search.
"replaceString": "A String", # Term to replace the search term with.
"field": "A String", # Field to use in the filter.
@@ -799,28 +835,31 @@
"created": "A String", # Time this filter was created.
"uppercaseDetails": { # Details for the filter of the type UPPER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"updated": "A String", # Time this filter was last modified.
"advancedDetails": { # Details for the filter of the type ADVANCED.
+ "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractB": "A String", # Expression to extract from field B.
"overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
+ "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"fieldARequired": True or False, # Indicates if field A is required to match.
"fieldB": "A String", # Field B.
"outputConstructor": "A String", # Expression used to construct the output value.
"fieldBRequired": True or False, # Indicates if field B is required to match.
"caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
+ "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractA": "A String", # Expression to extract from field A.
"fieldA": "A String", # Field A.
"outputToField": "A String", # Output field.
},
"lowercaseDetails": { # Details for the filter of the type LOWER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"selfLink": "A String", # Link for this filter.
"excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -907,11 +946,14 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -998,6 +1040,11 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
"href": "A String", # Link to the account to which this filter belongs.
@@ -1007,6 +1054,7 @@
"id": "A String", # Filter ID.
"searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
"caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"searchString": "A String", # Term to search.
"replaceString": "A String", # Term to replace the search term with.
"field": "A String", # Field to use in the filter.
@@ -1037,28 +1085,31 @@
"created": "A String", # Time this filter was created.
"uppercaseDetails": { # Details for the filter of the type UPPER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"updated": "A String", # Time this filter was last modified.
"advancedDetails": { # Details for the filter of the type ADVANCED.
+ "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractB": "A String", # Expression to extract from field B.
"overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
+ "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"fieldARequired": True or False, # Indicates if field A is required to match.
"fieldB": "A String", # Field B.
"outputConstructor": "A String", # Expression used to construct the output value.
"fieldBRequired": True or False, # Indicates if field B is required to match.
"caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
+ "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractA": "A String", # Expression to extract from field A.
"fieldA": "A String", # Field A.
"outputToField": "A String", # Output field.
},
"lowercaseDetails": { # Details for the filter of the type LOWER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"selfLink": "A String", # Link for this filter.
"excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -1145,11 +1196,14 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -1236,6 +1290,11 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
"href": "A String", # Link to the account to which this filter belongs.
@@ -1245,6 +1304,7 @@
"id": "A String", # Filter ID.
"searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
"caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"searchString": "A String", # Term to search.
"replaceString": "A String", # Term to replace the search term with.
"field": "A String", # Field to use in the filter.
@@ -1276,28 +1336,31 @@
"created": "A String", # Time this filter was created.
"uppercaseDetails": { # Details for the filter of the type UPPER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"updated": "A String", # Time this filter was last modified.
"advancedDetails": { # Details for the filter of the type ADVANCED.
+ "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractB": "A String", # Expression to extract from field B.
"overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
+ "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"fieldARequired": True or False, # Indicates if field A is required to match.
"fieldB": "A String", # Field B.
"outputConstructor": "A String", # Expression used to construct the output value.
"fieldBRequired": True or False, # Indicates if field B is required to match.
"caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
+ "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractA": "A String", # Expression to extract from field A.
"fieldA": "A String", # Field A.
"outputToField": "A String", # Output field.
},
"lowercaseDetails": { # Details for the filter of the type LOWER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"selfLink": "A String", # Link for this filter.
"excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -1384,11 +1447,14 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -1475,6 +1541,11 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
"href": "A String", # Link to the account to which this filter belongs.
@@ -1484,6 +1555,7 @@
"id": "A String", # Filter ID.
"searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
"caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"searchString": "A String", # Term to search.
"replaceString": "A String", # Term to replace the search term with.
"field": "A String", # Field to use in the filter.
@@ -1501,28 +1573,31 @@
"created": "A String", # Time this filter was created.
"uppercaseDetails": { # Details for the filter of the type UPPER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"updated": "A String", # Time this filter was last modified.
"advancedDetails": { # Details for the filter of the type ADVANCED.
+ "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractB": "A String", # Expression to extract from field B.
"overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
+ "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"fieldARequired": True or False, # Indicates if field A is required to match.
"fieldB": "A String", # Field B.
"outputConstructor": "A String", # Expression used to construct the output value.
"fieldBRequired": True or False, # Indicates if field B is required to match.
"caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
+ "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractA": "A String", # Expression to extract from field A.
"fieldA": "A String", # Field A.
"outputToField": "A String", # Output field.
},
"lowercaseDetails": { # Details for the filter of the type LOWER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"selfLink": "A String", # Link for this filter.
"excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -1609,11 +1684,14 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -1700,6 +1778,11 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
"href": "A String", # Link to the account to which this filter belongs.
@@ -1709,6 +1792,7 @@
"id": "A String", # Filter ID.
"searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
"caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"searchString": "A String", # Term to search.
"replaceString": "A String", # Term to replace the search term with.
"field": "A String", # Field to use in the filter.
@@ -1733,28 +1817,31 @@
"created": "A String", # Time this filter was created.
"uppercaseDetails": { # Details for the filter of the type UPPER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"updated": "A String", # Time this filter was last modified.
"advancedDetails": { # Details for the filter of the type ADVANCED.
+ "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractB": "A String", # Expression to extract from field B.
"overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
+ "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"fieldARequired": True or False, # Indicates if field A is required to match.
"fieldB": "A String", # Field B.
"outputConstructor": "A String", # Expression used to construct the output value.
"fieldBRequired": True or False, # Indicates if field B is required to match.
"caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
+ "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractA": "A String", # Expression to extract from field A.
"fieldA": "A String", # Field A.
"outputToField": "A String", # Output field.
},
"lowercaseDetails": { # Details for the filter of the type LOWER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"selfLink": "A String", # Link for this filter.
"excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -1841,11 +1928,14 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -1932,6 +2022,11 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
"href": "A String", # Link to the account to which this filter belongs.
@@ -1941,6 +2036,7 @@
"id": "A String", # Filter ID.
"searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
"caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"searchString": "A String", # Term to search.
"replaceString": "A String", # Term to replace the search term with.
"field": "A String", # Field to use in the filter.
@@ -1958,28 +2054,31 @@
"created": "A String", # Time this filter was created.
"uppercaseDetails": { # Details for the filter of the type UPPER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"updated": "A String", # Time this filter was last modified.
"advancedDetails": { # Details for the filter of the type ADVANCED.
+ "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractB": "A String", # Expression to extract from field B.
"overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
+ "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"fieldARequired": True or False, # Indicates if field A is required to match.
"fieldB": "A String", # Field B.
"outputConstructor": "A String", # Expression used to construct the output value.
"fieldBRequired": True or False, # Indicates if field B is required to match.
"caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
+ "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"extractA": "A String", # Expression to extract from field A.
"fieldA": "A String", # Field A.
"outputToField": "A String", # Output field.
},
"lowercaseDetails": { # Details for the filter of the type LOWER.
"field": "A String", # Field to use in the filter.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
},
"selfLink": "A String", # Link for this filter.
"excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -2066,11 +2165,14 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
- "caseSensitive": True or False, # Determines if the filter is case sensitive.
"kind": "analytics#filterExpression", # Kind value for filter expression
- "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
"expressionValue": "A String", # Filter expression value
"field": "A String", # Field to filter. Possible values:
# - Content and Traffic
@@ -2157,6 +2259,11 @@
# - SOCIAL_NETWORK,
# - SOCIAL_ACTION,
# - SOCIAL_ACTION_TARGET,
+ # - Custom dimension
+ # - CUSTOM_DIMENSION (See accompanying field index),
+ "caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
+ "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters.
},
"parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
"href": "A String", # Link to the account to which this filter belongs.
@@ -2166,6 +2273,7 @@
"id": "A String", # Filter ID.
"searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
"caseSensitive": True or False, # Determines if the filter is case sensitive.
+ "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
"searchString": "A String", # Term to search.
"replaceString": "A String", # Term to replace the search term with.
"field": "A String", # Field to use in the filter.
diff --git a/docs/dyn/androidenterprise_v1.collections.html b/docs/dyn/androidenterprise_v1.collections.html
index 8bd44e4..41d03cf 100644
--- a/docs/dyn/androidenterprise_v1.collections.html
+++ b/docs/dyn/androidenterprise_v1.collections.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.collections.html">collections</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.collections.html">collections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(enterpriseId, collectionId)</a></code></p>
diff --git a/docs/dyn/androidenterprise_v1.collectionviewers.html b/docs/dyn/androidenterprise_v1.collectionviewers.html
index a41ecfe..97fa5b2 100644
--- a/docs/dyn/androidenterprise_v1.collectionviewers.html
+++ b/docs/dyn/androidenterprise_v1.collectionviewers.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.collectionviewers.html">collectionviewers</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.collectionviewers.html">collectionviewers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(enterpriseId, collectionId, userId)</a></code></p>
diff --git a/docs/dyn/androidenterprise_v1.devices.html b/docs/dyn/androidenterprise_v1.devices.html
index 8347a45..0ce85f6 100644
--- a/docs/dyn/androidenterprise_v1.devices.html
+++ b/docs/dyn/androidenterprise_v1.devices.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.devices.html">devices</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.devices.html">devices</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(enterpriseId, userId, deviceId)</a></code></p>
@@ -103,6 +103,7 @@
#
# This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
"kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
+ "managementType": "A String", # The mechanism by which this device is managed by the MDM. "managedDevice" means that the MDM's app is a device owner. "managedProfile" means that the MDM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the MDM's app is managing the Android for Work container app on the device.
"androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
}</pre>
</div>
@@ -142,6 +143,7 @@
#
# This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
"kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
+ "managementType": "A String", # The mechanism by which this device is managed by the MDM. "managedDevice" means that the MDM's app is a device owner. "managedProfile" means that the MDM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the MDM's app is managing the Android for Work container app on the device.
"androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
},
],
diff --git a/docs/dyn/androidenterprise_v1.enterprises.html b/docs/dyn/androidenterprise_v1.enterprises.html
index d8a1800..6743d07 100644
--- a/docs/dyn/androidenterprise_v1.enterprises.html
+++ b/docs/dyn/androidenterprise_v1.enterprises.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.enterprises.html">enterprises</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.enterprises.html">enterprises</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(enterpriseId)</a></code></p>
diff --git a/docs/dyn/androidenterprise_v1.entitlements.html b/docs/dyn/androidenterprise_v1.entitlements.html
index 645bf3c..598bee5 100644
--- a/docs/dyn/androidenterprise_v1.entitlements.html
+++ b/docs/dyn/androidenterprise_v1.entitlements.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.entitlements.html">entitlements</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.entitlements.html">entitlements</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(enterpriseId, userId, entitlementId)</a></code></p>
diff --git a/docs/dyn/androidenterprise_v1.grouplicenses.html b/docs/dyn/androidenterprise_v1.grouplicenses.html
index 90e1069..cb398f3 100644
--- a/docs/dyn/androidenterprise_v1.grouplicenses.html
+++ b/docs/dyn/androidenterprise_v1.grouplicenses.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.grouplicenses.html">grouplicenses</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.grouplicenses.html">grouplicenses</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(enterpriseId, groupLicenseId)</a></code></p>
diff --git a/docs/dyn/androidenterprise_v1.grouplicenseusers.html b/docs/dyn/androidenterprise_v1.grouplicenseusers.html
index c798b07..70e3997 100644
--- a/docs/dyn/androidenterprise_v1.grouplicenseusers.html
+++ b/docs/dyn/androidenterprise_v1.grouplicenseusers.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.grouplicenseusers.html">grouplicenseusers</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.grouplicenseusers.html">grouplicenseusers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(enterpriseId, groupLicenseId)</a></code></p>
diff --git a/docs/dyn/androidenterprise_v1.html b/docs/dyn/androidenterprise_v1.html
index c40010c..699f811 100644
--- a/docs/dyn/androidenterprise_v1.html
+++ b/docs/dyn/androidenterprise_v1.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="androidenterprise_v1.collections.html">collections()</a></code>
@@ -129,4 +129,25 @@
</p>
<p class="firstline">Returns the users 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/androidenterprise_v1.installs.html b/docs/dyn/androidenterprise_v1.installs.html
index de5f9d9..f7e49f0 100644
--- a/docs/dyn/androidenterprise_v1.installs.html
+++ b/docs/dyn/androidenterprise_v1.installs.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.installs.html">installs</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.installs.html">installs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(enterpriseId, userId, deviceId, installId)</a></code></p>
diff --git a/docs/dyn/androidenterprise_v1.permissions.html b/docs/dyn/androidenterprise_v1.permissions.html
index 522ed0c..386e7b4 100644
--- a/docs/dyn/androidenterprise_v1.permissions.html
+++ b/docs/dyn/androidenterprise_v1.permissions.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.permissions.html">permissions</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.permissions.html">permissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(permissionId, language=None)</a></code></p>
diff --git a/docs/dyn/androidenterprise_v1.products.html b/docs/dyn/androidenterprise_v1.products.html
index 9c45f97..0d5c6dd 100644
--- a/docs/dyn/androidenterprise_v1.products.html
+++ b/docs/dyn/androidenterprise_v1.products.html
@@ -72,9 +72,15 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.products.html">products</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.products.html">products</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#approve">approve(enterpriseId, productId, body)</a></code></p>
+<p class="firstline">Approves the specified product (and the relevant app permissions, if any).</p>
+<p class="toc_element">
+ <code><a href="#generateApprovalUrl">generateApprovalUrl(enterpriseId, productId, languageCode=None)</a></code></p>
+<p class="firstline">Generates a URL that can be used to display an iframe to view the product's permissions (if any) and approve the product. This URL can be used to approve the product for a limited time (currently 1 hour) using the Products.approve call.</p>
+<p class="toc_element">
<code><a href="#get">get(enterpriseId, productId, language=None)</a></code></p>
<p class="firstline">Retrieves details of a product for display to an enterprise admin.</p>
<p class="toc_element">
@@ -88,6 +94,43 @@
<p class="firstline">Updates the set of Android app permissions for this app that have been accepted by the enterprise.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="approve">approve(enterpriseId, productId, body)</code>
+ <pre>Approves the specified product (and the relevant app permissions, if any).
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ productId: string, The ID of the product. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "approvalUrlInfo": { # Information on an approval URL.
+ "kind": "androidenterprise#approvalUrlInfo", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#approvalUrlInfo".
+ "approvalUrl": "A String", # A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call.
+ },
+ }
+
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="generateApprovalUrl">generateApprovalUrl(enterpriseId, productId, languageCode=None)</code>
+ <pre>Generates a URL that can be used to display an iframe to view the product's permissions (if any) and approve the product. This URL can be used to approve the product for a limited time (currently 1 hour) using the Products.approve call.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ productId: string, The ID of the product. (required)
+ languageCode: string, The language code that will be used for permission names and descriptions in the returned iframe.
+
+Returns:
+ An object of the form:
+
+ {
+ "url": "A String", # A iframe-able URL that displays a product's permissions (if any). This URL can be used to approve the product only once and for a limited time (1 hour), using the Products.approve call. If the product is not currently approved and has no permissions, this URL will point to an empty page. If the product is currently approved and all of its permissions (if any) are also approved, this field will not be populated.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(enterpriseId, productId, language=None)</code>
<pre>Retrieves details of a product for display to an enterprise admin.
@@ -103,10 +146,18 @@
#
# The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an MDM user interface.
"kind": "androidenterprise#product", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product".
+ "distributionChannel": "A String", # How and to whom the package is made available.
"title": "A String", # The name of the product.
"workDetailsUrl": "A String", # A link to the Google Play for Work details page for the product, for use by an Enterprise administrator.
+ "appVersion": [ # List of app versions available for this product. The returned list contains only public versions. E.g. alpha, beta or canary versions will not be included.
+ { # App version represents a single APK version.
+ "versionCode": 42, # Unique increasing identifier for the apk version.
+ "versionString": "A String", # The string used in the Play Store by the app developer to identify a version of an app. The string is not necessarily unique or localized (e.g. "1.4").
+ },
+ ],
"iconUrl": "A String", # A link to an image that can be used as an icon for the product.
"authorName": "A String", # The name of the author of the product (e.g. the app developer).
+ "requiresContainerApp": True or False, # Whether this app can only be installed on devices using the Android for Work container app.
"detailsUrl": "A String", # A link to the (consumer) Google Play details page for the product.
"productId": "A String", # A string of the form "app:
# " - e.g. "app:com.google.android.gm" represents the GMail app.
diff --git a/docs/dyn/androidenterprise_v1.users.html b/docs/dyn/androidenterprise_v1.users.html
index 41c87b6..d99a2de 100644
--- a/docs/dyn/androidenterprise_v1.users.html
+++ b/docs/dyn/androidenterprise_v1.users.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.users.html">users</a></h1>
+<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#generateToken">generateToken(enterpriseId, userId)</a></code></p>
diff --git a/docs/dyn/androidpublisher_v2.edits.apklistings.html b/docs/dyn/androidpublisher_v2.edits.apklistings.html
index 8ecf7dd..bf11666 100644
--- a/docs/dyn/androidpublisher_v2.edits.apklistings.html
+++ b/docs/dyn/androidpublisher_v2.edits.apklistings.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.apklistings.html">apklistings</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.apklistings.html">apklistings</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(packageName, editId, apkVersionCode, language)</a></code></p>
diff --git a/docs/dyn/androidpublisher_v2.edits.apks.html b/docs/dyn/androidpublisher_v2.edits.apks.html
index 37755f7..636762a 100644
--- a/docs/dyn/androidpublisher_v2.edits.apks.html
+++ b/docs/dyn/androidpublisher_v2.edits.apks.html
@@ -72,11 +72,11 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.apks.html">apks</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.apks.html">apks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addexternallyhosted">addexternallyhosted(packageName, editId, body)</a></code></p>
-<p class="firstline">Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for work whose application is configured to restrict distribution to the enterprise domain.</p>
+<p class="firstline">Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.</p>
<p class="toc_element">
<code><a href="#list">list(packageName, editId)</a></code></p>
<p class="firstline">A description of how to use this function</p>
@@ -86,7 +86,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addexternallyhosted">addexternallyhosted(packageName, editId, body)</code>
- <pre>Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for work whose application is configured to restrict distribution to the enterprise domain.
+ <pre>Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.
Args:
packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
@@ -95,7 +95,7 @@
The object takes the form of:
{
- "externallyHostedApk": { # Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Android for Work, and whos application is restricted to the enterprise private channel # The definition of the externally-hosted APK and where it is located.
+ "externallyHostedApk": { # Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel # The definition of the externally-hosted APK and where it is located.
"iconBase64": "A String", # The icon image from the APK, as a base64 encoded byte array.
"certificateBase64s": [ # A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array.
"A String",
@@ -130,7 +130,7 @@
An object of the form:
{
- "externallyHostedApk": { # Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Android for Work, and whos application is restricted to the enterprise private channel # The definition of the externally-hosted APK and where it is located.
+ "externallyHostedApk": { # Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel # The definition of the externally-hosted APK and where it is located.
"iconBase64": "A String", # The icon image from the APK, as a base64 encoded byte array.
"certificateBase64s": [ # A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array.
"A String",
diff --git a/docs/dyn/androidpublisher_v2.edits.details.html b/docs/dyn/androidpublisher_v2.edits.details.html
index 066a107..0b4403e 100644
--- a/docs/dyn/androidpublisher_v2.edits.details.html
+++ b/docs/dyn/androidpublisher_v2.edits.details.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.details.html">details</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.details.html">details</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(packageName, editId)</a></code></p>
diff --git a/docs/dyn/androidpublisher_v2.edits.expansionfiles.html b/docs/dyn/androidpublisher_v2.edits.expansionfiles.html
index a31ddc9..117b9df 100644
--- a/docs/dyn/androidpublisher_v2.edits.expansionfiles.html
+++ b/docs/dyn/androidpublisher_v2.edits.expansionfiles.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.expansionfiles.html">expansionfiles</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.expansionfiles.html">expansionfiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(packageName, editId, apkVersionCode, expansionFileType)</a></code></p>
diff --git a/docs/dyn/androidpublisher_v2.edits.html b/docs/dyn/androidpublisher_v2.edits.html
index 686793e..204ef08 100644
--- a/docs/dyn/androidpublisher_v2.edits.html
+++ b/docs/dyn/androidpublisher_v2.edits.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="androidpublisher_v2.edits.apklistings.html">apklistings()</a></code>
diff --git a/docs/dyn/androidpublisher_v2.edits.images.html b/docs/dyn/androidpublisher_v2.edits.images.html
index d358cc1..8afbb5f 100644
--- a/docs/dyn/androidpublisher_v2.edits.images.html
+++ b/docs/dyn/androidpublisher_v2.edits.images.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.images.html">images</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.images.html">images</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(packageName, editId, language, imageType, imageId)</a></code></p>
diff --git a/docs/dyn/androidpublisher_v2.edits.listings.html b/docs/dyn/androidpublisher_v2.edits.listings.html
index 5ef4cfa..a466c89 100644
--- a/docs/dyn/androidpublisher_v2.edits.listings.html
+++ b/docs/dyn/androidpublisher_v2.edits.listings.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.listings.html">listings</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.listings.html">listings</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(packageName, editId, language)</a></code></p>
diff --git a/docs/dyn/androidpublisher_v2.edits.testers.html b/docs/dyn/androidpublisher_v2.edits.testers.html
index f49d3b3..4093904 100644
--- a/docs/dyn/androidpublisher_v2.edits.testers.html
+++ b/docs/dyn/androidpublisher_v2.edits.testers.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.testers.html">testers</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.testers.html">testers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(packageName, editId, track)</a></code></p>
diff --git a/docs/dyn/androidpublisher_v2.edits.tracks.html b/docs/dyn/androidpublisher_v2.edits.tracks.html
index ec2dd2b..4540dcd 100644
--- a/docs/dyn/androidpublisher_v2.edits.tracks.html
+++ b/docs/dyn/androidpublisher_v2.edits.tracks.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.tracks.html">tracks</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.tracks.html">tracks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(packageName, editId, track)</a></code></p>
diff --git a/docs/dyn/androidpublisher_v2.entitlements.html b/docs/dyn/androidpublisher_v2.entitlements.html
new file mode 100644
index 0000000..abb2fad
--- /dev/null
+++ b/docs/dyn/androidpublisher_v2.entitlements.html
@@ -0,0 +1,118 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.entitlements.html">entitlements</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(packageName, token=None, maxResults=None, startIndex=None, productId=None)</a></code></p>
+<p class="firstline">Lists the user's current inapp item or subscription entitlements</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(packageName, token=None, maxResults=None, startIndex=None, productId=None)</code>
+ <pre>Lists the user's current inapp item or subscription entitlements
+
+Args:
+ packageName: string, The package name of the application the inapp product was sold in (for example, 'com.some.thing'). (required)
+ token: string, A parameter
+ maxResults: integer, A parameter
+ startIndex: integer, A parameter
+ productId: string, The product id of the inapp product (for example, 'sku1'). This can be used to restrict the result set.
+
+Returns:
+ An object of the form:
+
+ {
+ "tokenPagination": {
+ "nextPageToken": "A String",
+ "previousPageToken": "A String",
+ },
+ "pageInfo": {
+ "totalResults": 42,
+ "startIndex": 42,
+ "resultPerPage": 42,
+ },
+ "resources": [
+ { # An Entitlement resource indicates a user's current entitlement to an inapp item or subscription.
+ "kind": "androidpublisher#entitlement", # This kind represents an entitlement object in the androidpublisher service.
+ "token": "A String", # The token which can be verified using the subscriptions or products API.
+ "productType": "A String", # The type of the inapp product. Possible values are:
+ # - In-app item: "inapp"
+ # - Subscription: "subs"
+ "productId": "A String", # The SKU of the product.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidpublisher_v2.html b/docs/dyn/androidpublisher_v2.html
index 6920586..6b8a165 100644
--- a/docs/dyn/androidpublisher_v2.html
+++ b/docs/dyn/androidpublisher_v2.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="androidpublisher_v2.edits.html">edits()</a></code>
@@ -80,6 +80,11 @@
<p class="firstline">Returns the edits Resource.</p>
<p class="toc_element">
+ <code><a href="androidpublisher_v2.entitlements.html">entitlements()</a></code>
+</p>
+<p class="firstline">Returns the entitlements Resource.</p>
+
+<p class="toc_element">
<code><a href="androidpublisher_v2.inappproducts.html">inappproducts()</a></code>
</p>
<p class="firstline">Returns the inappproducts Resource.</p>
@@ -89,4 +94,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_v2.inappproducts.html b/docs/dyn/androidpublisher_v2.inappproducts.html
index dba631a..0cb97aa 100644
--- a/docs/dyn/androidpublisher_v2.inappproducts.html
+++ b/docs/dyn/androidpublisher_v2.inappproducts.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.inappproducts.html">inappproducts</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.inappproducts.html">inappproducts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batch">batch(body)</a></code></p>
diff --git a/docs/dyn/androidpublisher_v2.purchases.html b/docs/dyn/androidpublisher_v2.purchases.html
index 3d452f6..9acea14 100644
--- a/docs/dyn/androidpublisher_v2.purchases.html
+++ b/docs/dyn/androidpublisher_v2.purchases.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.purchases.html">purchases</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.purchases.html">purchases</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="androidpublisher_v2.purchases.products.html">products()</a></code>
diff --git a/docs/dyn/androidpublisher_v2.purchases.products.html b/docs/dyn/androidpublisher_v2.purchases.products.html
index 214dc47..d242c36 100644
--- a/docs/dyn/androidpublisher_v2.purchases.products.html
+++ b/docs/dyn/androidpublisher_v2.purchases.products.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.purchases.html">purchases</a> . <a href="androidpublisher_v2.purchases.products.html">products</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.purchases.html">purchases</a> . <a href="androidpublisher_v2.purchases.products.html">products</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(packageName, productId, token)</a></code></p>
diff --git a/docs/dyn/androidpublisher_v2.purchases.subscriptions.html b/docs/dyn/androidpublisher_v2.purchases.subscriptions.html
index d0b12fc..f77d1ce 100644
--- a/docs/dyn/androidpublisher_v2.purchases.subscriptions.html
+++ b/docs/dyn/androidpublisher_v2.purchases.subscriptions.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.purchases.html">purchases</a> . <a href="androidpublisher_v2.purchases.subscriptions.html">subscriptions</a></h1>
+<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.purchases.html">purchases</a> . <a href="androidpublisher_v2.purchases.subscriptions.html">subscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancel">cancel(packageName, subscriptionId, token)</a></code></p>
diff --git a/docs/dyn/appsactivity_v1.html b/docs/dyn/appsactivity_v1.html
index 1c1bd8f..80e5b74 100644
--- a/docs/dyn/appsactivity_v1.html
+++ b/docs/dyn/appsactivity_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the activities 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/appstate_v1.html b/docs/dyn/appstate_v1.html
index 37445e5..1e4621f 100644
--- a/docs/dyn/appstate_v1.html
+++ b/docs/dyn/appstate_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the states 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.autoscalers.html b/docs/dyn/autoscaler_v1beta2.autoscalers.html
index 70deafc..eca7190 100644
--- a/docs/dyn/autoscaler_v1beta2.autoscalers.html
+++ b/docs/dyn/autoscaler_v1beta2.autoscalers.html
@@ -135,7 +135,7 @@
],
"user": "A String",
"startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
+ "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
"name": "A String",
"region": "A String",
"error": {
@@ -263,7 +263,7 @@
],
"user": "A String",
"startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
+ "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
"name": "A String",
"region": "A String",
"error": {
@@ -414,7 +414,7 @@
],
"user": "A String",
"startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
+ "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
"name": "A String",
"region": "A String",
"error": {
@@ -502,7 +502,7 @@
],
"user": "A String",
"startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
+ "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
"name": "A String",
"region": "A String",
"error": {
diff --git a/docs/dyn/autoscaler_v1beta2.html b/docs/dyn/autoscaler_v1beta2.html
index 67cdb1d..073c665 100644
--- a/docs/dyn/autoscaler_v1beta2.html
+++ b/docs/dyn/autoscaler_v1beta2.html
@@ -89,4 +89,25 @@
</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
index d1eb5f4..c9ccefd 100644
--- a/docs/dyn/autoscaler_v1beta2.zoneOperations.html
+++ b/docs/dyn/autoscaler_v1beta2.zoneOperations.html
@@ -137,7 +137,7 @@
],
"user": "A String",
"startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
+ "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
"name": "A String",
"region": "A String",
"error": {
@@ -199,7 +199,7 @@
],
"user": "A String",
"startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
+ "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
"name": "A String",
"region": "A String",
"error": {
@@ -216,7 +216,7 @@
"targetLink": "A String",
},
],
- "kind": "autoscaler#operationList", # Type of resource. Always compute#operations for Operations resource.
+ "kind": "autoscaler#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
"id": "A String",
"selfLink": "A String",
}</pre>
diff --git a/docs/dyn/autoscaler_v1beta2.zones.html b/docs/dyn/autoscaler_v1beta2.zones.html
index 16919ec..afef385 100644
--- a/docs/dyn/autoscaler_v1beta2.zones.html
+++ b/docs/dyn/autoscaler_v1beta2.zones.html
@@ -99,7 +99,7 @@
"items": [
{
"status": "A String",
- "kind": "autoscaler#zone", # Type of the resource.
+ "kind": "autoscaler#zone", # [Output Only] Type of the resource. Always kind#zone for zones.
"description": "A String",
"maintenanceWindows": [
{
@@ -119,7 +119,7 @@
"region": "A String",
"creationTimestamp": "A String",
"id": "A String",
- "selfLink": "A String", # Server defined URL for the resource (output only).
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
"name": "A String",
},
],
diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html
index 43732ec..32c7b97 100644
--- a/docs/dyn/bigquery_v2.datasets.html
+++ b/docs/dyn/bigquery_v2.datasets.html
@@ -85,7 +85,7 @@
<p class="firstline">Creates a new empty dataset.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, all=None, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists all the datasets in the specified project to which the caller has read access; however, a project owner can list (but not necessarily get) all datasets in his project.</p>
+<p class="firstline">Lists all datasets in the specified project to which you have been granted the READER dataset role.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -140,7 +140,9 @@
},
},
],
+ "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
+ "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -179,7 +181,9 @@
},
},
],
+ "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
+ "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -212,7 +216,9 @@
},
},
],
+ "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
+ "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -222,7 +228,7 @@
<div class="method">
<code class="details" id="list">list(projectId, all=None, pageToken=None, maxResults=None)</code>
- <pre>Lists all the datasets in the specified project to which the caller has read access; however, a project owner can list (but not necessarily get) all datasets in his project.
+ <pre>Lists all datasets in the specified project to which you have been granted the READER dataset role.
Args:
projectId: string, Project ID of the datasets to be listed (required)
@@ -297,7 +303,9 @@
},
},
],
+ "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
+ "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -330,7 +338,9 @@
},
},
],
+ "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
+ "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -370,7 +380,9 @@
},
},
],
+ "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
+ "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -403,7 +415,9 @@
},
},
],
+ "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
+ "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
diff --git a/docs/dyn/bigquery_v2.html b/docs/dyn/bigquery_v2.html
index 9a19266..1d1b35c 100644
--- a/docs/dyn/bigquery_v2.html
+++ b/docs/dyn/bigquery_v2.html
@@ -99,4 +99,25 @@
</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/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html
index f0f2fdb..fb4ba1a 100644
--- a/docs/dyn/bigquery_v2.jobs.html
+++ b/docs/dyn/bigquery_v2.jobs.html
@@ -75,17 +75,20 @@
<h1><a href="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.jobs.html">jobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#cancel">cancel(projectId, jobId)</a></code></p>
+<p class="firstline">Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully.</p>
+<p class="toc_element">
<code><a href="#get">get(projectId, jobId)</a></code></p>
-<p class="firstline">Retrieves the specified job by ID.</p>
+<p class="firstline">Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.</p>
<p class="toc_element">
<code><a href="#getQueryResults">getQueryResults(projectId, jobId, timeoutMs=None, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
<p class="firstline">Retrieves the results of a query job.</p>
<p class="toc_element">
<code><a href="#insert">insert(projectId, body=None, media_body=None)</a></code></p>
-<p class="firstline">Starts a new asynchronous job.</p>
+<p class="firstline">Starts a new asynchronous job. Requires the Can View project role.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, projection=None, stateFilter=None, pageToken=None, allUsers=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists all the Jobs in the specified project that were started by the user. The job list returns in reverse chronological order of when the jobs were created, starting with the most recent job created.</p>
+<p class="firstline">Lists all jobs that you started in the specified project. The job list returns in reverse chronological order of when the jobs were created, starting with the most recent job created. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -94,8 +97,214 @@
<p class="firstline">Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="cancel">cancel(projectId, jobId)</code>
+ <pre>Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully.
+
+Args:
+ projectId: string, Project ID of the job to cancel (required)
+ jobId: string, Job ID of the job to cancel (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "job": { # The final state of the job.
+ "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
+ "state": "A String", # [Output-only] Running state of the job.
+ "errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
+ {
+ "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
+ "message": "A String", # A human-readable description of the error.
+ "reason": "A String", # A short error code that summarizes the error.
+ "location": "A String", # Specifies where the error occurred, if present.
+ },
+ ],
+ "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
+ "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
+ "message": "A String", # A human-readable description of the error.
+ "reason": "A String", # A short error code that summarizes the error.
+ "location": "A String", # Specifies where the error occurred, if present.
+ },
+ },
+ "kind": "bigquery#job", # [Output-only] The type of the resource.
+ "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
+ "load": { # [Output-only] Statistics for a load job.
+ "outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
+ "inputFiles": "A String", # [Output-only] Number of source files in a load job.
+ "inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a joad job.
+ "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
+ },
+ "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
+ "totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
+ "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
+ "query": { # [Output-only] Statistics for a query job.
+ "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
+ "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
+ },
+ "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
+ "extract": { # [Output-only] Statistics for an extract job.
+ "destinationUriFileCounts": [ # [Experimental] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
+ "A String",
+ ],
+ },
+ },
+ "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
+ "projectId": "A String", # [Required] The ID of the project containing this job.
+ "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
+ },
+ "etag": "A String", # [Output-only] A hash of this resource.
+ "user_email": "A String", # [Output-only] Email address of the user who ran the job.
+ "configuration": { # [Required] Describes the job configuration.
+ "load": { # [Pick one] Configures a load job.
+ "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
+ "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
+ "sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
+ "destinationTable": { # [Required] The destination table to load the data into.
+ "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_APPEND. 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.
+ "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
+ "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
+ "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
+ "A String",
+ ],
+ "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
+ "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.
+ "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
+ "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
+ "allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
+ "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
+ "A String",
+ ],
+ "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
+ "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
+ "fields": [ # Describes the fields in a table.
+ {
+ "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
+ # Object with schema name: TableFieldSchema
+ ],
+ "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
+ "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
+ "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
+ },
+ ],
+ },
+ },
+ "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
+ "link": { # [Pick one] Configures a link job.
+ "createDisposition": "A String", # [Optional] 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.
+ "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 of the link job.
+ "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.
+ },
+ "sourceUri": [ # [Required] URI of source table to link.
+ "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.
+ "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
+ "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query.
+ "projectId": "A String", # [Optional] The ID of the project containing this dataset.
+ "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ },
+ "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
+ "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.
+ },
+ "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
+ "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.
+ "allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
+ "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.
+ "query": "A String", # [Required] BigQuery SQL query to execute.
+ "preserveNulls": True or False, # [Deprecated] This property is deprecated.
+ "tableDefinitions": { # [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
+ "a_key": {
+ "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE.
+ "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
+ "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
+ "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
+ "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
+ "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
+ "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
+ "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
+ },
+ "sourceFormat": "A String", # [Optional] The data format. External data sources must be in CSV format. The default value is CSV.
+ "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns
+ "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. CSV limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.
+ "A String",
+ ],
+ "schema": { # [Required] The schema for the data.
+ "fields": [ # Describes the fields in a table.
+ {
+ "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
+ # Object with schema name: TableFieldSchema
+ ],
+ "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
+ "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
+ "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
+ },
+ ],
+ },
+ },
+ },
+ },
+ "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.
+ },
+ "kind": "bigquery#jobCancelResponse", # The resource type of the response.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(projectId, jobId)</code>
- <pre>Retrieves the specified job by ID.
+ <pre>Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.
Args:
projectId: string, Project ID of the requested job (required)
@@ -160,22 +369,22 @@
"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.
- "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
- "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
+ "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_APPEND. 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.
+ "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Wildcard names are only supported when they appear at the end of the URI.
+ "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
"A String",
],
- "quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
+ "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"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.
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "projectionFields": [ # [Experimental] Names(case-sensitive) of properties to keep when importing data. If this is populated, only the specified properties will be imported for each entity. Currently, this is only supported for DATASTORE_BACKUP imports and only top level properties are supported. If any specified property is not found in the Datastore 'Kind' being imported, that is an error. Note: This feature is experimental and can change in the future.
+ "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
"A String",
],
- "ignoreUnknownValues": True or False, # [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false which treats unknown values as errors. For CSV this ignores extra values at the end of a line. For JSON this ignores named values that do not match any column name.
+ "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
"fields": [ # Describes the fields in a table.
{
@@ -204,8 +413,8 @@
],
},
"query": { # [Pick one] Configures a query job.
- "flattenResults": True or False, # [Experimental] 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.
- "useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
+ "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.
+ "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
"defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query.
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
@@ -221,6 +430,38 @@
"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.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
+ "tableDefinitions": { # [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
+ "a_key": {
+ "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE.
+ "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
+ "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
+ "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
+ "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
+ "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
+ "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
+ "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
+ },
+ "sourceFormat": "A String", # [Optional] The data format. External data sources must be in CSV format. The default value is CSV.
+ "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns
+ "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. CSV limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.
+ "A String",
+ ],
+ "schema": { # [Required] The schema for the data.
+ "fields": [ # Describes the fields in a table.
+ {
+ "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
+ # Object with schema name: TableFieldSchema
+ ],
+ "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
+ "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
+ "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
+ },
+ ],
+ },
+ },
+ },
},
"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.
@@ -248,7 +489,7 @@
"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 or False, # [Optional] Whether to print out a header row in the results. Default is true.
+ "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",
],
@@ -282,9 +523,9 @@
{
"kind": "bigquery#getQueryResultsResponse", # The resource type of the response.
"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.
- { # Represents a single row in the result set, consisting of one or more fields.
- "f": [
- { # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
+ {
+ "f": [ # Represents a single row in the result set, consisting of one or more fields.
+ {
"v": "",
},
],
@@ -318,7 +559,7 @@
<div class="method">
<code class="details" id="insert">insert(projectId, body=None, media_body=None)</code>
- <pre>Starts a new asynchronous job.
+ <pre>Starts a new asynchronous job. Requires the Can View project role.
Args:
projectId: string, Project ID of the project that will be billed for the job (required)
@@ -381,22 +622,22 @@
"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.
- "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
- "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
+ "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_APPEND. 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.
+ "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Wildcard names are only supported when they appear at the end of the URI.
+ "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
"A String",
],
- "quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
+ "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"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.
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "projectionFields": [ # [Experimental] Names(case-sensitive) of properties to keep when importing data. If this is populated, only the specified properties will be imported for each entity. Currently, this is only supported for DATASTORE_BACKUP imports and only top level properties are supported. If any specified property is not found in the Datastore 'Kind' being imported, that is an error. Note: This feature is experimental and can change in the future.
+ "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
"A String",
],
- "ignoreUnknownValues": True or False, # [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false which treats unknown values as errors. For CSV this ignores extra values at the end of a line. For JSON this ignores named values that do not match any column name.
+ "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
"fields": [ # Describes the fields in a table.
{
@@ -425,8 +666,8 @@
],
},
"query": { # [Pick one] Configures a query job.
- "flattenResults": True or False, # [Experimental] 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.
- "useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
+ "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.
+ "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
"defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query.
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
@@ -442,6 +683,38 @@
"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.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
+ "tableDefinitions": { # [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
+ "a_key": {
+ "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE.
+ "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
+ "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
+ "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
+ "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
+ "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
+ "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
+ "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
+ },
+ "sourceFormat": "A String", # [Optional] The data format. External data sources must be in CSV format. The default value is CSV.
+ "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns
+ "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. CSV limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.
+ "A String",
+ ],
+ "schema": { # [Required] The schema for the data.
+ "fields": [ # Describes the fields in a table.
+ {
+ "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
+ # Object with schema name: TableFieldSchema
+ ],
+ "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
+ "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
+ "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
+ },
+ ],
+ },
+ },
+ },
},
"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.
@@ -469,7 +742,7 @@
"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 or False, # [Optional] Whether to print out a header row in the results. Default is true.
+ "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",
],
@@ -545,22 +818,22 @@
"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.
- "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
- "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
+ "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_APPEND. 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.
+ "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Wildcard names are only supported when they appear at the end of the URI.
+ "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
"A String",
],
- "quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
+ "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"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.
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "projectionFields": [ # [Experimental] Names(case-sensitive) of properties to keep when importing data. If this is populated, only the specified properties will be imported for each entity. Currently, this is only supported for DATASTORE_BACKUP imports and only top level properties are supported. If any specified property is not found in the Datastore 'Kind' being imported, that is an error. Note: This feature is experimental and can change in the future.
+ "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
"A String",
],
- "ignoreUnknownValues": True or False, # [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false which treats unknown values as errors. For CSV this ignores extra values at the end of a line. For JSON this ignores named values that do not match any column name.
+ "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
"fields": [ # Describes the fields in a table.
{
@@ -589,8 +862,8 @@
],
},
"query": { # [Pick one] Configures a query job.
- "flattenResults": True or False, # [Experimental] 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.
- "useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
+ "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.
+ "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
"defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query.
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
@@ -606,6 +879,38 @@
"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.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
+ "tableDefinitions": { # [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
+ "a_key": {
+ "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE.
+ "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
+ "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
+ "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
+ "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
+ "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
+ "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
+ "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
+ },
+ "sourceFormat": "A String", # [Optional] The data format. External data sources must be in CSV format. The default value is CSV.
+ "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns
+ "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. CSV limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.
+ "A String",
+ ],
+ "schema": { # [Required] The schema for the data.
+ "fields": [ # Describes the fields in a table.
+ {
+ "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
+ # Object with schema name: TableFieldSchema
+ ],
+ "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
+ "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
+ "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
+ },
+ ],
+ },
+ },
+ },
},
"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.
@@ -633,7 +938,7 @@
"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 or False, # [Optional] Whether to print out a header row in the results. Default is true.
+ "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",
],
@@ -651,7 +956,7 @@
<div class="method">
<code class="details" id="list">list(projectId, projection=None, stateFilter=None, pageToken=None, allUsers=None, maxResults=None)</code>
- <pre>Lists all the Jobs in the specified project that were started by the user. The job list returns in reverse chronological order of when the jobs were created, starting with the most recent job created.
+ <pre>Lists all jobs that you started in the specified project. The job list returns in reverse chronological order of when the jobs were created, starting with the most recent job created. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.
Args:
projectId: string, Project ID of the jobs to list (required)
@@ -673,7 +978,6 @@
{
"nextPageToken": "A String", # A token to request the next page of results.
- "totalItems": 42, # Total number of jobs in this collection.
"kind": "bigquery#jobList", # The resource type of the response.
"etag": "A String", # A hash of this page of results.
"jobs": [ # List of jobs that were requested.
@@ -733,22 +1037,22 @@
"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.
- "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
- "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
+ "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_APPEND. 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.
+ "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Wildcard names are only supported when they appear at the end of the URI.
+ "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
"A String",
],
- "quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
+ "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"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.
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "projectionFields": [ # [Experimental] Names(case-sensitive) of properties to keep when importing data. If this is populated, only the specified properties will be imported for each entity. Currently, this is only supported for DATASTORE_BACKUP imports and only top level properties are supported. If any specified property is not found in the Datastore 'Kind' being imported, that is an error. Note: This feature is experimental and can change in the future.
+ "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
"A String",
],
- "ignoreUnknownValues": True or False, # [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false which treats unknown values as errors. For CSV this ignores extra values at the end of a line. For JSON this ignores named values that do not match any column name.
+ "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
"fields": [ # Describes the fields in a table.
{
@@ -777,8 +1081,8 @@
],
},
"query": { # [Pick one] Configures a query job.
- "flattenResults": True or False, # [Experimental] 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.
- "useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
+ "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.
+ "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
"defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query.
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
@@ -794,6 +1098,38 @@
"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.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
+ "tableDefinitions": { # [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
+ "a_key": {
+ "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE.
+ "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
+ "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
+ "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
+ "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
+ "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
+ "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
+ "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
+ },
+ "sourceFormat": "A String", # [Optional] The data format. External data sources must be in CSV format. The default value is CSV.
+ "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns
+ "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. CSV limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.
+ "A String",
+ ],
+ "schema": { # [Required] The schema for the data.
+ "fields": [ # Describes the fields in a table.
+ {
+ "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
+ # Object with schema name: TableFieldSchema
+ ],
+ "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
+ "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
+ "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
+ },
+ ],
+ },
+ },
+ },
},
"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.
@@ -821,7 +1157,7 @@
"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 or False, # [Optional] Whether to print out a header row in the results. Default is true.
+ "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",
],
@@ -871,7 +1207,7 @@
"timeoutMs": 42, # [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).
"kind": "bigquery#queryRequest", # The resource type of the request.
"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.
- "useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.
+ "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.
"defaultDataset": { # [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'.
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
@@ -888,9 +1224,9 @@
{
"kind": "bigquery#queryResponse", # The resource type.
"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.
- { # Represents a single row in the result set, consisting of one or more fields.
- "f": [
- { # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
+ {
+ "f": [ # Represents a single row in the result set, consisting of one or more fields.
+ {
"v": "",
},
],
diff --git a/docs/dyn/bigquery_v2.projects.html b/docs/dyn/bigquery_v2.projects.html
index df10a23..d829b72 100644
--- a/docs/dyn/bigquery_v2.projects.html
+++ b/docs/dyn/bigquery_v2.projects.html
@@ -76,14 +76,14 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists the projects to which you have at least read access.</p>
+<p class="firstline">Lists all projects to which you have been granted any project role.</p>
<p class="toc_element">
<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>Lists the projects to which you have at least read access.
+ <pre>Lists all projects to which you have been granted any project role.
Args:
pageToken: string, Page token, returned by a previous call, to request the next page of results
diff --git a/docs/dyn/bigquery_v2.tabledata.html b/docs/dyn/bigquery_v2.tabledata.html
index 2b5978b..5592d2c 100644
--- a/docs/dyn/bigquery_v2.tabledata.html
+++ b/docs/dyn/bigquery_v2.tabledata.html
@@ -76,14 +76,14 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#insertAll">insertAll(projectId, datasetId, tableId, body)</a></code></p>
-<p class="firstline">Streams data into BigQuery one record at a time without needing to run a load job.</p>
+<p class="firstline">Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
-<p class="firstline">Retrieves table data from a specified set of rows.</p>
+<p class="firstline">Retrieves table data from a specified set of rows. Requires the READER dataset role.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="insertAll">insertAll(projectId, datasetId, tableId, body)</code>
- <pre>Streams data into BigQuery one record at a time without needing to run a load job.
+ <pre>Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.
Args:
projectId: string, Project ID of the destination table. (required)
@@ -93,6 +93,7 @@
The object takes the form of:
{
+ "ignoreUnknownValues": True or False, # [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
"kind": "bigquery#tableDataInsertAllRequest", # The resource type of the response.
"rows": [ # The rows to insert.
{
@@ -102,6 +103,7 @@
},
},
],
+ "skipInvalidRows": True or False, # [Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
}
@@ -128,7 +130,7 @@
<div class="method">
<code class="details" id="list">list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)</code>
- <pre>Retrieves table data from a specified set of rows.
+ <pre>Retrieves table data from a specified set of rows. Requires the READER dataset role.
Args:
projectId: string, Project ID of the table to read (required)
@@ -146,9 +148,9 @@
"kind": "bigquery#tableDataList", # The resource type of the response.
"etag": "A String", # A hash of this page of results.
"rows": [ # Rows of results.
- { # Represents a single row in the result set, consisting of one or more fields.
- "f": [
- { # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
+ {
+ "f": [ # Represents a single row in the result set, consisting of one or more fields.
+ {
"v": "",
},
],
diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html
index b0bb807..fec1c63 100644
--- a/docs/dyn/bigquery_v2.tables.html
+++ b/docs/dyn/bigquery_v2.tables.html
@@ -85,7 +85,7 @@
<p class="firstline">Creates a new, empty table in the dataset.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, datasetId, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists all tables in the specified dataset.</p>
+<p class="firstline">Lists all tables in the specified dataset. Requires the READER dataset role.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -245,7 +245,7 @@
<div class="method">
<code class="details" id="list">list(projectId, datasetId, pageToken=None, maxResults=None)</code>
- <pre>Lists all tables in the specified dataset.
+ <pre>Lists all tables in the specified dataset. Requires the READER dataset role.
Args:
projectId: string, Project ID of the tables to list (required)
diff --git a/docs/dyn/blogger_v3.comments.html b/docs/dyn/blogger_v3.comments.html
index 604e3fb..2461f7c 100644
--- a/docs/dyn/blogger_v3.comments.html
+++ b/docs/dyn/blogger_v3.comments.html
@@ -256,6 +256,7 @@
},
],
"kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
+ "etag": "A String", # Etag of the response.
"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
}</pre>
</div>
@@ -312,6 +313,7 @@
},
],
"kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
+ "etag": "A String", # Etag of the response.
"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
}</pre>
</div>
diff --git a/docs/dyn/blogger_v3.html b/docs/dyn/blogger_v3.html
index 2715ffa..3a5c64b 100644
--- a/docs/dyn/blogger_v3.html
+++ b/docs/dyn/blogger_v3.html
@@ -114,4 +114,25 @@
</p>
<p class="firstline">Returns the users 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/blogger_v3.pages.html b/docs/dyn/blogger_v3.pages.html
index f8560b3..113e478 100644
--- a/docs/dyn/blogger_v3.pages.html
+++ b/docs/dyn/blogger_v3.pages.html
@@ -266,6 +266,7 @@
},
],
"kind": "blogger#pageList", # The kind of this entity. Always blogger#pageList
+ "etag": "A String", # Etag of the response.
}</pre>
</div>
diff --git a/docs/dyn/blogger_v3.posts.html b/docs/dyn/blogger_v3.posts.html
index 33fed03..300f88d 100644
--- a/docs/dyn/blogger_v3.posts.html
+++ b/docs/dyn/blogger_v3.posts.html
@@ -573,6 +573,7 @@
},
],
"kind": "blogger#postList", # The kind of this entity. Always blogger#postList
+ "etag": "A String", # Etag of the response.
}</pre>
</div>
@@ -1020,6 +1021,7 @@
},
],
"kind": "blogger#postList", # The kind of this entity. Always blogger#postList
+ "etag": "A String", # Etag of the response.
}</pre>
</div>
diff --git a/docs/dyn/books_v1.bookshelves.volumes.html b/docs/dyn/books_v1.bookshelves.volumes.html
index 4c0fc8d..992a9a3 100644
--- a/docs/dyn/books_v1.bookshelves.volumes.html
+++ b/docs/dyn/books_v1.bookshelves.volumes.html
@@ -209,9 +209,11 @@
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"readingModes": "", # The reading modes available for this volume.
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"title": "A String", # Volume title. (In LITE projection.)
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "maturityRating": "A String",
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
diff --git a/docs/dyn/books_v1.html b/docs/dyn/books_v1.html
index 7c91514..64ab14b 100644
--- a/docs/dyn/books_v1.html
+++ b/docs/dyn/books_v1.html
@@ -119,4 +119,25 @@
</p>
<p class="firstline">Returns the volumes 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/books_v1.myconfig.html b/docs/dyn/books_v1.myconfig.html
index 1f8a702..5470202 100644
--- a/docs/dyn/books_v1.myconfig.html
+++ b/docs/dyn/books_v1.myconfig.html
@@ -88,7 +88,7 @@
<p class="firstline">Request downloaded content access for specified volumes on the My eBooks shelf.</p>
<p class="toc_element">
<code><a href="#updateUserSettings">updateUserSettings(body)</a></code></p>
-<p class="firstline">Sets the settings for the user. Unspecified sub-objects will retain the existing value.</p>
+<p class="firstline">Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="getUserSettings">getUserSettings()</code>
@@ -327,9 +327,11 @@
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"readingModes": "", # The reading modes available for this volume.
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"title": "A String", # Volume title. (In LITE projection.)
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "maturityRating": "A String",
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
@@ -403,7 +405,7 @@
<div class="method">
<code class="details" id="updateUserSettings">updateUserSettings(body)</code>
- <pre>Sets the settings for the user. Unspecified sub-objects will retain the existing value.
+ <pre>Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.
Args:
body: object, The request body. (required)
diff --git a/docs/dyn/books_v1.mylibrary.annotations.html b/docs/dyn/books_v1.mylibrary.annotations.html
index 3dd48df..f1e9719 100644
--- a/docs/dyn/books_v1.mylibrary.annotations.html
+++ b/docs/dyn/books_v1.mylibrary.annotations.html
@@ -78,13 +78,10 @@
<code><a href="#delete">delete(annotationId, source=None)</a></code></p>
<p class="firstline">Deletes an annotation.</p>
<p class="toc_element">
- <code><a href="#get">get(annotationId, source=None)</a></code></p>
-<p class="firstline">Gets an annotation by its ID.</p>
-<p class="toc_element">
<code><a href="#insert">insert(body, source=None, country=None, showOnlySummaryInResponse=None)</a></code></p>
<p class="firstline">Inserts a new annotation.</p>
<p class="toc_element">
- <code><a href="#list">list(pageToken=None, updatedMin=None, showDeleted=None, pageIds=None, contentVersion=None, layerId=None, updatedMax=None, volumeId=None, maxResults=None, layerIds=None, source=None)</a></code></p>
+ <code><a href="#list">list(layerId=None, pageToken=None, layerIds=None, volumeId=None, maxResults=None, showDeleted=None, updatedMax=None, contentVersion=None, source=None, updatedMin=None)</a></code></p>
<p class="firstline">Retrieves a list of annotations, possibly filtered.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -107,96 +104,6 @@
</div>
<div class="method">
- <code class="details" id="get">get(annotationId, source=None)</code>
- <pre>Gets an annotation by its ID.
-
-Args:
- annotationId: string, The ID for the annotation to retrieve. (required)
- source: string, String to identify the originator of this request.
-
-Returns:
- An object of the form:
-
- {
- "kind": "books#annotation", # Resource type.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "created": "A String", # Timestamp for the created time of this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "contentVersion": "A String", # Content version applicable to ranges below.
- "gbTextRange": { # Range in GB text format for this annotation for version above.
- "startPosition": "A String", # The starting position for the range.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "endOffset": "A String", # The offset from the ending position.
- },
- "cfiRange": { # Range in CFI format for this annotation for version above.
- "startPosition": "A String", # The starting position for the range.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "endOffset": "A String", # The offset from the ending position.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation for version above.
- "startPosition": "A String", # The starting position for the range.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "endOffset": "A String", # The offset from the ending position.
- },
- "gbImageRange": { # Range in GB image format for this annotation for version above.
- "startPosition": "A String", # The starting position for the range.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "endOffset": "A String", # The offset from the ending position.
- },
- },
- "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "contentVersion": "A String", # Content version the client sent in.
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "startPosition": "A String", # The starting position for the range.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "endOffset": "A String", # The offset from the ending position.
- },
- "cfiRange": { # Range in CFI format for this annotation sent by client.
- "startPosition": "A String", # The starting position for the range.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "endOffset": "A String", # The offset from the ending position.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "startPosition": "A String", # The starting position for the range.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "endOffset": "A String", # The offset from the ending position.
- },
- "gbImageRange": { # Range in GB image format for this annotation sent by client.
- "startPosition": "A String", # The starting position for the range.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "endOffset": "A String", # The offset from the ending position.
- },
- },
- "layerSummary": {
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- },
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
- }</pre>
-</div>
-
-<div class="method">
<code class="details" id="insert">insert(body, source=None, country=None, showOnlySummaryInResponse=None)</code>
<pre>Inserts a new annotation.
@@ -369,21 +276,20 @@
</div>
<div class="method">
- <code class="details" id="list">list(pageToken=None, updatedMin=None, showDeleted=None, pageIds=None, contentVersion=None, layerId=None, updatedMax=None, volumeId=None, maxResults=None, layerIds=None, source=None)</code>
+ <code class="details" id="list">list(layerId=None, pageToken=None, layerIds=None, volumeId=None, maxResults=None, showDeleted=None, updatedMax=None, contentVersion=None, source=None, updatedMin=None)</code>
<pre>Retrieves a list of annotations, possibly filtered.
Args:
- pageToken: string, The value of the nextToken from the previous page.
- updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
- showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
- pageIds: string, The page ID(s) for the volume that is being queried. (repeated)
- contentVersion: string, The content version for the requested volume.
layerId: string, The layer ID to limit annotation by.
- updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
+ pageToken: string, The value of the nextToken from the previous page.
+ layerIds: string, The layer ID(s) to limit annotation by. (repeated)
volumeId: string, The volume to restrict annotations to.
maxResults: integer, Maximum number of results to return
- layerIds: string, The layer ID(s) to limit annotation by. (repeated)
+ showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
+ updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
+ contentVersion: string, The content version for the requested volume.
source: string, String to identify the originator of this request.
+ updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
Returns:
An object of the form:
diff --git a/docs/dyn/books_v1.mylibrary.bookshelves.volumes.html b/docs/dyn/books_v1.mylibrary.bookshelves.volumes.html
index f9ed3b8..dcd691d 100644
--- a/docs/dyn/books_v1.mylibrary.bookshelves.volumes.html
+++ b/docs/dyn/books_v1.mylibrary.bookshelves.volumes.html
@@ -214,9 +214,11 @@
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"readingModes": "", # The reading modes available for this volume.
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"title": "A String", # Volume title. (In LITE projection.)
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "maturityRating": "A String",
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
diff --git a/docs/dyn/books_v1.onboarding.html b/docs/dyn/books_v1.onboarding.html
index edcb037..6279bf9 100644
--- a/docs/dyn/books_v1.onboarding.html
+++ b/docs/dyn/books_v1.onboarding.html
@@ -78,7 +78,7 @@
<code><a href="#listCategories">listCategories(locale=None)</a></code></p>
<p class="firstline">List categories for onboarding experience.</p>
<p class="toc_element">
- <code><a href="#listCategoryVolumes">listCategoryVolumes(pageSize=None, pageToken=None, locale=None, categoryId=None)</a></code></p>
+ <code><a href="#listCategoryVolumes">listCategoryVolumes(pageSize=None, pageToken=None, locale=None, maxAllowedMaturityRating=None, categoryId=None)</a></code></p>
<p class="firstline">List available volumes under categories for onboarding experience.</p>
<p class="toc_element">
<code><a href="#listCategoryVolumes_next">listCategoryVolumes_next(previous_request, previous_response)</a></code></p>
@@ -107,13 +107,17 @@
</div>
<div class="method">
- <code class="details" id="listCategoryVolumes">listCategoryVolumes(pageSize=None, pageToken=None, locale=None, categoryId=None)</code>
+ <code class="details" id="listCategoryVolumes">listCategoryVolumes(pageSize=None, pageToken=None, locale=None, maxAllowedMaturityRating=None, categoryId=None)</code>
<pre>List available volumes under categories for onboarding experience.
Args:
pageSize: integer, Number of maximum results per page to be included in the response.
pageToken: string, The value of the nextToken from the previous page.
locale: string, ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
+ maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.
+ Allowed values
+ mature - Show books which are rated mature or lower.
+ not-mature - Show books which are rated not mature.
categoryId: string, List of category ids requested. (repeated)
Returns:
@@ -235,9 +239,11 @@
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"readingModes": "", # The reading modes available for this volume.
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"title": "A String", # Volume title. (In LITE projection.)
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "maturityRating": "A String",
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
diff --git a/docs/dyn/books_v1.volumes.associated.html b/docs/dyn/books_v1.volumes.associated.html
index 5f7dcf3..77c51d9 100644
--- a/docs/dyn/books_v1.volumes.associated.html
+++ b/docs/dyn/books_v1.volumes.associated.html
@@ -75,17 +75,21 @@
<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.volumes.html">volumes</a> . <a href="books_v1.volumes.associated.html">associated</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(volumeId, source=None, locale=None, association=None)</a></code></p>
+ <code><a href="#list">list(volumeId, source=None, locale=None, maxAllowedMaturityRating=None, association=None)</a></code></p>
<p class="firstline">Return a list of associated books.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(volumeId, source=None, locale=None, association=None)</code>
+ <code class="details" id="list">list(volumeId, source=None, locale=None, maxAllowedMaturityRating=None, association=None)</code>
<pre>Return a list of associated books.
Args:
volumeId: string, ID of the source volume. (required)
source: string, String to identify the originator of this request.
locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
+ maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
+ Allowed values
+ mature - Show books which are rated mature or lower.
+ not-mature - Show books which are rated not mature.
association: string, Association type.
Allowed values
end-of-sample - Recommendations for display end-of-sample.
@@ -211,9 +215,11 @@
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"readingModes": "", # The reading modes available for this volume.
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"title": "A String", # Volume title. (In LITE projection.)
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "maturityRating": "A String",
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
diff --git a/docs/dyn/books_v1.volumes.html b/docs/dyn/books_v1.volumes.html
index b84632d..962614d 100644
--- a/docs/dyn/books_v1.volumes.html
+++ b/docs/dyn/books_v1.volumes.html
@@ -232,9 +232,11 @@
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"readingModes": "", # The reading modes available for this volume.
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"title": "A String", # Volume title. (In LITE projection.)
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "maturityRating": "A String",
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
@@ -462,9 +464,11 @@
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"readingModes": "", # The reading modes available for this volume.
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"title": "A String", # Volume title. (In LITE projection.)
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "maturityRating": "A String",
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
diff --git a/docs/dyn/books_v1.volumes.mybooks.html b/docs/dyn/books_v1.volumes.mybooks.html
index 66fdb3f..8aa620d 100644
--- a/docs/dyn/books_v1.volumes.mybooks.html
+++ b/docs/dyn/books_v1.volumes.mybooks.html
@@ -221,9 +221,11 @@
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"readingModes": "", # The reading modes available for this volume.
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"title": "A String", # Volume title. (In LITE projection.)
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "maturityRating": "A String",
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
diff --git a/docs/dyn/books_v1.volumes.recommended.html b/docs/dyn/books_v1.volumes.recommended.html
index fc35422..30496d3 100644
--- a/docs/dyn/books_v1.volumes.recommended.html
+++ b/docs/dyn/books_v1.volumes.recommended.html
@@ -75,19 +75,23 @@
<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.volumes.html">volumes</a> . <a href="books_v1.volumes.recommended.html">recommended</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(source=None, locale=None)</a></code></p>
+ <code><a href="#list">list(source=None, locale=None, maxAllowedMaturityRating=None)</a></code></p>
<p class="firstline">Return a list of recommended books for the current user.</p>
<p class="toc_element">
<code><a href="#rate">rate(rating, volumeId, source=None, locale=None)</a></code></p>
<p class="firstline">Rate a recommended book for the current user.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(source=None, locale=None)</code>
+ <code class="details" id="list">list(source=None, locale=None, maxAllowedMaturityRating=None)</code>
<pre>Return a list of recommended books for the current user.
Args:
source: string, String to identify the originator of this request.
locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
+ maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
+ Allowed values
+ mature - Show books which are rated mature or lower.
+ not-mature - Show books which are rated not mature.
Returns:
An object of the form:
@@ -208,9 +212,11 @@
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"readingModes": "", # The reading modes available for this volume.
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"title": "A String", # Volume title. (In LITE projection.)
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "maturityRating": "A String",
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
diff --git a/docs/dyn/books_v1.volumes.useruploaded.html b/docs/dyn/books_v1.volumes.useruploaded.html
index 7b2a515..53e5c7f 100644
--- a/docs/dyn/books_v1.volumes.useruploaded.html
+++ b/docs/dyn/books_v1.volumes.useruploaded.html
@@ -213,9 +213,11 @@
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"readingModes": "", # The reading modes available for this volume.
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"title": "A String", # Volume title. (In LITE projection.)
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "maturityRating": "A String",
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
diff --git a/docs/dyn/calendar_v3.calendarList.html b/docs/dyn/calendar_v3.calendarList.html
index 756db1e..c3f229f 100644
--- a/docs/dyn/calendar_v3.calendarList.html
+++ b/docs/dyn/calendar_v3.calendarList.html
@@ -284,7 +284,7 @@
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
- minAccessRole: string, The minimum access role for the user in the returned entires. Optional. The default is no restriction.
+ minAccessRole: string, The minimum access role for the user in the returned entries. Optional. The default is no restriction.
Allowed values
freeBusyReader - The user can read free/busy information.
owner - The user can read and modify events and access control lists.
@@ -614,7 +614,7 @@
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
- minAccessRole: string, The minimum access role for the user in the returned entires. Optional. The default is no restriction.
+ minAccessRole: string, The minimum access role for the user in the returned entries. Optional. The default is no restriction.
Allowed values
freeBusyReader - The user can read free/busy information.
owner - The user can read and modify events and access control lists.
diff --git a/docs/dyn/calendar_v3.calendars.html b/docs/dyn/calendar_v3.calendars.html
index b0ef92d..5a967eb 100644
--- a/docs/dyn/calendar_v3.calendars.html
+++ b/docs/dyn/calendar_v3.calendars.html
@@ -76,10 +76,10 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#clear">clear(calendarId)</a></code></p>
-<p class="firstline">Clears a primary calendar. This operation deletes all data associated with the primary calendar of an account and cannot be undone.</p>
+<p class="firstline">Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.</p>
<p class="toc_element">
<code><a href="#delete">delete(calendarId)</a></code></p>
-<p class="firstline">Deletes a secondary calendar.</p>
+<p class="firstline">Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.</p>
<p class="toc_element">
<code><a href="#get">get(calendarId)</a></code></p>
<p class="firstline">Returns metadata for a calendar.</p>
@@ -95,7 +95,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="clear">clear(calendarId)</code>
- <pre>Clears a primary calendar. This operation deletes all data associated with the primary calendar of an account and cannot be undone.
+ <pre>Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
Args:
calendarId: string, Calendar identifier. (required)
@@ -104,7 +104,7 @@
<div class="method">
<code class="details" id="delete">delete(calendarId)</code>
- <pre>Deletes a secondary calendar.
+ <pre>Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
Args:
calendarId: string, Calendar identifier. (required)
diff --git a/docs/dyn/calendar_v3.html b/docs/dyn/calendar_v3.html
index 1681f9d..43695a1 100644
--- a/docs/dyn/calendar_v3.html
+++ b/docs/dyn/calendar_v3.html
@@ -114,4 +114,25 @@
</p>
<p class="firstline">Returns the settings 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/civicinfo_v2.html b/docs/dyn/civicinfo_v2.html
index 177c087..bd6aa30 100644
--- a/docs/dyn/civicinfo_v2.html
+++ b/docs/dyn/civicinfo_v2.html
@@ -89,4 +89,25 @@
</p>
<p class="firstline">Returns the representatives 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.html b/docs/dyn/cloudlatencytest_v2.html
index d13e93c..486631c 100644
--- a/docs/dyn/cloudlatencytest_v2.html
+++ b/docs/dyn/cloudlatencytest_v2.html
@@ -79,4 +79,25 @@
</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/cloudmonitoring_v2beta2.html b/docs/dyn/cloudmonitoring_v2beta2.html
index ae338ed..cff13dd 100644
--- a/docs/dyn/cloudmonitoring_v2beta2.html
+++ b/docs/dyn/cloudmonitoring_v2beta2.html
@@ -89,4 +89,25 @@
</p>
<p class="firstline">Returns the timeseriesDescriptors 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/cloudmonitoring_v2beta2.metricDescriptors.html b/docs/dyn/cloudmonitoring_v2beta2.metricDescriptors.html
index e1398d0..3854d76 100644
--- a/docs/dyn/cloudmonitoring_v2beta2.metricDescriptors.html
+++ b/docs/dyn/cloudmonitoring_v2beta2.metricDescriptors.html
@@ -105,8 +105,8 @@
},
],
"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.
+ "valueType": "A String", # The data type of of individual points in the metric's time series. See Metric value types.
+ "metricType": "A String", # The method of collecting data for the metric. See Metric types.
},
"description": "A String", # Description of this metric.
"name": "A String", # The name of this metric.
@@ -125,8 +125,8 @@
},
],
"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.
+ "valueType": "A String", # The data type of of individual points in the metric's time series. See Metric value types.
+ "metricType": "A String", # The method of collecting data for the metric. See Metric types.
},
"description": "A String", # Description of this metric.
"name": "A String", # The name of this metric.
@@ -173,8 +173,8 @@
},
],
"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.
+ "valueType": "A String", # The data type of of individual points in the metric's time series. See Metric value types.
+ "metricType": "A String", # The method of collecting data for the metric. See Metric types.
},
"description": "A String", # Description of this metric.
"name": "A String", # The name of this metric.
diff --git a/docs/dyn/cloudmonitoring_v2beta2.timeseries.html b/docs/dyn/cloudmonitoring_v2beta2.timeseries.html
index 7b2730f..001e0f9 100644
--- a/docs/dyn/cloudmonitoring_v2beta2.timeseries.html
+++ b/docs/dyn/cloudmonitoring_v2beta2.timeseries.html
@@ -101,7 +101,7 @@
- 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].
- aggregator: string, The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metric types.
+ aggregator: string, The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.
Allowed values
max -
mean -
diff --git a/docs/dyn/cloudmonitoring_v2beta2.timeseriesDescriptors.html b/docs/dyn/cloudmonitoring_v2beta2.timeseriesDescriptors.html
index 280ecae..14403ca 100644
--- a/docs/dyn/cloudmonitoring_v2beta2.timeseriesDescriptors.html
+++ b/docs/dyn/cloudmonitoring_v2beta2.timeseriesDescriptors.html
@@ -98,7 +98,7 @@
- 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].
- aggregator: string, The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metric types.
+ aggregator: string, The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.
Allowed values
max -
mean -
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.html b/docs/dyn/cloudresourcemanager_v1beta1.html
new file mode 100644
index 0000000..ca3609f
--- /dev/null
+++ b/docs/dyn/cloudresourcemanager_v1beta1.html
@@ -0,0 +1,103 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="cloudresourcemanager_v1beta1.html">Google Cloud Resource Manager API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="cloudresourcemanager_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/cloudresourcemanager_v1beta1.projects.html b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
new file mode 100644
index 0000000..c5166c6
--- /dev/null
+++ b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
@@ -0,0 +1,269 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<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>
+<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 it has a lifecycle state of [ACTIVE][cloudresourcemanager.projects.v1beta2.LifecycleState.ACTIVE] when this method is called. Otherwise this method does nothing (since all other states are phases of deletion). This method changes the project's lifecycle state from [ACTIVE][cloudresourcemanager.projects.v1beta2.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [cloudresourcemanager.projects.v1beta2.Projects.GetProject], and the project remains visible to [ListProjects] [cloudresourcemanager.projects.v1beta2.Projects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [cloudresourcemanager.projects.v1beta2.Projects.GetProject] and [ListProjects] [cloudresourcemanager.projects.v1beta2.Projects.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="#list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.</p>
+<p class="toc_element">
+ <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="#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] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_IN_PROGRESS], 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>
+ <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:
+ body: object, The request body. (required)
+ 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. Projects are subordinate to Customers.
+ "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
+ "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.
+ "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
+ "a_key": "A String",
+ },
+ "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
+ "lifecycleState": "A String", # The project lifecycle state. Read-only.
+ "createTime": "A String", # Creation time. Read-only.
+}
+
+ 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. Projects are subordinate to Customers.
+ "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
+ "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.
+ "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
+ "a_key": "A String",
+ },
+ "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
+ "lifecycleState": "A String", # The project lifecycle state. Read-only.
+ "createTime": "A String", # Creation time. Read-only.
+ }</pre>
+</div>
+
+<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 it has a lifecycle state of [ACTIVE][cloudresourcemanager.projects.v1beta2.LifecycleState.ACTIVE] when this method is called. Otherwise this method does nothing (since all other states are phases of deletion). This method changes the project's lifecycle state from [ACTIVE][cloudresourcemanager.projects.v1beta2.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [cloudresourcemanager.projects.v1beta2.Projects.GetProject], and the project remains visible to [ListProjects] [cloudresourcemanager.projects.v1beta2.Projects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [cloudresourcemanager.projects.v1beta2.Projects.GetProject] and [ListProjects] [cloudresourcemanager.projects.v1beta2.Projects.ListProjects] methods. The caller must have modify permissions for this project.
+
+Args:
+ projectId: string, The project ID (for example, `foo-bar-123`). Required. (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); }
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(projectId, x__xgafv=None)</code>
+ <pre>Retrieves 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)
+ 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. Projects are subordinate to Customers.
+ "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
+ "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.
+ "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
+ "a_key": "A String",
+ },
+ "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
+ "lifecycleState": "A String", # The project lifecycle state. Read-only.
+ "createTime": "A String", # Creation time. Read-only.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.
+
+Args:
+ pageSize: integer, The maximum number of Projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default. Note: pagination is not yet supported; the server ignores this field. Optional.
+ filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: name id labels. where is a the name of a label Examples: name:* ==> The project has a name. name:Howl ==> The project’s name is `Howl` or 'howl'. name:HOWL ==> Equivalent to above. NAME:howl ==> Equivalent to above. labels.color:* ==> The project has the label "color". labels.color:red ==> The project’s label `color` has the value `red`. labels.color:red label.size:big ==> The project's label `color` has the value `red` and its label `size` has the value `big`. Optional.
+ pageToken: string, A pagination token returned from a previous call to ListProject that indicates from where listing should continue. Note: pagination is not yet supported; the server ignores this field. Optional.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A page of the response received from the [ListProjects][cloudresourcemanager.projects.v1beta1.Projects.ListProjects] method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
+ "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. Note: pagination is not yet supported; the server will not set this field.
+ "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. Projects are subordinate to Customers.
+ "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
+ "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.
+ "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
+ "a_key": "A String",
+ },
+ "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
+ "lifecycleState": "A String", # The project lifecycle state. Read-only.
+ "createTime": "A String", # Creation time. 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="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] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_IN_PROGRESS], 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)
+ 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); }
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(projectId, body, x__xgafv=None)</code>
+ <pre>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.
+
+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:
+
+{ # 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. Projects are subordinate to Customers.
+ "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
+ "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.
+ "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
+ "a_key": "A String",
+ },
+ "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
+ "lifecycleState": "A String", # The project lifecycle state. Read-only.
+ "createTime": "A String", # Creation time. Read-only.
+}
+
+ 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. Projects are subordinate to Customers.
+ "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
+ "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.
+ "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
+ "a_key": "A String",
+ },
+ "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
+ "lifecycleState": "A String", # The project lifecycle state. Read-only.
+ "createTime": "A String", # Creation time. Read-only.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_v1.addresses.html b/docs/dyn/compute_v1.addresses.html
index 7be781c..fbfa3be 100644
--- a/docs/dyn/compute_v1.addresses.html
+++ b/docs/dyn/compute_v1.addresses.html
@@ -102,9 +102,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -175,13 +175,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -277,13 +277,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -327,9 +327,9 @@
Args:
project: string, Project ID for this request. (required)
region: string, The name of the region for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html
index 6423376..0e83754 100644
--- a/docs/dyn/compute_v1.backendServices.html
+++ b/docs/dyn/compute_v1.backendServices.html
@@ -112,13 +112,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -167,6 +167,12 @@
An object of the form:
{ # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
+ #
+ # If you add field foo, you probably need to also add: com.google.cloud.cluster.manager.api.BackendServiceResource: foo com.google.cloud.cluster.manager.networking.entities: BackendService, BackendServiceEntity: getFoo, setFoo:
+ #
+ # Converters/mappers will need to be updated: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverter: toResource, updateEntity: copy foo com.google.cloud.cluster.mixer.protomappers.BackendServiceMappers.ResourceMapper: ResourceMapper: add a new map call
+ #
+ # Tests to update: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverterTest com.google.cloud.cluster.mixer.protomappers.BackendServiceMappersTest.testResourceMapping
"kind": "compute#backendService", # Type of the resource.
"protocol": "A String",
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
@@ -178,7 +184,7 @@
"description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created.
"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, 1].
"maxRatePerInstance": 3.14, # The max RPS that a single backed 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.
- "capacityScaler": 3.14, # The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6].
+ "capacityScaler": 3.14, # The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].
"maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
"balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION.
},
@@ -236,6 +242,12 @@
The object takes the form of:
{ # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
+ #
+ # If you add field foo, you probably need to also add: com.google.cloud.cluster.manager.api.BackendServiceResource: foo com.google.cloud.cluster.manager.networking.entities: BackendService, BackendServiceEntity: getFoo, setFoo:
+ #
+ # Converters/mappers will need to be updated: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverter: toResource, updateEntity: copy foo com.google.cloud.cluster.mixer.protomappers.BackendServiceMappers.ResourceMapper: ResourceMapper: add a new map call
+ #
+ # Tests to update: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverterTest com.google.cloud.cluster.mixer.protomappers.BackendServiceMappersTest.testResourceMapping
"kind": "compute#backendService", # Type of the resource.
"protocol": "A String",
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
@@ -247,7 +259,7 @@
"description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created.
"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, 1].
"maxRatePerInstance": 3.14, # The max RPS that a single backed 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.
- "capacityScaler": 3.14, # The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6].
+ "capacityScaler": 3.14, # The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].
"maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
"balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION.
},
@@ -269,13 +281,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -318,9 +330,9 @@
Args:
project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -329,6 +341,12 @@
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # A list of BackendService resources.
{ # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
+ #
+ # If you add field foo, you probably need to also add: com.google.cloud.cluster.manager.api.BackendServiceResource: foo com.google.cloud.cluster.manager.networking.entities: BackendService, BackendServiceEntity: getFoo, setFoo:
+ #
+ # Converters/mappers will need to be updated: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverter: toResource, updateEntity: copy foo com.google.cloud.cluster.mixer.protomappers.BackendServiceMappers.ResourceMapper: ResourceMapper: add a new map call
+ #
+ # Tests to update: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverterTest com.google.cloud.cluster.mixer.protomappers.BackendServiceMappersTest.testResourceMapping
"kind": "compute#backendService", # Type of the resource.
"protocol": "A String",
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
@@ -340,7 +358,7 @@
"description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created.
"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, 1].
"maxRatePerInstance": 3.14, # The max RPS that a single backed 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.
- "capacityScaler": 3.14, # The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6].
+ "capacityScaler": 3.14, # The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].
"maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
"balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION.
},
@@ -387,6 +405,12 @@
The object takes the form of:
{ # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
+ #
+ # If you add field foo, you probably need to also add: com.google.cloud.cluster.manager.api.BackendServiceResource: foo com.google.cloud.cluster.manager.networking.entities: BackendService, BackendServiceEntity: getFoo, setFoo:
+ #
+ # Converters/mappers will need to be updated: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverter: toResource, updateEntity: copy foo com.google.cloud.cluster.mixer.protomappers.BackendServiceMappers.ResourceMapper: ResourceMapper: add a new map call
+ #
+ # Tests to update: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverterTest com.google.cloud.cluster.mixer.protomappers.BackendServiceMappersTest.testResourceMapping
"kind": "compute#backendService", # Type of the resource.
"protocol": "A String",
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
@@ -398,7 +422,7 @@
"description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created.
"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, 1].
"maxRatePerInstance": 3.14, # The max RPS that a single backed 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.
- "capacityScaler": 3.14, # The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6].
+ "capacityScaler": 3.14, # The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].
"maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
"balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION.
},
@@ -420,13 +444,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -474,6 +498,12 @@
The object takes the form of:
{ # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
+ #
+ # If you add field foo, you probably need to also add: com.google.cloud.cluster.manager.api.BackendServiceResource: foo com.google.cloud.cluster.manager.networking.entities: BackendService, BackendServiceEntity: getFoo, setFoo:
+ #
+ # Converters/mappers will need to be updated: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverter: toResource, updateEntity: copy foo com.google.cloud.cluster.mixer.protomappers.BackendServiceMappers.ResourceMapper: ResourceMapper: add a new map call
+ #
+ # Tests to update: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverterTest com.google.cloud.cluster.mixer.protomappers.BackendServiceMappersTest.testResourceMapping
"kind": "compute#backendService", # Type of the resource.
"protocol": "A String",
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
@@ -485,7 +515,7 @@
"description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created.
"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, 1].
"maxRatePerInstance": 3.14, # The max RPS that a single backed 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.
- "capacityScaler": 3.14, # The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6].
+ "capacityScaler": 3.14, # The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].
"maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
"balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION.
},
@@ -507,13 +537,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.diskTypes.html b/docs/dyn/compute_v1.diskTypes.html
index 67028e5..e8e7145 100644
--- a/docs/dyn/compute_v1.diskTypes.html
+++ b/docs/dyn/compute_v1.diskTypes.html
@@ -96,9 +96,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -198,9 +198,9 @@
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html
index aa9ddad..648f72e 100644
--- a/docs/dyn/compute_v1.disks.html
+++ b/docs/dyn/compute_v1.disks.html
@@ -82,7 +82,7 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#createSnapshot">createSnapshot(project, zone, disk, body)</a></code></p>
-<p class="firstline">A description of how to use this function</p>
+<p class="firstline">Creates a snapshot of this 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.</p>
@@ -105,9 +105,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -187,7 +187,7 @@
<div class="method">
<code class="details" id="createSnapshot">createSnapshot(project, zone, disk, body)</code>
- <pre>A description of how to use this function
+ <pre>Creates a snapshot of this disk.
Args:
project: string, Project ID for this request. (required)
@@ -220,13 +220,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -277,13 +277,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -422,13 +422,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -472,9 +472,9 @@
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/compute_v1.firewalls.html b/docs/dyn/compute_v1.firewalls.html
index d4671ae..e6d7283 100644
--- a/docs/dyn/compute_v1.firewalls.html
+++ b/docs/dyn/compute_v1.firewalls.html
@@ -109,13 +109,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -255,13 +255,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -304,9 +304,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -426,13 +426,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -523,13 +523,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.forwardingRules.html b/docs/dyn/compute_v1.forwardingRules.html
index 991bcdf..ba07061 100644
--- a/docs/dyn/compute_v1.forwardingRules.html
+++ b/docs/dyn/compute_v1.forwardingRules.html
@@ -105,9 +105,9 @@
Args:
project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -177,13 +177,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -277,13 +277,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -327,9 +327,9 @@
Args:
project: string, Name of the project scoping this request. (required)
region: string, Name of the region scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -392,13 +392,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.globalAddresses.html b/docs/dyn/compute_v1.globalAddresses.html
index 0e259b2..bcf3b04 100644
--- a/docs/dyn/compute_v1.globalAddresses.html
+++ b/docs/dyn/compute_v1.globalAddresses.html
@@ -103,13 +103,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -203,13 +203,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -252,9 +252,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/compute_v1.globalForwardingRules.html b/docs/dyn/compute_v1.globalForwardingRules.html
index a87b191..486b961 100644
--- a/docs/dyn/compute_v1.globalForwardingRules.html
+++ b/docs/dyn/compute_v1.globalForwardingRules.html
@@ -106,13 +106,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -204,13 +204,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -253,9 +253,9 @@
Args:
project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -317,13 +317,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.globalOperations.html b/docs/dyn/compute_v1.globalOperations.html
index 9f3bb3a..088de33 100644
--- a/docs/dyn/compute_v1.globalOperations.html
+++ b/docs/dyn/compute_v1.globalOperations.html
@@ -99,9 +99,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -113,13 +113,13 @@
"operations": [ # [Output Only] List of operations contained in this scope.
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -210,13 +210,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -259,9 +259,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -271,13 +271,13 @@
"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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.html b/docs/dyn/compute_v1.html
index 8cc2eba..dd93e45 100644
--- a/docs/dyn/compute_v1.html
+++ b/docs/dyn/compute_v1.html
@@ -195,11 +195,21 @@
<p class="firstline">Returns the targetPools Resource.</p>
<p class="toc_element">
+ <code><a href="compute_v1.targetVpnGateways.html">targetVpnGateways()</a></code>
+</p>
+<p class="firstline">Returns the targetVpnGateways Resource.</p>
+
+<p class="toc_element">
<code><a href="compute_v1.urlMaps.html">urlMaps()</a></code>
</p>
<p class="firstline">Returns the urlMaps Resource.</p>
<p class="toc_element">
+ <code><a href="compute_v1.vpnTunnels.html">vpnTunnels()</a></code>
+</p>
+<p class="firstline">Returns the vpnTunnels Resource.</p>
+
+<p class="toc_element">
<code><a href="compute_v1.zoneOperations.html">zoneOperations()</a></code>
</p>
<p class="firstline">Returns the zoneOperations Resource.</p>
@@ -209,4 +219,25 @@
</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_v1.httpHealthChecks.html b/docs/dyn/compute_v1.httpHealthChecks.html
index 1a13a33..080b302 100644
--- a/docs/dyn/compute_v1.httpHealthChecks.html
+++ b/docs/dyn/compute_v1.httpHealthChecks.html
@@ -109,13 +109,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -211,13 +211,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -260,9 +260,9 @@
Args:
project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -338,13 +338,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -413,13 +413,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.images.html b/docs/dyn/compute_v1.images.html
index 9d7ecc6..c5d37b8 100644
--- a/docs/dyn/compute_v1.images.html
+++ b/docs/dyn/compute_v1.images.html
@@ -106,13 +106,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -175,13 +175,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -311,13 +311,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -360,9 +360,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html
index 0334cf8..3d38564 100644
--- a/docs/dyn/compute_v1.instanceTemplates.html
+++ b/docs/dyn/compute_v1.instanceTemplates.html
@@ -76,40 +76,40 @@
<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 resource.</p>
+<p class="firstline">Deletes the specified instance template.</p>
<p class="toc_element">
<code><a href="#get">get(project, instanceTemplate)</a></code></p>
<p class="firstline">Returns the specified instance template resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates an instance template resource in the specified project using the data included in the request.</p>
+<p class="firstline">Creates an instance template in the specified project using the data that is included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Retrieves the list of instance template resources contained within the specified project.</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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(project, instanceTemplate)</code>
- <pre>Deletes the specified instance template resource.
+ <pre>Deletes the specified instance template.
Args:
- project: string, Name of the project scoping this request. (required)
- instanceTemplate: string, Name of the instance template resource to delete. (required)
+ project: string, The 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] 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -151,21 +151,21 @@
<pre>Returns the specified instance template resource.
Args:
- project: string, Name of the project scoping this request. (required)
- instanceTemplate: string, Name of the instance template resource to return. (required)
+ project: string, The 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", # Type of the resource.
- "description": "A String", # An optional textual description of the instance template resource; provided by the client when the resource is created.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "properties": { # The instance properties portion of this instance template resource.
- "machineType": "A String", # Name of the machine type resource describing which machine type to use to host the instances created based on this template; provided by the client when the instance template is created.
- "description": "A String", # An optional textual description for the instances created based on the instance template resource; provided by the client when the template is created.
- "tags": { # A set of instance tags. # A list of tags to be applied to the instances created based on this template used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
+ "description": "A String", # An optional text description for the instance template.
+ "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 the instance template resource.
+ "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",
],
@@ -173,7 +173,7 @@
#
# To see the latest fingerprint, make get() request to the instance.
},
- "disks": [ # Array of disks associated with instance created based on this template.
+ "disks": [ # An array of disks that are associated with the instances that are created from this template.
{ # An instance-attached disk resource.
"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ 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.
#
@@ -216,12 +216,13 @@
"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template.
+ "scheduling": { # Sets the scheduling options for an Instance. # A list of 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).
+ "preemptible": True or False, # Whether the Instance is preemptible.
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "canIpForward": True or False, # Allows 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, say true. If unsure, leave this set to false.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
+ "canIpForward": True or False, # A boolean that specifies if instances created from this template can send packets with source IP addresses other than their own or receive packets with destination IP addresses other than their own. If you use these instances as an IP gateway or as the next-hop in a Route resource, specify true. Otherwise, specify false.
+ "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",
@@ -229,7 +230,7 @@
"email": "A String", # Email address of the service account.
},
],
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to instances created based on this template. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "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.
@@ -239,7 +240,7 @@
"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.
},
- "networkInterfaces": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instances created based based on this template will have no external internet access.
+ "networkInterfaces": [ # An array of network access configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only supported access configuration. If you do not specify any access configurations, the instances that are created from this template will have no external internet access.
{ # A network interface resource attached to an instance.
"accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config 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.
@@ -262,29 +263,29 @@
},
],
},
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the instance template resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035
+ "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
+ "name": "A String", # The name of the instance template. The name must be 1-63 characters long, and comply with RFC1035.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
- <pre>Creates an instance template resource in the specified project using the data included in the request.
+ <pre>Creates an instance template in the specified project using the data that is included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, The 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", # Type of the resource.
- "description": "A String", # An optional textual description of the instance template resource; provided by the client when the resource is created.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "properties": { # The instance properties portion of this instance template resource.
- "machineType": "A String", # Name of the machine type resource describing which machine type to use to host the instances created based on this template; provided by the client when the instance template is created.
- "description": "A String", # An optional textual description for the instances created based on the instance template resource; provided by the client when the template is created.
- "tags": { # A set of instance tags. # A list of tags to be applied to the instances created based on this template used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
+ "description": "A String", # An optional text description for the instance template.
+ "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 the instance template resource.
+ "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",
],
@@ -292,7 +293,7 @@
#
# To see the latest fingerprint, make get() request to the instance.
},
- "disks": [ # Array of disks associated with instance created based on this template.
+ "disks": [ # An array of disks that are associated with the instances that are created from this template.
{ # An instance-attached disk resource.
"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ 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.
#
@@ -335,12 +336,13 @@
"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template.
+ "scheduling": { # Sets the scheduling options for an Instance. # A list of 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).
+ "preemptible": True or False, # Whether the Instance is preemptible.
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "canIpForward": True or False, # Allows 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, say true. If unsure, leave this set to false.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
+ "canIpForward": True or False, # A boolean that specifies if instances created from this template can send packets with source IP addresses other than their own or receive packets with destination IP addresses other than their own. If you use these instances as an IP gateway or as the next-hop in a Route resource, specify true. Otherwise, specify false.
+ "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",
@@ -348,7 +350,7 @@
"email": "A String", # Email address of the service account.
},
],
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to instances created based on this template. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "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.
@@ -358,7 +360,7 @@
"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.
},
- "networkInterfaces": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instances created based based on this template will have no external internet access.
+ "networkInterfaces": [ # An array of network access configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only supported access configuration. If you do not specify any access configurations, the instances that are created from this template will have no external internet access.
{ # A network interface resource attached to an instance.
"accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config 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.
@@ -381,8 +383,8 @@
},
],
},
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the instance template resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035
+ "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
+ "name": "A String", # The name of the instance template. The name must be 1-63 characters long, and comply with RFC1035.
}
@@ -391,13 +393,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -436,29 +438,29 @@
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Retrieves the list of instance template resources contained within the specified project.
+ <pre>Retrieves a list of instance templates that are contained within the specified project and zone.
Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
- { # Contains a list of instance template resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
+ { # A list of instance templates.
+ "nextPageToken": "A String", # [Output Only] A token that is used to continue a truncated list request.
"items": [ # A list of InstanceTemplate resources.
{ # An Instance Template resource.
- "kind": "compute#instanceTemplate", # Type of the resource.
- "description": "A String", # An optional textual description of the instance template resource; provided by the client when the resource is created.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "properties": { # The instance properties portion of this instance template resource.
- "machineType": "A String", # Name of the machine type resource describing which machine type to use to host the instances created based on this template; provided by the client when the instance template is created.
- "description": "A String", # An optional textual description for the instances created based on the instance template resource; provided by the client when the template is created.
- "tags": { # A set of instance tags. # A list of tags to be applied to the instances created based on this template used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
+ "description": "A String", # An optional text description for the instance template.
+ "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 the instance template resource.
+ "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",
],
@@ -466,7 +468,7 @@
#
# To see the latest fingerprint, make get() request to the instance.
},
- "disks": [ # Array of disks associated with instance created based on this template.
+ "disks": [ # An array of disks that are associated with the instances that are created from this template.
{ # An instance-attached disk resource.
"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ 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.
#
@@ -509,12 +511,13 @@
"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template.
+ "scheduling": { # Sets the scheduling options for an Instance. # A list of 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).
+ "preemptible": True or False, # Whether the Instance is preemptible.
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "canIpForward": True or False, # Allows 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, say true. If unsure, leave this set to false.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
+ "canIpForward": True or False, # A boolean that specifies if instances created from this template can send packets with source IP addresses other than their own or receive packets with destination IP addresses other than their own. If you use these instances as an IP gateway or as the next-hop in a Route resource, specify true. Otherwise, specify false.
+ "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",
@@ -522,7 +525,7 @@
"email": "A String", # Email address of the service account.
},
],
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to instances created based on this template. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "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.
@@ -532,7 +535,7 @@
"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.
},
- "networkInterfaces": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instances created based based on this template will have no external internet access.
+ "networkInterfaces": [ # An array of network access configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only supported access configuration. If you do not specify any access configurations, the instances that are created from this template will have no external internet access.
{ # A network interface resource attached to an instance.
"accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config 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.
@@ -555,13 +558,13 @@
},
],
},
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the instance template resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035
+ "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
+ "name": "A String", # The name of the instance template. The name must be 1-63 characters long, and comply with RFC1035.
},
],
- "kind": "compute#instanceTemplateList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "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>
diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html
index d210ac5..bd060ee 100644
--- a/docs/dyn/compute_v1.instances.html
+++ b/docs/dyn/compute_v1.instances.html
@@ -99,7 +99,7 @@
<code><a href="#get">get(project, zone, instance)</a></code></p>
<p class="firstline">Returns the specified instance resource.</p>
<p class="toc_element">
- <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance)</a></code></p>
+ <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, 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>
@@ -157,13 +157,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -206,9 +206,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -219,7 +219,8 @@
"a_key": { # 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, STOPPED, TERMINATED.
+ "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, and TERMINATED.
"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
"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 textual description of the resource; provided by the client when the resource is created.
@@ -279,6 +280,7 @@
"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).
+ "preemptible": True or False, # Whether the Instance is preemptible.
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
@@ -420,13 +422,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -477,13 +479,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -536,13 +538,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -594,13 +596,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -650,7 +652,8 @@
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, STOPPED, TERMINATED.
+ "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, and TERMINATED.
"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
"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 textual description of the resource; provided by the client when the resource is created.
@@ -710,6 +713,7 @@
"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).
+ "preemptible": True or False, # Whether the Instance is preemptible.
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
@@ -762,13 +766,14 @@
</div>
<div class="method">
- <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance)</code>
+ <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, 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)
+ port: integer, Which COM port to retrieve data from.
Returns:
An object of the form:
@@ -791,7 +796,8 @@
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, STOPPED, TERMINATED.
+ "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, and TERMINATED.
"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
"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 textual description of the resource; provided by the client when the resource is created.
@@ -851,6 +857,7 @@
"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).
+ "preemptible": True or False, # Whether the Instance is preemptible.
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
@@ -907,13 +914,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -957,9 +964,9 @@
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -968,7 +975,8 @@
"nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
"items": [ # [Output Only] A list of Instance resources.
{ # An Instance resource.
- "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, TERMINATED.
+ "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, and TERMINATED.
"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
"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 textual description of the resource; provided by the client when the resource is created.
@@ -1028,6 +1036,7 @@
"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).
+ "preemptible": True or False, # Whether the Instance is preemptible.
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
@@ -1112,13 +1121,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -1171,13 +1180,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -1242,13 +1251,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -1298,6 +1307,7 @@
{ # 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).
+ "preemptible": True or False, # Whether the Instance is preemptible.
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
}
@@ -1307,13 +1317,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -1376,13 +1386,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -1433,13 +1443,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -1483,20 +1493,20 @@
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)
+ 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] 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.machineTypes.html b/docs/dyn/compute_v1.machineTypes.html
index 235d5c5..da8442d 100644
--- a/docs/dyn/compute_v1.machineTypes.html
+++ b/docs/dyn/compute_v1.machineTypes.html
@@ -96,9 +96,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -214,9 +214,9 @@
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/compute_v1.networks.html b/docs/dyn/compute_v1.networks.html
index 226e882..f878a5a 100644
--- a/docs/dyn/compute_v1.networks.html
+++ b/docs/dyn/compute_v1.networks.html
@@ -103,13 +103,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -195,13 +195,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -244,9 +244,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/compute_v1.projects.html b/docs/dyn/compute_v1.projects.html
index e59c0f1..b09ba93 100644
--- a/docs/dyn/compute_v1.projects.html
+++ b/docs/dyn/compute_v1.projects.html
@@ -141,8 +141,14 @@
The object takes the form of:
{
- "targetDisk": "A String", # The URL of the target disk to be moved.
- "destinationZone": "A String", # The URL of the zone to which the disk will be moved.
+ "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 to. 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
}
@@ -151,13 +157,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -204,8 +210,14 @@
The object takes the form of:
{
- "targetInstance": "A String", # The URL of the target instance to move.
- "destinationZone": "A String", # The URL of the zone to move the instance to.
+ "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 to. 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
}
@@ -214,13 +226,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -283,13 +295,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -346,13 +358,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.regionOperations.html b/docs/dyn/compute_v1.regionOperations.html
index 9b8c844..5328257 100644
--- a/docs/dyn/compute_v1.regionOperations.html
+++ b/docs/dyn/compute_v1.regionOperations.html
@@ -112,13 +112,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -162,9 +162,9 @@
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -174,13 +174,13 @@
"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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.regions.html b/docs/dyn/compute_v1.regions.html
index 01d3585..5fe9b31 100644
--- a/docs/dyn/compute_v1.regions.html
+++ b/docs/dyn/compute_v1.regions.html
@@ -129,9 +129,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/compute_v1.routes.html b/docs/dyn/compute_v1.routes.html
index 6722c91..8ece2a7 100644
--- a/docs/dyn/compute_v1.routes.html
+++ b/docs/dyn/compute_v1.routes.html
@@ -103,13 +103,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -159,13 +159,17 @@
{ # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with VMs by tag and the set of Routes for a particular VM is called its routing table. For each packet leaving a VM, the system searches that VM's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the next_hop field of the winning Route -- either to another VM destination, a VM gateway or a GCE operated gateway. Packets that do not match any Route in the sending VM's routing table will be dropped.
"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets.
- "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values.
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
"kind": "compute#route", # Type of the resource.
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
"tags": [ # A list of instance tags to which this route applies.
"A String",
],
"nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
+ "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
+ "selfLink": "A String", # Server defined URL for the resource (output only).
"warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
{
"message": "A String", # [Output Only] Optional human-readable details for this warning.
@@ -178,9 +182,6 @@
],
},
],
- "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
- "network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
- "selfLink": "A String", # Server defined URL for the resource (output only).
"destRange": "A String", # Which packets does this route apply to?
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
@@ -200,13 +201,17 @@
{ # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with VMs by tag and the set of Routes for a particular VM is called its routing table. For each packet leaving a VM, the system searches that VM's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the next_hop field of the winning Route -- either to another VM destination, a VM gateway or a GCE operated gateway. Packets that do not match any Route in the sending VM's routing table will be dropped.
"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets.
- "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values.
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
"kind": "compute#route", # Type of the resource.
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
"tags": [ # A list of instance tags to which this route applies.
"A String",
],
"nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
+ "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
+ "selfLink": "A String", # Server defined URL for the resource (output only).
"warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
{
"message": "A String", # [Output Only] Optional human-readable details for this warning.
@@ -219,9 +224,6 @@
],
},
],
- "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
- "network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
- "selfLink": "A String", # Server defined URL for the resource (output only).
"destRange": "A String", # Which packets does this route apply to?
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
@@ -235,13 +237,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -284,9 +286,9 @@
Args:
project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -296,13 +298,17 @@
"items": [ # A list of Route resources.
{ # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with VMs by tag and the set of Routes for a particular VM is called its routing table. For each packet leaving a VM, the system searches that VM's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the next_hop field of the winning Route -- either to another VM destination, a VM gateway or a GCE operated gateway. Packets that do not match any Route in the sending VM's routing table will be dropped.
"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets.
- "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values.
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
"kind": "compute#route", # Type of the resource.
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
"tags": [ # A list of instance tags to which this route applies.
"A String",
],
"nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
+ "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
+ "selfLink": "A String", # Server defined URL for the resource (output only).
"warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
{
"message": "A String", # [Output Only] Optional human-readable details for this warning.
@@ -315,9 +321,6 @@
],
},
],
- "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
- "network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
- "selfLink": "A String", # Server defined URL for the resource (output only).
"destRange": "A String", # Which packets does this route apply to?
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html
index a4560f1..b8bd840 100644
--- a/docs/dyn/compute_v1.snapshots.html
+++ b/docs/dyn/compute_v1.snapshots.html
@@ -100,13 +100,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -179,9 +179,9 @@
Args:
project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/compute_v1.targetHttpProxies.html b/docs/dyn/compute_v1.targetHttpProxies.html
index 88981fe..d0aa6fb 100644
--- a/docs/dyn/compute_v1.targetHttpProxies.html
+++ b/docs/dyn/compute_v1.targetHttpProxies.html
@@ -106,13 +106,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -196,13 +196,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -245,9 +245,9 @@
Args:
project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -305,13 +305,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.targetInstances.html b/docs/dyn/compute_v1.targetInstances.html
index 0b02444..6f9a344 100644
--- a/docs/dyn/compute_v1.targetInstances.html
+++ b/docs/dyn/compute_v1.targetInstances.html
@@ -102,9 +102,9 @@
Args:
project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -172,13 +172,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -268,13 +268,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -318,9 +318,9 @@
Args:
project: string, Name of the project scoping this request. (required)
zone: string, Name of the zone scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/compute_v1.targetPools.html b/docs/dyn/compute_v1.targetPools.html
index 78deba5..4acaf36 100644
--- a/docs/dyn/compute_v1.targetPools.html
+++ b/docs/dyn/compute_v1.targetPools.html
@@ -139,13 +139,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -207,13 +207,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -256,9 +256,9 @@
Args:
project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -341,13 +341,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -499,13 +499,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -549,9 +549,9 @@
Args:
project: string, Name of the project scoping this request. (required)
region: string, Name of the region scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -631,13 +631,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -699,13 +699,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -764,13 +764,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.targetVpnGateways.html b/docs/dyn/compute_v1.targetVpnGateways.html
new file mode 100644
index 0000000..ceb326d
--- /dev/null
+++ b/docs/dyn/compute_v1.targetVpnGateways.html
@@ -0,0 +1,387 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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_v1.html">Compute Engine API</a> . <a href="compute_v1.targetVpnGateways.html">targetVpnGateways</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of target VPN gateways grouped by scope.</p>
+<p class="toc_element">
+ <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, region, targetVpnGateway)</a></code></p>
+<p class="firstline">Deletes the specified TargetVpnGateway resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, targetVpnGateway)</a></code></p>
+<p class="firstline">Returns the specified TargetVpnGateway resource.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a TargetVpnGateway 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, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of TargetVpnGateway 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>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of target VPN gateways grouped by scope.
+
+Args:
+ project: string, 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:
+
+ {
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "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.
+ {
+ "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 textual description of the resource. Provided by the client when the resource is created.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert 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] Unique identifier for the resource. 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.
+ },
+ ],
+ "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
+ "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.
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "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="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 TargetVpnGateway resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ targetVpnGateway: string, Name of the TargetVpnGateway 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": "compute#operation", # [Output Only] 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, region, targetVpnGateway)</code>
+ <pre>Returns the specified TargetVpnGateway resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ targetVpnGateway: string, Name of the TargetVpnGateway resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "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 textual description of the resource. Provided by the client when the resource is created.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert 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] Unique identifier for the resource. 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.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a TargetVpnGateway 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, The name of the region for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "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 textual description of the resource. Provided by the client when the resource is created.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert 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] Unique identifier for the resource. 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.
+ }
+
+
+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": "compute#operation", # [Output Only] 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, region, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of TargetVpnGateway resources available to the specified project and region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region 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:
+
+ { # Contains a list of TargetVpnGateway resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of TargetVpnGateway resources.
+ {
+ "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 textual description of the resource. Provided by the client when the resource is created.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert 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] Unique identifier for the resource. 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.
+ },
+ ],
+ "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "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="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object 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.urlMaps.html b/docs/dyn/compute_v1.urlMaps.html
index 0b63d44..36143e4 100644
--- a/docs/dyn/compute_v1.urlMaps.html
+++ b/docs/dyn/compute_v1.urlMaps.html
@@ -112,13 +112,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -268,13 +268,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -317,9 +317,9 @@
Args:
project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -449,13 +449,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -551,13 +551,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.vpnTunnels.html b/docs/dyn/compute_v1.vpnTunnels.html
new file mode 100644
index 0000000..4a46b8a
--- /dev/null
+++ b/docs/dyn/compute_v1.vpnTunnels.html
@@ -0,0 +1,395 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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_v1.html">Compute Engine API</a> . <a href="compute_v1.vpnTunnels.html">vpnTunnels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of VPN tunnels grouped by scope.</p>
+<p class="toc_element">
+ <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, region, 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.</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, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the 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>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of VPN tunnels grouped by scope.
+
+Args:
+ project: string, 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:
+
+ {
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "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.
+ "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and comply with RFC1035.
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
+ "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.
+ "ikeNetworks": [ # IKE networks 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",
+ ],
+ },
+ ],
+ "warning": { # Informational warning which replaces the list of addresses when the list is empty.
+ "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.
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "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, vpnTunnel)</code>
+ <pre>Deletes the specified VpnTunnel resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The 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] 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": "compute#operation", # [Output Only] 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, region, vpnTunnel)</code>
+ <pre>Returns the specified VpnTunnel resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The 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.
+ "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and comply with RFC1035.
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
+ "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.
+ "ikeNetworks": [ # IKE networks 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",
+ ],
+ }</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, The 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.
+ "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and comply with RFC1035.
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
+ "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.
+ "ikeNetworks": [ # IKE networks 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",
+ ],
+ }
+
+
+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": "compute#operation", # [Output Only] 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, region, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of VpnTunnel resources contained in the specified project and region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region 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:
+
+ { # Contains a list of VpnTunnel resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "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.
+ "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and comply with RFC1035.
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
+ "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.
+ "ikeNetworks": [ # IKE networks 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",
+ ],
+ },
+ ],
+ "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "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="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object 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.zoneOperations.html b/docs/dyn/compute_v1.zoneOperations.html
index 5114bc3..f7f906c 100644
--- a/docs/dyn/compute_v1.zoneOperations.html
+++ b/docs/dyn/compute_v1.zoneOperations.html
@@ -112,13 +112,13 @@
{ # 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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
@@ -162,9 +162,9 @@
Args:
project: string, Project ID for this request. (required)
zone: string, Name of the zone scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
@@ -174,13 +174,13 @@
"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
+ "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 be monotonically increasing as the operation progresses.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 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.
diff --git a/docs/dyn/compute_v1.zones.html b/docs/dyn/compute_v1.zones.html
index 5a3a6b3..d47f723 100644
--- a/docs/dyn/compute_v1.zones.html
+++ b/docs/dyn/compute_v1.zones.html
@@ -128,9 +128,9 @@
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
+ 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:
diff --git a/docs/dyn/computeaccounts_alpha.globalAccountsOperations.html b/docs/dyn/computeaccounts_alpha.globalAccountsOperations.html
new file mode 100644
index 0000000..9ada186
--- /dev/null
+++ b/docs/dyn/computeaccounts_alpha.globalAccountsOperations.html
@@ -0,0 +1,237 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..c4ab412
--- /dev/null
+++ b/docs/dyn/computeaccounts_alpha.groups.html
@@ -0,0 +1,428 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.html b/docs/dyn/computeaccounts_alpha.html
new file mode 100644
index 0000000..938942e
--- /dev/null
+++ b/docs/dyn/computeaccounts_alpha.html
@@ -0,0 +1,118 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="computeaccounts_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>
+</p>
+<p class="firstline">Returns the groups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="computeaccounts_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>
+</p>
+<p class="firstline">Returns the users 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/computeaccounts_alpha.linux.html b/docs/dyn/computeaccounts_alpha.linux.html
new file mode 100644
index 0000000..2f78ca3
--- /dev/null
+++ b/docs/dyn/computeaccounts_alpha.linux.html
@@ -0,0 +1,149 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="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
new file mode 100644
index 0000000..9592be3
--- /dev/null
+++ b/docs/dyn/computeaccounts_alpha.users.html
@@ -0,0 +1,452 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="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
index 3b6f582..065e255 100644
--- a/docs/dyn/container_v1beta1.html
+++ b/docs/dyn/container_v1beta1.html
@@ -79,4 +79,25 @@
</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
index 38ec584..d116563 100644
--- a/docs/dyn/container_v1beta1.projects.clusters.html
+++ b/docs/dyn/container_v1beta1.projects.clusters.html
@@ -92,20 +92,31 @@
"clusters": [ # A list of clusters in the project, across all zones.
{
"status": "A String", # [Output only] The current status of this cluster.
- "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.
+ "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.
- "zone": "A String", # [Output only] The name of the Google Compute Engine zone in which the cluster resides.
+ "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.
- "masterAuth": { # The HTTP basic authentication information for accessing the master. Because the master endpoint is open to the internet, you should create a strong password.
- "password": "A String", # The password to use when accessing the Kubernetes master endpoint.
- "user": "A String", # The username to use when accessing the Kubernetes master endpoint.
+ "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.
- "containerIpv4Cidr": "A String", # [Output only] The IP addresses of the container pods in this cluster, in CIDR notation (e.g. 1.2.3.4/29).
+ "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,
@@ -125,13 +136,11 @@
# 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 addresses of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are always in the 10.0.0.0/16 range.
+ "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.
- "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.
+ "enableCloudMonitoring": True or False, # Whether metrics from the cluster should be made available via the Google Cloud Monitoring service.
},
],
}</pre>
diff --git a/docs/dyn/container_v1beta1.projects.operations.html b/docs/dyn/container_v1beta1.projects.operations.html
index 3cae5c2..30e9144 100644
--- a/docs/dyn/container_v1beta1.projects.operations.html
+++ b/docs/dyn/container_v1beta1.projects.operations.html
@@ -92,7 +92,7 @@
"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 this operation. If the operation is fulfilled upfront, it may not have a resource name.
+ "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.
diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html
index 50a1aaa..2a696bb 100644
--- a/docs/dyn/container_v1beta1.projects.zones.clusters.html
+++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html
@@ -95,7 +95,7 @@
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, a route named k8s-iproute-10-xx-0-0 is created to track that the cluster's 10.xx.0.0/16 CIDR has been assigned.
+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)
@@ -106,20 +106,31 @@
{
"cluster": { # A cluster resource.
"status": "A String", # [Output only] The current status of this cluster.
- "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.
+ "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.
- "zone": "A String", # [Output only] The name of the Google Compute Engine zone in which the cluster resides.
+ "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.
- "masterAuth": { # The HTTP basic authentication information for accessing the master. Because the master endpoint is open to the internet, you should create a strong password.
- "password": "A String", # The password to use when accessing the Kubernetes master endpoint.
- "user": "A String", # The username to use when accessing the Kubernetes master endpoint.
+ "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.
- "containerIpv4Cidr": "A String", # [Output only] The IP addresses of the container pods in this cluster, in CIDR notation (e.g. 1.2.3.4/29).
+ "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,
@@ -139,13 +150,11 @@
# 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 addresses of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are always in the 10.0.0.0/16 range.
+ "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.
- "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.
+ "enableCloudMonitoring": True or False, # Whether metrics from the cluster should be made available via the Google Cloud Monitoring service.
},
}
@@ -155,7 +164,7 @@
{ # 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 this operation. If the operation is fulfilled upfront, it may not have a resource name.
+ "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.
@@ -181,7 +190,7 @@
{ # 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 this operation. If the operation is fulfilled upfront, it may not have a resource name.
+ "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.
@@ -205,20 +214,31 @@
{
"status": "A String", # [Output only] The current status of this cluster.
- "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.
+ "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.
- "zone": "A String", # [Output only] The name of the Google Compute Engine zone in which the cluster resides.
+ "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.
- "masterAuth": { # The HTTP basic authentication information for accessing the master. Because the master endpoint is open to the internet, you should create a strong password.
- "password": "A String", # The password to use when accessing the Kubernetes master endpoint.
- "user": "A String", # The username to use when accessing the Kubernetes master endpoint.
+ "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.
- "containerIpv4Cidr": "A String", # [Output only] The IP addresses of the container pods in this cluster, in CIDR notation (e.g. 1.2.3.4/29).
+ "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,
@@ -238,13 +258,11 @@
# 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 addresses of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are always in the 10.0.0.0/16 range.
+ "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.
- "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.
+ "enableCloudMonitoring": True or False, # Whether metrics from the cluster should be made available via the Google Cloud Monitoring service.
}</pre>
</div>
@@ -263,20 +281,31 @@
"clusters": [ # A list of clusters in the project in the specified zone.
{
"status": "A String", # [Output only] The current status of this cluster.
- "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.
+ "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.
- "zone": "A String", # [Output only] The name of the Google Compute Engine zone in which the cluster resides.
+ "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.
- "masterAuth": { # The HTTP basic authentication information for accessing the master. Because the master endpoint is open to the internet, you should create a strong password.
- "password": "A String", # The password to use when accessing the Kubernetes master endpoint.
- "user": "A String", # The username to use when accessing the Kubernetes master endpoint.
+ "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.
- "containerIpv4Cidr": "A String", # [Output only] The IP addresses of the container pods in this cluster, in CIDR notation (e.g. 1.2.3.4/29).
+ "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,
@@ -296,13 +325,11 @@
# 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 addresses of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are always in the 10.0.0.0/16 range.
+ "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.
- "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.
+ "enableCloudMonitoring": True or False, # Whether metrics from the cluster should be made available via the Google Cloud Monitoring service.
},
],
}</pre>
diff --git a/docs/dyn/container_v1beta1.projects.zones.operations.html b/docs/dyn/container_v1beta1.projects.zones.operations.html
index 67871bb..1c380c1 100644
--- a/docs/dyn/container_v1beta1.projects.zones.operations.html
+++ b/docs/dyn/container_v1beta1.projects.zones.operations.html
@@ -95,7 +95,7 @@
{ # 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 this operation. If the operation is fulfilled upfront, it may not have a resource name.
+ "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.
@@ -120,7 +120,7 @@
"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 this operation. If the operation is fulfilled upfront, it may not have a resource name.
+ "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.
diff --git a/docs/dyn/content_v2.accounts.html b/docs/dyn/content_v2.accounts.html
index 5bd13b9..061adcd 100644
--- a/docs/dyn/content_v2.accounts.html
+++ b/docs/dyn/content_v2.accounts.html
@@ -114,10 +114,10 @@
{
"kind": "content#accountsAuthInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".
"accountIdentifiers": [ # The account identifiers corresponding to the authenticated user.
- { # Account identifier corresponding to the authenticated user.
- # - For an individual account: only the merchant ID is defined
- # - For an aggregator: only the aggregator ID is defined
- # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
+ # - For an individual account: only the merchant ID is defined
+ # - For an aggregator: only the aggregator ID is defined
+ # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
+ {
"aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
"merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts.
},
@@ -146,9 +146,9 @@
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "adwordsLinks": [ # List of linked AdWords accounts.
+ "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
{
- "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
+ "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
@@ -182,9 +182,9 @@
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "adwordsLinks": [ # List of linked AdWords accounts.
+ "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
{
- "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
+ "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
@@ -241,9 +241,9 @@
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "adwordsLinks": [ # List of linked AdWords accounts.
+ "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
{
- "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
+ "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
@@ -273,9 +273,9 @@
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "adwordsLinks": [ # List of linked AdWords accounts.
+ "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
{
- "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
+ "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
@@ -299,9 +299,9 @@
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "adwordsLinks": [ # List of linked AdWords accounts.
+ "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
{
- "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
+ "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
@@ -338,9 +338,9 @@
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "adwordsLinks": [ # List of linked AdWords accounts.
+ "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
{
- "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
+ "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
@@ -387,9 +387,9 @@
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "adwordsLinks": [ # List of linked AdWords accounts.
+ "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
{
- "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
+ "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
@@ -413,9 +413,9 @@
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "adwordsLinks": [ # List of linked AdWords accounts.
+ "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
{
- "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
+ "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
@@ -446,9 +446,9 @@
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "adwordsLinks": [ # List of linked AdWords accounts.
+ "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
{
- "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
+ "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
@@ -472,9 +472,9 @@
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "adwordsLinks": [ # List of linked AdWords accounts.
+ "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
{
- "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
+ "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
diff --git a/docs/dyn/content_v2.accountshipping.html b/docs/dyn/content_v2.accountshipping.html
index d87e434..5786169 100644
--- a/docs/dyn/content_v2.accountshipping.html
+++ b/docs/dyn/content_v2.accountshipping.html
@@ -75,7 +75,7 @@
<h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.accountshipping.html">accountshipping</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#custombatch">custombatch(body)</a></code></p>
+ <code><a href="#custombatch">custombatch(body, dryRun=None)</a></code></p>
<p class="firstline">Retrieves and updates the shipping settings of multiple accounts in a single request.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, accountId)</a></code></p>
@@ -87,14 +87,14 @@
<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(merchantId, accountId, body)</a></code></p>
+ <code><a href="#patch">patch(merchantId, accountId, body, dryRun=None)</a></code></p>
<p class="firstline">Updates the shipping settings of the account. This method supports patch semantics.</p>
<p class="toc_element">
- <code><a href="#update">update(merchantId, accountId, body)</a></code></p>
+ <code><a href="#update">update(merchantId, accountId, body, dryRun=None)</a></code></p>
<p class="firstline">Updates the shipping settings of the account.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="custombatch">custombatch(body)</code>
+ <code class="details" id="custombatch">custombatch(body, dryRun=None)</code>
<pre>Retrieves and updates the shipping settings of multiple accounts in a single request.
Args:
@@ -242,6 +242,7 @@
],
}
+ dryRun: boolean, Flag to run the request in dry-run mode.
Returns:
An object of the form:
@@ -706,7 +707,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(merchantId, accountId, body)</code>
+ <code class="details" id="patch">patch(merchantId, accountId, body, dryRun=None)</code>
<pre>Updates the shipping settings of the account. This method supports patch semantics.
Args:
@@ -846,6 +847,7 @@
],
}
+ dryRun: boolean, Flag to run the request in dry-run mode.
Returns:
An object of the form:
@@ -983,7 +985,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(merchantId, accountId, body)</code>
+ <code class="details" id="update">update(merchantId, accountId, body, dryRun=None)</code>
<pre>Updates the shipping settings of the account.
Args:
@@ -1123,6 +1125,7 @@
],
}
+ dryRun: boolean, Flag to run the request in dry-run mode.
Returns:
An object of the form:
diff --git a/docs/dyn/content_v2.accounttax.html b/docs/dyn/content_v2.accounttax.html
index 80181cb..aa93539 100644
--- a/docs/dyn/content_v2.accounttax.html
+++ b/docs/dyn/content_v2.accounttax.html
@@ -75,7 +75,7 @@
<h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.accounttax.html">accounttax</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#custombatch">custombatch(body)</a></code></p>
+ <code><a href="#custombatch">custombatch(body, dryRun=None)</a></code></p>
<p class="firstline">Retrieves and updates tax settings of multiple accounts in a single request.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, accountId)</a></code></p>
@@ -87,14 +87,14 @@
<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(merchantId, accountId, body)</a></code></p>
+ <code><a href="#patch">patch(merchantId, accountId, body, dryRun=None)</a></code></p>
<p class="firstline">Updates the tax settings of the account. This method supports patch semantics.</p>
<p class="toc_element">
- <code><a href="#update">update(merchantId, accountId, body)</a></code></p>
+ <code><a href="#update">update(merchantId, accountId, body, dryRun=None)</a></code></p>
<p class="firstline">Updates the tax settings of the account.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="custombatch">custombatch(body)</code>
+ <code class="details" id="custombatch">custombatch(body, dryRun=None)</code>
<pre>Retrieves and updates tax settings of multiple accounts in a single request.
Args:
@@ -125,6 +125,7 @@
],
}
+ dryRun: boolean, Flag to run the request in dry-run mode.
Returns:
An object of the form:
@@ -238,7 +239,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(merchantId, accountId, body)</code>
+ <code class="details" id="patch">patch(merchantId, accountId, body, dryRun=None)</code>
<pre>Updates the tax settings of the account. This method supports patch semantics.
Args:
@@ -261,6 +262,7 @@
"accountId": "A String", # The ID of the account to which these account tax settings belong.
}
+ dryRun: boolean, Flag to run the request in dry-run mode.
Returns:
An object of the form:
@@ -281,7 +283,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(merchantId, accountId, body)</code>
+ <code class="details" id="update">update(merchantId, accountId, body, dryRun=None)</code>
<pre>Updates the tax settings of the account.
Args:
@@ -304,6 +306,7 @@
"accountId": "A String", # The ID of the account to which these account tax settings belong.
}
+ dryRun: boolean, Flag to run the request in dry-run mode.
Returns:
An object of the form:
diff --git a/docs/dyn/content_v2.datafeedstatuses.html b/docs/dyn/content_v2.datafeedstatuses.html
index 401677b..1221ee7 100644
--- a/docs/dyn/content_v2.datafeedstatuses.html
+++ b/docs/dyn/content_v2.datafeedstatuses.html
@@ -158,6 +158,7 @@
],
},
],
+ "lastUploadDate": "A String", # The last date at which the feed was uploaded.
"itemsValid": "A String", # The number of items in the feed that were valid.
"datafeedId": "A String", # The ID of the feed for which the status is reported.
},
@@ -209,6 +210,7 @@
],
},
],
+ "lastUploadDate": "A String", # The last date at which the feed was uploaded.
"itemsValid": "A String", # The number of items in the feed that were valid.
"datafeedId": "A String", # The ID of the feed for which the status is reported.
}</pre>
@@ -262,6 +264,7 @@
],
},
],
+ "lastUploadDate": "A String", # The last date at which the feed was uploaded.
"itemsValid": "A String", # The number of items in the feed that were valid.
"datafeedId": "A String", # The ID of the feed for which the status is reported.
},
diff --git a/docs/dyn/content_v2.html b/docs/dyn/content_v2.html
index aae6334..18488f3 100644
--- a/docs/dyn/content_v2.html
+++ b/docs/dyn/content_v2.html
@@ -119,4 +119,25 @@
</p>
<p class="firstline">Returns the productstatuses 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/content_v2.products.html b/docs/dyn/content_v2.products.html
index e295b24..d64543c 100644
--- a/docs/dyn/content_v2.products.html
+++ b/docs/dyn/content_v2.products.html
@@ -166,6 +166,13 @@
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
+ "aspects": [ # Specifies the intended aspects for the product.
+ {
+ "intention": "A String", # Whether the aspect is required, excluded or should be validated.
+ "aspectName": "A String", # The name of the aspect.
+ "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
+ },
+ ],
"description": "A String", # Description of the item.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"warnings": [ # Read-only warnings.
@@ -373,6 +380,13 @@
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
+ "aspects": [ # Specifies the intended aspects for the product.
+ {
+ "intention": "A String", # Whether the aspect is required, excluded or should be validated.
+ "aspectName": "A String", # The name of the aspect.
+ "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
+ },
+ ],
"description": "A String", # Description of the item.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"warnings": [ # Read-only warnings.
@@ -578,6 +592,13 @@
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
+ "aspects": [ # Specifies the intended aspects for the product.
+ {
+ "intention": "A String", # Whether the aspect is required, excluded or should be validated.
+ "aspectName": "A String", # The name of the aspect.
+ "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
+ },
+ ],
"description": "A String", # Description of the item.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"warnings": [ # Read-only warnings.
@@ -767,6 +788,13 @@
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
+ "aspects": [ # Specifies the intended aspects for the product.
+ {
+ "intention": "A String", # Whether the aspect is required, excluded or should be validated.
+ "aspectName": "A String", # The name of the aspect.
+ "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
+ },
+ ],
"description": "A String", # Description of the item.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"warnings": [ # Read-only warnings.
@@ -951,6 +979,13 @@
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
+ "aspects": [ # Specifies the intended aspects for the product.
+ {
+ "intention": "A String", # Whether the aspect is required, excluded or should be validated.
+ "aspectName": "A String", # The name of the aspect.
+ "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
+ },
+ ],
"description": "A String", # Description of the item.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"warnings": [ # Read-only warnings.
@@ -1147,6 +1182,13 @@
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
+ "aspects": [ # Specifies the intended aspects for the product.
+ {
+ "intention": "A String", # Whether the aspect is required, excluded or should be validated.
+ "aspectName": "A String", # The name of the aspect.
+ "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
+ },
+ ],
"description": "A String", # Description of the item.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"warnings": [ # Read-only warnings.
diff --git a/docs/dyn/coordinate_v1.html b/docs/dyn/coordinate_v1.html
index 525d8c6..f5f657d 100644
--- a/docs/dyn/coordinate_v1.html
+++ b/docs/dyn/coordinate_v1.html
@@ -104,4 +104,25 @@
</p>
<p class="firstline">Returns the worker 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/customsearch_v1.html b/docs/dyn/customsearch_v1.html
index 803bdc1..6e0c43b 100644
--- a/docs/dyn/customsearch_v1.html
+++ b/docs/dyn/customsearch_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the cse 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/dataflow_v1b3.html b/docs/dyn/dataflow_v1b3.html
new file mode 100644
index 0000000..ae0f691
--- /dev/null
+++ b/docs/dyn/dataflow_v1b3.html
@@ -0,0 +1,103 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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_v1b3.html">Google Dataflow API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="dataflow_v1b3.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/dataflow_v1b3.projects.html b/docs/dyn/dataflow_v1b3.projects.html
new file mode 100644
index 0000000..7efde1e
--- /dev/null
+++ b/docs/dyn/dataflow_v1b3.projects.html
@@ -0,0 +1,82 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="dataflow_v1b3.html">Google Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="dataflow_v1b3.projects.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/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html
new file mode 100644
index 0000000..59e4c1e
--- /dev/null
+++ b/docs/dyn/dataflow_v1b3.projects.jobs.html
@@ -0,0 +1,1201 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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_v1b3.html">Google Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.jobs.html">jobs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="dataflow_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_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, replaceJobId=None, 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, replaceJobId=None, 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:
+
+{
+ "clientRequestId": "A String",
+ "requestedState": "A String",
+ "name": "A String",
+ "projectId": "A String",
+ "transformNameMapping": {
+ "a_key": "A String",
+ },
+ "id": "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",
+ "network": "A String",
+ "zone": "A String",
+ "onHostMaintenance": "A String",
+ "diskType": "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,
+ "poolArgs": {
+ "a_key": "",
+ },
+ "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",
+ },
+ "replaceJobId": "A String",
+ "steps": [
+ {
+ "kind": "A String",
+ "name": "A String",
+ "properties": {
+ "a_key": "",
+ },
+ },
+ ],
+ "currentStateTime": "A String",
+ "type": "A String",
+ "createTime": "A String",
+ "currentState": "A String",
+ "executionInfo": {
+ "stages": {
+ "a_key": {
+ "stepName": [
+ "A String",
+ ],
+ },
+ },
+ },
+}
+
+ replaceJobId: string, A parameter
+ view: string, A parameter
+ Allowed values
+ JOB_VIEW_ALL -
+ JOB_VIEW_SUMMARY -
+ JOB_VIEW_UNKNOWN -
+
+Returns:
+ An object of the form:
+
+ {
+ "clientRequestId": "A String",
+ "requestedState": "A String",
+ "name": "A String",
+ "projectId": "A String",
+ "transformNameMapping": {
+ "a_key": "A String",
+ },
+ "id": "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",
+ "network": "A String",
+ "zone": "A String",
+ "onHostMaintenance": "A String",
+ "diskType": "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,
+ "poolArgs": {
+ "a_key": "",
+ },
+ "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",
+ },
+ "replaceJobId": "A String",
+ "steps": [
+ {
+ "kind": "A String",
+ "name": "A String",
+ "properties": {
+ "a_key": "",
+ },
+ },
+ ],
+ "currentStateTime": "A String",
+ "type": "A String",
+ "createTime": "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:
+
+ {
+ "clientRequestId": "A String",
+ "requestedState": "A String",
+ "name": "A String",
+ "projectId": "A String",
+ "transformNameMapping": {
+ "a_key": "A String",
+ },
+ "id": "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",
+ "network": "A String",
+ "zone": "A String",
+ "onHostMaintenance": "A String",
+ "diskType": "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,
+ "poolArgs": {
+ "a_key": "",
+ },
+ "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",
+ },
+ "replaceJobId": "A String",
+ "steps": [
+ {
+ "kind": "A String",
+ "name": "A String",
+ "properties": {
+ "a_key": "",
+ },
+ },
+ ],
+ "currentStateTime": "A String",
+ "type": "A String",
+ "createTime": "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": [
+ {
+ "clientRequestId": "A String",
+ "requestedState": "A String",
+ "name": "A String",
+ "projectId": "A String",
+ "transformNameMapping": {
+ "a_key": "A String",
+ },
+ "id": "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",
+ "network": "A String",
+ "zone": "A String",
+ "onHostMaintenance": "A String",
+ "diskType": "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,
+ "poolArgs": {
+ "a_key": "",
+ },
+ "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",
+ },
+ "replaceJobId": "A String",
+ "steps": [
+ {
+ "kind": "A String",
+ "name": "A String",
+ "properties": {
+ "a_key": "",
+ },
+ },
+ ],
+ "currentStateTime": "A String",
+ "type": "A String",
+ "createTime": "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:
+
+{
+ "clientRequestId": "A String",
+ "requestedState": "A String",
+ "name": "A String",
+ "projectId": "A String",
+ "transformNameMapping": {
+ "a_key": "A String",
+ },
+ "id": "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",
+ "network": "A String",
+ "zone": "A String",
+ "onHostMaintenance": "A String",
+ "diskType": "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,
+ "poolArgs": {
+ "a_key": "",
+ },
+ "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",
+ },
+ "replaceJobId": "A String",
+ "steps": [
+ {
+ "kind": "A String",
+ "name": "A String",
+ "properties": {
+ "a_key": "",
+ },
+ },
+ ],
+ "currentStateTime": "A String",
+ "type": "A String",
+ "createTime": "A String",
+ "currentState": "A String",
+ "executionInfo": {
+ "stages": {
+ "a_key": {
+ "stepName": [
+ "A String",
+ ],
+ },
+ },
+ },
+}
+
+
+Returns:
+ An object of the form:
+
+ {
+ "clientRequestId": "A String",
+ "requestedState": "A String",
+ "name": "A String",
+ "projectId": "A String",
+ "transformNameMapping": {
+ "a_key": "A String",
+ },
+ "id": "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",
+ "network": "A String",
+ "zone": "A String",
+ "onHostMaintenance": "A String",
+ "diskType": "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,
+ "poolArgs": {
+ "a_key": "",
+ },
+ "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",
+ },
+ "replaceJobId": "A String",
+ "steps": [
+ {
+ "kind": "A String",
+ "name": "A String",
+ "properties": {
+ "a_key": "",
+ },
+ },
+ ],
+ "currentStateTime": "A String",
+ "type": "A String",
+ "createTime": "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:
+
+{
+ "clientRequestId": "A String",
+ "requestedState": "A String",
+ "name": "A String",
+ "projectId": "A String",
+ "transformNameMapping": {
+ "a_key": "A String",
+ },
+ "id": "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",
+ "network": "A String",
+ "zone": "A String",
+ "onHostMaintenance": "A String",
+ "diskType": "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,
+ "poolArgs": {
+ "a_key": "",
+ },
+ "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",
+ },
+ "replaceJobId": "A String",
+ "steps": [
+ {
+ "kind": "A String",
+ "name": "A String",
+ "properties": {
+ "a_key": "",
+ },
+ },
+ ],
+ "currentStateTime": "A String",
+ "type": "A String",
+ "createTime": "A String",
+ "currentState": "A String",
+ "executionInfo": {
+ "stages": {
+ "a_key": {
+ "stepName": [
+ "A String",
+ ],
+ },
+ },
+ },
+}
+
+
+Returns:
+ An object of the form:
+
+ {
+ "clientRequestId": "A String",
+ "requestedState": "A String",
+ "name": "A String",
+ "projectId": "A String",
+ "transformNameMapping": {
+ "a_key": "A String",
+ },
+ "id": "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",
+ "network": "A String",
+ "zone": "A String",
+ "onHostMaintenance": "A String",
+ "diskType": "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,
+ "poolArgs": {
+ "a_key": "",
+ },
+ "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",
+ },
+ "replaceJobId": "A String",
+ "steps": [
+ {
+ "kind": "A String",
+ "name": "A String",
+ "properties": {
+ "a_key": "",
+ },
+ },
+ ],
+ "currentStateTime": "A String",
+ "type": "A String",
+ "createTime": "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_v1b3.projects.jobs.messages.html b/docs/dyn/dataflow_v1b3.projects.jobs.messages.html
new file mode 100644
index 0000000..becf367
--- /dev/null
+++ b/docs/dyn/dataflow_v1b3.projects.jobs.messages.html
@@ -0,0 +1,134 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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_v1b3.html">Google Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.jobs.html">jobs</a> . <a href="dataflow_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_BASIC -
+ 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_v1b3.projects.jobs.workItems.html b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html
new file mode 100644
index 0000000..198e4c1
--- /dev/null
+++ b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html
@@ -0,0 +1,737 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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_v1b3.html">Google Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.jobs.html">jobs</a> . <a href="dataflow_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": [
+ {
+ "packages": [
+ {
+ "location": "A String",
+ "name": "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",
+ "desiredBundleSizeBytes": "A String",
+ },
+ },
+ },
+ "initialReportIndex": "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,
+ },
+ "valueCombiningFn": {
+ "a_key": "",
+ },
+ "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",
+ "streamingComputationTask": {
+ "taskType": "A String",
+ "computationRanges": [
+ {
+ "rangeAssignments": [
+ {
+ "start": "A String",
+ "end": "A String",
+ "dataDisk": "A String",
+ },
+ ],
+ "computationId": "A String",
+ },
+ ],
+ "dataDisks": [
+ {
+ "dataDisk": "A String",
+ },
+ ],
+ },
+ "reportStatusInterval": "A String",
+ "streamingSetupTask": {
+ "workerHarnessPort": 42,
+ "streamingComputationTopology": {
+ "computations": [
+ {
+ "inputs": [
+ {
+ "streamingStageLocation": {
+ "streamId": "A String",
+ },
+ "pubsubLocation": {
+ "idLabel": "A String",
+ "timestampLabel": "A String",
+ "dropLateData": True or False,
+ "topic": "A String",
+ "trackingSubscription": "A String",
+ "subscription": "A String",
+ },
+ "sideInputLocation": {
+ "tag": "A String",
+ },
+ },
+ ],
+ "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",
+ "timestampLabel": "A String",
+ "dropLateData": True or False,
+ "topic": "A String",
+ "trackingSubscription": "A String",
+ "subscription": "A String",
+ },
+ "sideInputLocation": {
+ "tag": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "dataDiskAssignments": [
+ {
+ "vmInstance": "A String",
+ "dataDisks": [
+ "A String",
+ ],
+ },
+ ],
+ },
+ "receiveWorkPort": 42,
+ },
+ "configuration": "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",
+ "bundles": [
+ {
+ "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,
+ },
+ },
+ },
+ ],
+ "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": {
+ "residualSource": {
+ "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,
+ },
+ },
+ },
+ "primarySource": {
+ "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,
+ },
+ },
+ },
+ "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",
+ "dynamicSourceSplit": {
+ "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,
+ },
+ },
+ },
+ },
+ "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": [
+ {
+ "reportStatusInterval": "A String",
+ "suggestedStopPosition": {
+ "recordIndex": "A String",
+ "end": True or False,
+ "byteOffset": "A String",
+ "key": "A String",
+ "shufflePosition": "A String",
+ },
+ "leaseExpireTime": "A String",
+ "nextReportIndex": "A String",
+ "harnessData": {
+ "a_key": "",
+ },
+ "suggestedStopPoint": {
+ "position": {
+ "recordIndex": "A String",
+ "end": True or False,
+ "byteOffset": "A String",
+ "key": "A String",
+ "shufflePosition": "A String",
+ },
+ "remainingTime": "A String",
+ "percentComplete": 3.14,
+ },
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/datastore_v1beta2.datasets.html b/docs/dyn/datastore_v1beta2.datasets.html
index 0fc6ce4..62c2ae0 100644
--- a/docs/dyn/datastore_v1beta2.datasets.html
+++ b/docs/dyn/datastore_v1beta2.datasets.html
@@ -219,12 +219,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
{ # 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.
@@ -248,12 +248,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
# Object with schema name: Value
],
"booleanValue": True or False, # A boolean value.
@@ -312,12 +312,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
{ # 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.
@@ -341,12 +341,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
# Object with schema name: Value
],
"booleanValue": True or False, # A boolean value.
@@ -404,12 +404,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
{ # 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.
@@ -433,12 +433,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
# Object with schema name: Value
],
"booleanValue": True or False, # A boolean value.
@@ -515,12 +515,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
{ # 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.
@@ -544,12 +544,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
# Object with schema name: Value
],
"booleanValue": True or False, # A boolean value.
@@ -703,12 +703,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
{ # 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.
@@ -732,12 +732,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
# Object with schema name: Value
],
"booleanValue": True or False, # A boolean value.
@@ -800,12 +800,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
{ # 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.
@@ -829,12 +829,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
# Object with schema name: Value
],
"booleanValue": True or False, # A boolean value.
@@ -962,12 +962,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
# Object with schema name: Value
],
"booleanValue": True or False, # A boolean value.
@@ -1019,12 +1019,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
# Object with schema name: Value
],
"booleanValue": True or False, # A boolean value.
@@ -1060,12 +1060,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
# Object with schema name: Value
],
"booleanValue": True or False, # A boolean value.
@@ -1117,12 +1117,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
{ # 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.
@@ -1146,12 +1146,12 @@
"datasetId": "A String", # The dataset ID.
},
},
- "stringValue": "A String", # A UTF-8 encoded string value.
+ "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.
- "listValue": [ # A list value. Cannot contain another list value. Cannot also have a meaning and indexing set.
+ "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.
+ "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
# Object with schema name: Value
],
"booleanValue": True or False, # A boolean value.
diff --git a/docs/dyn/datastore_v1beta2.html b/docs/dyn/datastore_v1beta2.html
index d170eda..5744916 100644
--- a/docs/dyn/datastore_v1beta2.html
+++ b/docs/dyn/datastore_v1beta2.html
@@ -79,4 +79,25 @@
</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>
+<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/deploymentmanager_v2beta2.deployments.html b/docs/dyn/deploymentmanager_v2beta2.deployments.html
new file mode 100644
index 0000000..59e3a56
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta2.deployments.html
@@ -0,0 +1,575 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.html b/docs/dyn/deploymentmanager_v2beta2.html
new file mode 100644
index 0000000..3ea91f9
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta2.html
@@ -0,0 +1,123 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta2.deployments.html">deployments()</a></code>
+</p>
+<p class="firstline">Returns the deployments Resource.</p>
+
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta2.manifests.html">manifests()</a></code>
+</p>
+<p class="firstline">Returns the manifests Resource.</p>
+
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta2.operations.html">operations()</a></code>
+</p>
+<p class="firstline">Returns the operations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta2.resources.html">resources()</a></code>
+</p>
+<p class="firstline">Returns the resources Resource.</p>
+
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta2.types.html">types()</a></code>
+</p>
+<p class="firstline">Returns the types 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/deploymentmanager_v2beta2.manifests.html b/docs/dyn/deploymentmanager_v2beta2.manifests.html
new file mode 100644
index 0000000..f693dd5
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta2.manifests.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="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
new file mode 100644
index 0000000..546dafc
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta2.operations.html
@@ -0,0 +1,220 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="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
new file mode 100644
index 0000000..e98adf2
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta2.resources.html
@@ -0,0 +1,178 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..7613be0
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta2.types.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="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_v2_1.accountActiveAdSummaries.html b/docs/dyn/dfareporting_v2_1.accountActiveAdSummaries.html
new file mode 100644
index 0000000..5436386
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.accountActiveAdSummaries.html
@@ -0,0 +1,101 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.accountPermissionGroups.html b/docs/dyn/dfareporting_v2_1.accountPermissionGroups.html
new file mode 100644
index 0000000..df69894
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.accountPermissionGroups.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.accountPermissions.html b/docs/dyn/dfareporting_v2_1.accountPermissions.html
new file mode 100644
index 0000000..3023d49
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.accountPermissions.html
@@ -0,0 +1,142 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.accountUserProfiles.html b/docs/dyn/dfareporting_v2_1.accountUserProfiles.html
new file mode 100644
index 0000000..5df4535
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.accountUserProfiles.html
@@ -0,0 +1,677 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.accounts.html b/docs/dyn/dfareporting_v2_1.accounts.html
new file mode 100644
index 0000000..c10f5bb
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.accounts.html
@@ -0,0 +1,790 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..9132d66
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.ads.html
@@ -0,0 +1,2735 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.advertiserGroups.html b/docs/dyn/dfareporting_v2_1.advertiserGroups.html
new file mode 100644
index 0000000..247626e
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.advertiserGroups.html
@@ -0,0 +1,263 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.advertisers.html b/docs/dyn/dfareporting_v2_1.advertisers.html
new file mode 100644
index 0000000..0db0e4c
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.advertisers.html
@@ -0,0 +1,467 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.browsers.html b/docs/dyn/dfareporting_v2_1.browsers.html
new file mode 100644
index 0000000..1d56d3b
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.browsers.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.campaignCreativeAssociations.html b/docs/dyn/dfareporting_v2_1.campaignCreativeAssociations.html
new file mode 100644
index 0000000..2756579
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.campaignCreativeAssociations.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="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
new file mode 100644
index 0000000..6dc1981
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.campaigns.html
@@ -0,0 +1,1139 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..03708e3
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.changeLogs.html
@@ -0,0 +1,228 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.cities.html b/docs/dyn/dfareporting_v2_1.cities.html
new file mode 100644
index 0000000..71a2cd5
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.cities.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.connectionTypes.html b/docs/dyn/dfareporting_v2_1.connectionTypes.html
new file mode 100644
index 0000000..261afbb
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.connectionTypes.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="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.contentCategories.html b/docs/dyn/dfareporting_v2_1.contentCategories.html
new file mode 100644
index 0000000..d69a3c7
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.contentCategories.html
@@ -0,0 +1,263 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.countries.html b/docs/dyn/dfareporting_v2_1.countries.html
new file mode 100644
index 0000000..3b354df
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.countries.html
@@ -0,0 +1,128 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.creativeAssets.html b/docs/dyn/dfareporting_v2_1.creativeAssets.html
new file mode 100644
index 0000000..906e7da
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.creativeAssets.html
@@ -0,0 +1,185 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.creativeFieldValues.html b/docs/dyn/dfareporting_v2_1.creativeFieldValues.html
new file mode 100644
index 0000000..7292408
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.creativeFieldValues.html
@@ -0,0 +1,261 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.creativeFields.html b/docs/dyn/dfareporting_v2_1.creativeFields.html
new file mode 100644
index 0000000..3e54352
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.creativeFields.html
@@ -0,0 +1,344 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.creativeGroups.html b/docs/dyn/dfareporting_v2_1.creativeGroups.html
new file mode 100644
index 0000000..428e284
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.creativeGroups.html
@@ -0,0 +1,364 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.creatives.html b/docs/dyn/dfareporting_v2_1.creatives.html
new file mode 100644
index 0000000..975e39f
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.creatives.html
@@ -0,0 +1,2876 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..2d9bbdc
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.dimensionValues.html
@@ -0,0 +1,144 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="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
new file mode 100644
index 0000000..13ae8d6
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.directorySiteContacts.html
@@ -0,0 +1,169 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..3877160
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.directorySites.html
@@ -0,0 +1,546 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..4a4c433
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.eventTags.html
@@ -0,0 +1,485 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..54aa8d2
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.files.html
@@ -0,0 +1,205 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..e9b3302
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.floodlightActivities.html
@@ -0,0 +1,1045 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..7668dd0
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.floodlightActivityGroups.html
@@ -0,0 +1,501 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..2ec6656
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.floodlightConfigurations.html
@@ -0,0 +1,478 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..6a19351
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.html
@@ -0,0 +1,373 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.inventoryItems.html b/docs/dyn/dfareporting_v2_1.inventoryItems.html
new file mode 100644
index 0000000..f6e988c
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.inventoryItems.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.landingPages.html b/docs/dyn/dfareporting_v2_1.landingPages.html
new file mode 100644
index 0000000..63c9f58
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.landingPages.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.metros.html b/docs/dyn/dfareporting_v2_1.metros.html
new file mode 100644
index 0000000..ede4677
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.metros.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.mobileCarriers.html b/docs/dyn/dfareporting_v2_1.mobileCarriers.html
new file mode 100644
index 0000000..7bfa5f0
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.mobileCarriers.html
@@ -0,0 +1,128 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.operatingSystemVersions.html b/docs/dyn/dfareporting_v2_1.operatingSystemVersions.html
new file mode 100644
index 0000000..4963c6c
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.operatingSystemVersions.html
@@ -0,0 +1,142 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.operatingSystems.html b/docs/dyn/dfareporting_v2_1.operatingSystems.html
new file mode 100644
index 0000000..d29eb2a
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.operatingSystems.html
@@ -0,0 +1,128 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.orderDocuments.html b/docs/dyn/dfareporting_v2_1.orderDocuments.html
new file mode 100644
index 0000000..eba644d
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.orderDocuments.html
@@ -0,0 +1,191 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..26f1d70
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.orders.html
@@ -0,0 +1,223 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..9b7e243
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.placementGroups.html
@@ -0,0 +1,1068 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.placementStrategies.html b/docs/dyn/dfareporting_v2_1.placementStrategies.html
new file mode 100644
index 0000000..c1229b1
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.placementStrategies.html
@@ -0,0 +1,263 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.placements.html b/docs/dyn/dfareporting_v2_1.placements.html
new file mode 100644
index 0000000..8b79450
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.placements.html
@@ -0,0 +1,1350 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.platformTypes.html b/docs/dyn/dfareporting_v2_1.platformTypes.html
new file mode 100644
index 0000000..2969f3b
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.platformTypes.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.postalCodes.html b/docs/dyn/dfareporting_v2_1.postalCodes.html
new file mode 100644
index 0000000..fb2fb2b
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.postalCodes.html
@@ -0,0 +1,128 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.projects.html b/docs/dyn/dfareporting_v2_1.projects.html
new file mode 100644
index 0000000..69fa5dd
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.projects.html
@@ -0,0 +1,195 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.regions.html b/docs/dyn/dfareporting_v2_1.regions.html
new file mode 100644
index 0000000..b0e9f5d
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.regions.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="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.remarketingListShares.html b/docs/dyn/dfareporting_v2_1.remarketingListShares.html
new file mode 100644
index 0000000..942e5b3
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.remarketingListShares.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.remarketingLists.html b/docs/dyn/dfareporting_v2_1.remarketingLists.html
new file mode 100644
index 0000000..6c2462b
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.remarketingLists.html
@@ -0,0 +1,532 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..f35e447
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.reports.compatibleFields.html
@@ -0,0 +1,551 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..e649452
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.reports.files.html
@@ -0,0 +1,203 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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
new file mode 100644
index 0000000..753e53b
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.reports.html
@@ -0,0 +1,2795 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.sites.html b/docs/dyn/dfareporting_v2_1.sites.html
new file mode 100644
index 0000000..9559f52
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.sites.html
@@ -0,0 +1,667 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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_1.sizes.html b/docs/dyn/dfareporting_v2_1.sizes.html
new file mode 100644
index 0000000..4c01d7e
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.sizes.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="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
new file mode 100644
index 0000000..f6268ea
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.subaccounts.html
@@ -0,0 +1,274 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="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
new file mode 100644
index 0000000..9e2dc9d
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.targetableRemarketingLists.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="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_1.userProfiles.html b/docs/dyn/dfareporting_v2_1.userProfiles.html
new file mode 100644
index 0000000..0e0c800
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.userProfiles.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.userRolePermissionGroups.html b/docs/dyn/dfareporting_v2_1.userRolePermissionGroups.html
new file mode 100644
index 0000000..d159bc6
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.userRolePermissionGroups.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.userRolePermissions.html b/docs/dyn/dfareporting_v2_1.userRolePermissions.html
new file mode 100644
index 0000000..e473beb
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.userRolePermissions.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="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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_1.userRoles.html b/docs/dyn/dfareporting_v2_1.userRoles.html
new file mode 100644
index 0000000..06e4a93
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_1.userRoles.html
@@ -0,0 +1,361 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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.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/discovery_v1.apis.html b/docs/dyn/discovery_v1.apis.html
index 57d39b3..5fbd0cf 100644
--- a/docs/dyn/discovery_v1.apis.html
+++ b/docs/dyn/discovery_v1.apis.html
@@ -173,6 +173,7 @@
"A String",
],
"path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
+ "useMediaDownloadService": True or False, # Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.
"id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
"supportsMediaDownload": True or False, # Whether this method supports media downloads.
},
@@ -361,6 +362,7 @@
"A String",
],
"path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
+ "useMediaDownloadService": True or False, # Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.
"id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
"supportsMediaDownload": True or False, # Whether this method supports media downloads.
},
diff --git a/docs/dyn/discovery_v1.html b/docs/dyn/discovery_v1.html
index e4ac00f..95d8aab 100644
--- a/docs/dyn/discovery_v1.html
+++ b/docs/dyn/discovery_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the apis 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/dns_v1.changes.html b/docs/dyn/dns_v1.changes.html
new file mode 100644
index 0000000..9645211
--- /dev/null
+++ b/docs/dyn/dns_v1.changes.html
@@ -0,0 +1,274 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="dns_v1.html">Google Cloud DNS API</a> . <a href="dns_v1.changes.html">changes</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(project, managedZone, body)</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>
+<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>
+<p class="firstline">Enumerate Changes 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="create">create(project, managedZone, body)</code>
+ <pre>Atomically update the 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)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # 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).
+ "A String",
+ ],
+ "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "name": "A String", # For example, www.example.com.
+ "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ },
+ ],
+ "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.
+ "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).
+ "A String",
+ ],
+ "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "name": "A String", # For example, www.example.com.
+ "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # 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).
+ "A String",
+ ],
+ "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "name": "A String", # For example, www.example.com.
+ "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ },
+ ],
+ "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.
+ "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).
+ "A String",
+ ],
+ "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "name": "A String", # For example, www.example.com.
+ "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, managedZone, changeId)</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)
+
+Returns:
+ An object of the form:
+
+ { # 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).
+ "A String",
+ ],
+ "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "name": "A String", # For example, www.example.com.
+ "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ },
+ ],
+ "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.
+ "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).
+ "A String",
+ ],
+ "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "name": "A String", # For example, www.example.com.
+ "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None)</code>
+ <pre>Enumerate Changes 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.
+ 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 -
+ sortOrder: string, Sorting order direction: 'ascending' or 'descending'.
+
+Returns:
+ An object of the form:
+
+ { # The response to a request to enumerate Changes to a ResourceRecordSets collection.
+ "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.
+ "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).
+ "A String",
+ ],
+ "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "name": "A String", # For example, www.example.com.
+ "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ },
+ ],
+ "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.
+ "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).
+ "A String",
+ ],
+ "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "name": "A String", # For example, www.example.com.
+ "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (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_v1.html b/docs/dyn/dns_v1.html
new file mode 100644
index 0000000..c4ee821
--- /dev/null
+++ b/docs/dyn/dns_v1.html
@@ -0,0 +1,118 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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_v1.html">Google Cloud DNS API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="dns_v1.changes.html">changes()</a></code>
+</p>
+<p class="firstline">Returns the changes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dns_v1.managedZones.html">managedZones()</a></code>
+</p>
+<p class="firstline">Returns the managedZones Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dns_v1.projects.html">projects()</a></code>
+</p>
+<p class="firstline">Returns the projects Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dns_v1.resourceRecordSets.html">resourceRecordSets()</a></code>
+</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>
+<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/dns_v1.managedZones.html b/docs/dyn/dns_v1.managedZones.html
new file mode 100644
index 0000000..2e94f50
--- /dev/null
+++ b/docs/dyn/dns_v1.managedZones.html
@@ -0,0 +1,216 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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_v1.html">Google Cloud DNS API</a> . <a href="dns_v1.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_v1.projects.html b/docs/dyn/dns_v1.projects.html
new file mode 100644
index 0000000..ac1675b
--- /dev/null
+++ b/docs/dyn/dns_v1.projects.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="dns_v1.html">Google Cloud DNS API</a> . <a href="dns_v1.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">Fetch the representation of an existing Project.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(project)</code>
+ <pre>Fetch the representation of an existing Project.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.
+ "quota": { # Limits associated with a Project. # Quotas assigned to this project (output only).
+ "kind": "dns#quota", # Identifies what kind of resource this is. Value: the fixed string "dns#quota".
+ "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.
+ "rrsetsPerManagedZone": 42, # Maximum allowed number of ResourceRecordSets per zone in the project.
+ "rrsetDeletionsPerChange": 42, # Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest.
+ "managedZones": 42, # Maximum allowed number of managed zones in the project.
+ },
+ "kind": "dns#project", # Identifies what kind of resource this is. Value: the fixed string "dns#project".
+ "id": "A String", # User assigned unique identifier for the resource (output only).
+ "number": "A String", # Unique numeric identifier for the resource; defined by the server (output only).
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dns_v1.resourceRecordSets.html b/docs/dyn/dns_v1.resourceRecordSets.html
new file mode 100644
index 0000000..3cfb204
--- /dev/null
+++ b/docs/dyn/dns_v1.resourceRecordSets.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="dns_v1.html">Google Cloud DNS API</a> . <a href="dns_v1.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>
+<p class="firstline">Enumerate ResourceRecordSets 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="list">list(project, managedZone, name=None, pageToken=None, maxResults=None, type=None)</code>
+ <pre>Enumerate ResourceRecordSets that have been created but not yet deleted.
+
+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)
+ name: string, Restricts the list to return only records with this fully qualified domain name.
+ 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.
+ type: string, Restricts the list to return only records of this type. If present, the "name" parameter must also be present.
+
+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 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.
+ "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).
+ "A String",
+ ],
+ "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "name": "A String", # For example, www.example.com.
+ "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ },
+ ],
+ "kind": "dns#resourceRecordSetsListResponse", # 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/doubleclickbidmanager_v1.html b/docs/dyn/doubleclickbidmanager_v1.html
index db1129a..1774cd0 100644
--- a/docs/dyn/doubleclickbidmanager_v1.html
+++ b/docs/dyn/doubleclickbidmanager_v1.html
@@ -89,4 +89,25 @@
</p>
<p class="firstline">Returns the reports 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/doubleclicksearch_v2.conversion.html b/docs/dyn/doubleclicksearch_v2.conversion.html
index bda7540..da35cfb 100644
--- a/docs/dyn/doubleclicksearch_v2.conversion.html
+++ b/docs/dyn/doubleclicksearch_v2.conversion.html
@@ -120,21 +120,27 @@
},
],
"adGroupId": "A String", # DS ad group ID.
- "attributionModel": "A String", # Attribution model name.
+ "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "attributionModel": "A String", # Attribution model name. This field is ignored.
"campaignId": "A String", # DS campaign ID.
"revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
"advertiserId": "A String", # DS advertiser ID.
- "countMillis": "A String", # Conversion count in millis.
+ "countMillis": "A String", # The number of conversions, formatted in millis (conversions multiplied by 1000). This field is ignored.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"clickId": "A String", # DS click ID for the conversion.
"dsConversionId": "A String", # DS conversion ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
+ "productCountry": "A String", # ISO 3166 code of the product country.
"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
+ "deviceType": "A String", # The type of device on which the conversion occurred. Valid values are "DESKTOP", "TABLET", "HIGH_END_MOBILE", "OTHER_DEVICE".
"adId": "A String", # DS ad ID.
"conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
+ "channel": "A String", # Channel of the product: local or online.
+ "productId": "A String", # The product ID (SKU).
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"agencyId": "A String", # DS agency ID.
+ "storeId": "A String", # The store id for which the product was advertised, when the channel is "local".
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"criterionId": "A String", # DS criterion (keyword) ID.
"floodlightOrderId": "A String", # The advertiser-provided order id for the conversion.
@@ -147,7 +153,9 @@
],
"engineAccountId": "A String", # DS engine account ID.
"type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
- "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "productGroupId": "A String", # DS product group ID.
+ "feedId": "A String", # DS inventory feed ID.
+ "productLanguage": "A String", # ISO 639 code of the product language.
},
],
"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
@@ -172,21 +180,27 @@
},
],
"adGroupId": "A String", # DS ad group ID.
- "attributionModel": "A String", # Attribution model name.
+ "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "attributionModel": "A String", # Attribution model name. This field is ignored.
"campaignId": "A String", # DS campaign ID.
"revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
"advertiserId": "A String", # DS advertiser ID.
- "countMillis": "A String", # Conversion count in millis.
+ "countMillis": "A String", # The number of conversions, formatted in millis (conversions multiplied by 1000). This field is ignored.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"clickId": "A String", # DS click ID for the conversion.
"dsConversionId": "A String", # DS conversion ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
+ "productCountry": "A String", # ISO 3166 code of the product country.
"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
+ "deviceType": "A String", # The type of device on which the conversion occurred. Valid values are "DESKTOP", "TABLET", "HIGH_END_MOBILE", "OTHER_DEVICE".
"adId": "A String", # DS ad ID.
"conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
+ "channel": "A String", # Channel of the product: local or online.
+ "productId": "A String", # The product ID (SKU).
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"agencyId": "A String", # DS agency ID.
+ "storeId": "A String", # The store id for which the product was advertised, when the channel is "local".
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"criterionId": "A String", # DS criterion (keyword) ID.
"floodlightOrderId": "A String", # The advertiser-provided order id for the conversion.
@@ -199,7 +213,9 @@
],
"engineAccountId": "A String", # DS engine account ID.
"type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
- "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "productGroupId": "A String", # DS product group ID.
+ "feedId": "A String", # DS inventory feed ID.
+ "productLanguage": "A String", # ISO 639 code of the product language.
},
],
"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
@@ -219,21 +235,27 @@
},
],
"adGroupId": "A String", # DS ad group ID.
- "attributionModel": "A String", # Attribution model name.
+ "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "attributionModel": "A String", # Attribution model name. This field is ignored.
"campaignId": "A String", # DS campaign ID.
"revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
"advertiserId": "A String", # DS advertiser ID.
- "countMillis": "A String", # Conversion count in millis.
+ "countMillis": "A String", # The number of conversions, formatted in millis (conversions multiplied by 1000). This field is ignored.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"clickId": "A String", # DS click ID for the conversion.
"dsConversionId": "A String", # DS conversion ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
+ "productCountry": "A String", # ISO 3166 code of the product country.
"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
+ "deviceType": "A String", # The type of device on which the conversion occurred. Valid values are "DESKTOP", "TABLET", "HIGH_END_MOBILE", "OTHER_DEVICE".
"adId": "A String", # DS ad ID.
"conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
+ "channel": "A String", # Channel of the product: local or online.
+ "productId": "A String", # The product ID (SKU).
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"agencyId": "A String", # DS agency ID.
+ "storeId": "A String", # The store id for which the product was advertised, when the channel is "local".
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"criterionId": "A String", # DS criterion (keyword) ID.
"floodlightOrderId": "A String", # The advertiser-provided order id for the conversion.
@@ -246,7 +268,9 @@
],
"engineAccountId": "A String", # DS engine account ID.
"type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
- "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "productGroupId": "A String", # DS product group ID.
+ "feedId": "A String", # DS inventory feed ID.
+ "productLanguage": "A String", # ISO 639 code of the product language.
},
],
"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
@@ -278,21 +302,27 @@
},
],
"adGroupId": "A String", # DS ad group ID.
- "attributionModel": "A String", # Attribution model name.
+ "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "attributionModel": "A String", # Attribution model name. This field is ignored.
"campaignId": "A String", # DS campaign ID.
"revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
"advertiserId": "A String", # DS advertiser ID.
- "countMillis": "A String", # Conversion count in millis.
+ "countMillis": "A String", # The number of conversions, formatted in millis (conversions multiplied by 1000). This field is ignored.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"clickId": "A String", # DS click ID for the conversion.
"dsConversionId": "A String", # DS conversion ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
+ "productCountry": "A String", # ISO 3166 code of the product country.
"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
+ "deviceType": "A String", # The type of device on which the conversion occurred. Valid values are "DESKTOP", "TABLET", "HIGH_END_MOBILE", "OTHER_DEVICE".
"adId": "A String", # DS ad ID.
"conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
+ "channel": "A String", # Channel of the product: local or online.
+ "productId": "A String", # The product ID (SKU).
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"agencyId": "A String", # DS agency ID.
+ "storeId": "A String", # The store id for which the product was advertised, when the channel is "local".
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"criterionId": "A String", # DS criterion (keyword) ID.
"floodlightOrderId": "A String", # The advertiser-provided order id for the conversion.
@@ -305,7 +335,9 @@
],
"engineAccountId": "A String", # DS engine account ID.
"type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
- "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "productGroupId": "A String", # DS product group ID.
+ "feedId": "A String", # DS inventory feed ID.
+ "productLanguage": "A String", # ISO 639 code of the product language.
},
],
"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
@@ -325,21 +357,27 @@
},
],
"adGroupId": "A String", # DS ad group ID.
- "attributionModel": "A String", # Attribution model name.
+ "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "attributionModel": "A String", # Attribution model name. This field is ignored.
"campaignId": "A String", # DS campaign ID.
"revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
"advertiserId": "A String", # DS advertiser ID.
- "countMillis": "A String", # Conversion count in millis.
+ "countMillis": "A String", # The number of conversions, formatted in millis (conversions multiplied by 1000). This field is ignored.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"clickId": "A String", # DS click ID for the conversion.
"dsConversionId": "A String", # DS conversion ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
+ "productCountry": "A String", # ISO 3166 code of the product country.
"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
+ "deviceType": "A String", # The type of device on which the conversion occurred. Valid values are "DESKTOP", "TABLET", "HIGH_END_MOBILE", "OTHER_DEVICE".
"adId": "A String", # DS ad ID.
"conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
+ "channel": "A String", # Channel of the product: local or online.
+ "productId": "A String", # The product ID (SKU).
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"agencyId": "A String", # DS agency ID.
+ "storeId": "A String", # The store id for which the product was advertised, when the channel is "local".
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"criterionId": "A String", # DS criterion (keyword) ID.
"floodlightOrderId": "A String", # The advertiser-provided order id for the conversion.
@@ -352,7 +390,9 @@
],
"engineAccountId": "A String", # DS engine account ID.
"type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
- "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "productGroupId": "A String", # DS product group ID.
+ "feedId": "A String", # DS inventory feed ID.
+ "productLanguage": "A String", # ISO 639 code of the product language.
},
],
"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
@@ -377,21 +417,27 @@
},
],
"adGroupId": "A String", # DS ad group ID.
- "attributionModel": "A String", # Attribution model name.
+ "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "attributionModel": "A String", # Attribution model name. This field is ignored.
"campaignId": "A String", # DS campaign ID.
"revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
"advertiserId": "A String", # DS advertiser ID.
- "countMillis": "A String", # Conversion count in millis.
+ "countMillis": "A String", # The number of conversions, formatted in millis (conversions multiplied by 1000). This field is ignored.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"clickId": "A String", # DS click ID for the conversion.
"dsConversionId": "A String", # DS conversion ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
+ "productCountry": "A String", # ISO 3166 code of the product country.
"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
+ "deviceType": "A String", # The type of device on which the conversion occurred. Valid values are "DESKTOP", "TABLET", "HIGH_END_MOBILE", "OTHER_DEVICE".
"adId": "A String", # DS ad ID.
"conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
+ "channel": "A String", # Channel of the product: local or online.
+ "productId": "A String", # The product ID (SKU).
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"agencyId": "A String", # DS agency ID.
+ "storeId": "A String", # The store id for which the product was advertised, when the channel is "local".
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"criterionId": "A String", # DS criterion (keyword) ID.
"floodlightOrderId": "A String", # The advertiser-provided order id for the conversion.
@@ -404,7 +450,9 @@
],
"engineAccountId": "A String", # DS engine account ID.
"type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
- "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "productGroupId": "A String", # DS product group ID.
+ "feedId": "A String", # DS inventory feed ID.
+ "productLanguage": "A String", # ISO 639 code of the product language.
},
],
"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
@@ -424,21 +472,27 @@
},
],
"adGroupId": "A String", # DS ad group ID.
- "attributionModel": "A String", # Attribution model name.
+ "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "attributionModel": "A String", # Attribution model name. This field is ignored.
"campaignId": "A String", # DS campaign ID.
"revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
"advertiserId": "A String", # DS advertiser ID.
- "countMillis": "A String", # Conversion count in millis.
+ "countMillis": "A String", # The number of conversions, formatted in millis (conversions multiplied by 1000). This field is ignored.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"clickId": "A String", # DS click ID for the conversion.
"dsConversionId": "A String", # DS conversion ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
+ "productCountry": "A String", # ISO 3166 code of the product country.
"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
+ "deviceType": "A String", # The type of device on which the conversion occurred. Valid values are "DESKTOP", "TABLET", "HIGH_END_MOBILE", "OTHER_DEVICE".
"adId": "A String", # DS ad ID.
"conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
+ "channel": "A String", # Channel of the product: local or online.
+ "productId": "A String", # The product ID (SKU).
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"agencyId": "A String", # DS agency ID.
+ "storeId": "A String", # The store id for which the product was advertised, when the channel is "local".
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"criterionId": "A String", # DS criterion (keyword) ID.
"floodlightOrderId": "A String", # The advertiser-provided order id for the conversion.
@@ -451,7 +505,9 @@
],
"engineAccountId": "A String", # DS engine account ID.
"type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
- "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
+ "productGroupId": "A String", # DS product group ID.
+ "feedId": "A String", # DS inventory feed ID.
+ "productLanguage": "A String", # ISO 639 code of the product language.
},
],
"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
diff --git a/docs/dyn/doubleclicksearch_v2.html b/docs/dyn/doubleclicksearch_v2.html
index 02fd66d..0d12b9a 100644
--- a/docs/dyn/doubleclicksearch_v2.html
+++ b/docs/dyn/doubleclicksearch_v2.html
@@ -89,4 +89,25 @@
</p>
<p class="firstline">Returns the savedColumns 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/doubleclicksearch_v2.reports.html b/docs/dyn/doubleclicksearch_v2.reports.html
index 46ed40a..fcb7a39 100644
--- a/docs/dyn/doubleclicksearch_v2.reports.html
+++ b/docs/dyn/doubleclicksearch_v2.reports.html
@@ -82,10 +82,10 @@
<p class="firstline">Polls for the status of a report request.</p>
<p class="toc_element">
<code><a href="#getFile">getFile(reportId, reportFragment)</a></code></p>
-<p class="firstline">Downloads a report file.</p>
+<p class="firstline">Downloads a report file encoded in UTF-8.</p>
<p class="toc_element">
<code><a href="#getFile_media">getFile_media(reportId, reportFragment)</a></code></p>
-<p class="firstline">Downloads a report file.</p>
+<p class="firstline">Downloads a report file encoded in UTF-8.</p>
<p class="toc_element">
<code><a href="#request">request(body)</a></code></p>
<p class="firstline">Inserts a report request into the reporting system.</p>
@@ -388,7 +388,7 @@
<div class="method">
<code class="details" id="getFile">getFile(reportId, reportFragment)</code>
- <pre>Downloads a report file.
+ <pre>Downloads a report file encoded in UTF-8.
Args:
reportId: string, ID of the report. (required)
@@ -398,7 +398,7 @@
<div class="method">
<code class="details" id="getFile_media">getFile_media(reportId, reportFragment)</code>
- <pre>Downloads a report file.
+ <pre>Downloads a report file encoded in UTF-8.
Args:
reportId: string, ID of the report. (required)
diff --git a/docs/dyn/drive_v2.about.html b/docs/dyn/drive_v2.about.html
index 8be3517..a2ce314 100644
--- a/docs/dyn/drive_v2.about.html
+++ b/docs/dyn/drive_v2.about.html
@@ -112,7 +112,11 @@
"etag": "A String", # The ETag of the item.
"largestChangeId": "A String", # The largest change id.
"quotaBytesUsedInTrash": "A String", # The number of quota bytes used by trashed items.
- "domainSharingPolicy": "A String", # The domain sharing policy for the current user.
+ "domainSharingPolicy": "A String", # The domain sharing policy for the current user. Possible values are:
+ # - ALLOWED
+ # - ALLOWED_WITH_WARNING
+ # - INCOMING_ONLY
+ # - DISALLOWED
"isCurrentAppInstalled": True or False, # A boolean indicating whether the authenticated app is installed by the authenticated user.
"additionalRoleInfo": [ # Information about supported additional roles per file type. The most specific type takes precedence.
{
diff --git a/docs/dyn/drive_v2.apps.html b/docs/dyn/drive_v2.apps.html
index 5777e69..8101889 100644
--- a/docs/dyn/drive_v2.apps.html
+++ b/docs/dyn/drive_v2.apps.html
@@ -119,7 +119,7 @@
},
],
"authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
- "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids.
+ "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation.
"productId": "A String", # The ID of the product listing for this app.
"longDescription": "A String", # A long description of the app.
"supportsCreate": True or False, # Whether this app supports creating new objects.
@@ -178,7 +178,7 @@
},
],
"authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
- "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids.
+ "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation.
"productId": "A String", # The ID of the product listing for this app.
"longDescription": "A String", # A long description of the app.
"supportsCreate": True or False, # Whether this app supports creating new objects.
diff --git a/docs/dyn/drive_v2.changes.html b/docs/dyn/drive_v2.changes.html
index 4557d70..b2a3d06 100644
--- a/docs/dyn/drive_v2.changes.html
+++ b/docs/dyn/drive_v2.changes.html
@@ -78,13 +78,13 @@
<code><a href="#get">get(changeId)</a></code></p>
<p class="firstline">Gets a specific change.</p>
<p class="toc_element">
- <code><a href="#list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</a></code></p>
+ <code><a href="#list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None, spaces=None)</a></code></p>
<p class="firstline">Lists the changes for a 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="#watch">watch(body, includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</a></code></p>
+ <code><a href="#watch">watch(body, includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None, spaces=None)</a></code></p>
<p class="firstline">Subscribe to changes for a user.</p>
<h3>Method Details</h3>
<div class="method">
@@ -105,13 +105,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -208,7 +208,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -249,7 +249,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -291,6 +296,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -305,7 +313,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</code>
+ <code class="details" id="list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None, spaces=None)</code>
<pre>Lists the changes for a user.
Args:
@@ -314,6 +322,7 @@
pageToken: string, Page token for changes.
maxResults: integer, Maximum number of changes to return.
startChangeId: string, Change ID to start listing changes from.
+ spaces: string, A comma-separated list of spaces to query. Supported values are 'drive' and 'appDataFolder'.
Returns:
An object of the form:
@@ -330,13 +339,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -433,7 +442,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -474,7 +483,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -516,6 +530,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -550,7 +567,7 @@
</div>
<div class="method">
- <code class="details" id="watch">watch(body, includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</code>
+ <code class="details" id="watch">watch(body, includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None, spaces=None)</code>
<pre>Subscribe to changes for a user.
Args:
@@ -577,6 +594,7 @@
pageToken: string, Page token for changes.
maxResults: integer, Maximum number of changes to return.
startChangeId: string, Change ID to start listing changes from.
+ spaces: string, A comma-separated list of spaces to query. Supported values are 'drive' and 'appDataFolder'.
Returns:
An object of the form:
diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html
index 84af4ee..a931d37 100644
--- a/docs/dyn/drive_v2.files.html
+++ b/docs/dyn/drive_v2.files.html
@@ -79,21 +79,21 @@
<p class="firstline">Creates a copy of the specified file.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId)</a></code></p>
-<p class="firstline">Permanently deletes a file by ID. Skips the trash.</p>
+<p class="firstline">Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file.</p>
<p class="toc_element">
<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="#get">get(fileId, projection=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
+ <code><a href="#get">get(fileId, projection=None, revisionId=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
<p class="firstline">Gets a file's metadata by ID.</p>
<p class="toc_element">
- <code><a href="#get_media">get_media(fileId, projection=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
+ <code><a href="#get_media">get_media(fileId, projection=None, revisionId=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
<p class="firstline">Gets a file's metadata by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, media_body=None, convert=None, useContentAsIndexableText=None, visibility=None, ocrLanguage=None, ocr=None, timedTextLanguage=None, timedTextTrackName=None, pinned=None)</a></code></p>
<p class="firstline">Insert a new file.</p>
<p class="toc_element">
- <code><a href="#list">list(q=None, projection=None, pageToken=None, maxResults=None, corpus=None)</a></code></p>
+ <code><a href="#list">list(q=None, projection=None, pageToken=None, maxResults=None, spaces=None, corpus=None)</a></code></p>
<p class="firstline">Lists the user's files.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -114,10 +114,10 @@
<code><a href="#update">update(fileId, body=None, newRevision=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, addParents=None, removeParents=None, updateViewedDate=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, setModifiedDate=None, timedTextLanguage=None)</a></code></p>
<p class="firstline">Updates file metadata and/or content.</p>
<p class="toc_element">
- <code><a href="#watch">watch(fileId, body, projection=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
+ <code><a href="#watch">watch(fileId, body, projection=None, revisionId=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
<p class="firstline">Subscribe to changes on a file</p>
<p class="toc_element">
- <code><a href="#watch_media">watch_media(fileId, body, projection=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
+ <code><a href="#watch_media">watch_media(fileId, body, projection=None, revisionId=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
<p class="firstline">Subscribe to changes on a file</p>
<h3>Method Details</h3>
<div class="method">
@@ -134,13 +134,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -237,7 +237,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -278,7 +278,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -320,6 +325,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -333,7 +341,7 @@
Allowed values
DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.
PRIVATE - The new file will be visible to only the owner.
- ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
+ ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
@@ -346,13 +354,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -449,7 +457,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -490,7 +498,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -532,6 +545,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -542,7 +558,7 @@
<div class="method">
<code class="details" id="delete">delete(fileId)</code>
- <pre>Permanently deletes a file by ID. Skips the trash.
+ <pre>Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file.
Args:
fileId: string, The ID of the file to delete. (required)
@@ -558,7 +574,7 @@
</div>
<div class="method">
- <code class="details" id="get">get(fileId, projection=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
+ <code class="details" id="get">get(fileId, projection=None, revisionId=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
<pre>Gets a file's metadata by ID.
Args:
@@ -567,6 +583,7 @@
Allowed values
BASIC - Deprecated
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.
@@ -578,13 +595,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -681,7 +698,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -722,7 +739,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -764,6 +786,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -773,7 +798,7 @@
</div>
<div class="method">
- <code class="details" id="get_media">get_media(fileId, projection=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
+ <code class="details" id="get_media">get_media(fileId, projection=None, revisionId=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
<pre>Gets a file's metadata by ID.
Args:
@@ -782,6 +807,7 @@
Allowed values
BASIC - Deprecated
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.
@@ -804,13 +830,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -907,7 +933,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -948,7 +974,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -990,6 +1021,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -1004,7 +1038,7 @@
Allowed values
DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.
PRIVATE - The new file will be visible to only the owner.
- ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
+ ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
@@ -1018,13 +1052,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -1121,7 +1155,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -1162,7 +1196,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -1204,6 +1243,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -1213,7 +1255,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(q=None, projection=None, pageToken=None, maxResults=None, corpus=None)</code>
+ <code class="details" id="list">list(q=None, projection=None, pageToken=None, maxResults=None, spaces=None, corpus=None)</code>
<pre>Lists the user's files.
Args:
@@ -1224,6 +1266,7 @@
FULL - Deprecated
pageToken: string, Page token for files.
maxResults: integer, Maximum number of files to return.
+ spaces: string, A comma-separated list of spaces to query. Supported values are 'drive' and 'appDataFolder'.
corpus: string, The body of items (files/documents) to which the query applies.
Allowed values
DEFAULT - The items that the user has accessed.
@@ -1241,13 +1284,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -1344,7 +1387,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -1385,7 +1428,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -1427,6 +1475,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -1468,13 +1519,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -1571,7 +1622,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -1612,7 +1663,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -1654,6 +1710,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -1661,9 +1720,9 @@
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
}
- newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous revisions are preserved (causing increased use of the user's data storage quota).
+ newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions.
pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
- ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
+ ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
addParents: string, Comma-separated list of parent IDs to add.
removeParents: string, Comma-separated list of parent IDs to remove.
@@ -1682,13 +1741,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -1785,7 +1844,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -1826,7 +1885,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -1868,6 +1932,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -1891,13 +1958,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -1994,7 +2061,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -2035,7 +2102,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -2077,6 +2149,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -2100,13 +2175,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -2203,7 +2278,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -2244,7 +2319,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -2286,6 +2366,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -2309,13 +2392,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -2412,7 +2495,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -2453,7 +2536,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -2495,6 +2583,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -2517,13 +2608,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -2620,7 +2711,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -2661,7 +2752,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -2703,6 +2799,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -2710,9 +2809,9 @@
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
}
- newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous revisions are preserved (causing increased use of the user's data storage quota).
+ newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
+ ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
addParents: string, Comma-separated list of parent IDs to add.
@@ -2732,13 +2831,13 @@
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
+ "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
@@ -2835,7 +2934,7 @@
],
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"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",
@@ -2876,7 +2975,12 @@
"fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -2918,6 +3022,9 @@
],
"selfLink": "A String", # A link back to this permission.
},
+ "spaces": [ # The list of spaces which contain the file. Supported values are 'drive' and 'appDataFolder'.
+ "A String",
+ ],
"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 will only be populated on files with content stored in Drive.
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
"headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
@@ -2927,7 +3034,7 @@
</div>
<div class="method">
- <code class="details" id="watch">watch(fileId, body, projection=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
+ <code class="details" id="watch">watch(fileId, body, projection=None, revisionId=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
<pre>Subscribe to changes on a file
Args:
@@ -2954,6 +3061,7 @@
Allowed values
BASIC - Deprecated
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.
@@ -2977,7 +3085,7 @@
</div>
<div class="method">
- <code class="details" id="watch_media">watch_media(fileId, body, projection=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
+ <code class="details" id="watch_media">watch_media(fileId, body, projection=None, revisionId=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
<pre>Subscribe to changes on a file
Args:
@@ -3004,6 +3112,7 @@
Allowed values
BASIC - Deprecated
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.
diff --git a/docs/dyn/drive_v2.html b/docs/dyn/drive_v2.html
index 471c46c..fa04076 100644
--- a/docs/dyn/drive_v2.html
+++ b/docs/dyn/drive_v2.html
@@ -139,4 +139,25 @@
</p>
<p class="firstline">Returns the revisions 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/drive_v2.permissions.html b/docs/dyn/drive_v2.permissions.html
index 5adfb64..f209b5a 100644
--- a/docs/dyn/drive_v2.permissions.html
+++ b/docs/dyn/drive_v2.permissions.html
@@ -308,7 +308,7 @@
"selfLink": "A String", # A link back to this permission.
}
- transferOwnership: boolean, Whether changing a role to 'owner' should also downgrade the current owners to writers.
+ transferOwnership: boolean, Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.
Returns:
An object of the form:
@@ -376,7 +376,7 @@
"selfLink": "A String", # A link back to this permission.
}
- transferOwnership: boolean, Whether changing a role to 'owner' should also downgrade the current owners to writers.
+ transferOwnership: boolean, Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.
Returns:
An object of the form:
diff --git a/docs/dyn/drive_v2.properties.html b/docs/dyn/drive_v2.properties.html
index a5f7e24..b15e8c7 100644
--- a/docs/dyn/drive_v2.properties.html
+++ b/docs/dyn/drive_v2.properties.html
@@ -116,7 +116,12 @@
Returns:
An object of the form:
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -135,7 +140,12 @@
body: object, The request body. (required)
The object takes the form of:
-{ # A key-value pair that is either public or private to an application.
+{ # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -148,7 +158,12 @@
Returns:
An object of the form:
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -170,7 +185,12 @@
{ # A collection of properties, key-value pairs that are either public or private to an application.
"items": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -195,7 +215,12 @@
body: object, The request body. (required)
The object takes the form of:
-{ # A key-value pair that is either public or private to an application.
+{ # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -209,7 +234,12 @@
Returns:
An object of the form:
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -229,7 +259,12 @@
body: object, The request body. (required)
The object takes the form of:
-{ # A key-value pair that is either public or private to an application.
+{ # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
@@ -243,7 +278,12 @@
Returns:
An object of the form:
- { # A key-value pair that is either public or private to an application.
+ { # A key-value pair attached to a file that is either public or private to an application.
+ # The following limits apply to file properties:
+ # - Maximum of 100 properties total per file
+ # - Maximum of 30 private properties per app
+ # - Maximum of 30 public properties
+ # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
diff --git a/docs/dyn/fitness_v1.html b/docs/dyn/fitness_v1.html
index 6f20544..fe69776 100644
--- a/docs/dyn/fitness_v1.html
+++ b/docs/dyn/fitness_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the users 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/fitness_v1.users.dataSources.html b/docs/dyn/fitness_v1.users.dataSources.html
index 5e0c888..9639ca5 100644
--- a/docs/dyn/fitness_v1.users.dataSources.html
+++ b/docs/dyn/fitness_v1.users.dataSources.html
@@ -83,6 +83,9 @@
<code><a href="#create">create(userId, body)</a></code></p>
<p class="firstline">Creates a new data source that is unique across all data sources belonging to this user. The data stream ID field can be omitted and will be generated by the server with the correct format. The data stream ID is an ordered combination of some fields from the data source. In addition to the data source fields reflected into the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types.</p>
<p class="toc_element">
+ <code><a href="#delete">delete(userId, dataSourceId)</a></code></p>
+<p class="firstline">Delete the data source if there are no datapoints associated with it</p>
+<p class="toc_element">
<code><a href="#get">get(userId, dataSourceId)</a></code></p>
<p class="firstline">Returns a data source identified by a data stream ID.</p>
<p class="toc_element">
@@ -105,9 +108,69 @@
The object takes the form of:
{ # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
+ #
+ # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
+ #
+ # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
+ "name": "A String", # An end-user visible name for this data source.
+ "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
+ "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
+ "field": [ # A field represents one dimension of a data type.
+ { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
+ #
+ # This message is only instantiated in code and not used for wire comms or stored in any way.
+ "optional": True or False,
+ "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
+ "format": "A String", # The different supported formats for each field in a data type.
+ },
+ ],
+ "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
+ },
+ "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
+ "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
+ "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
+ "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
+ "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
+ },
+ "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
+ #
+ # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
+ # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
+ # - Display the source of data to the user (by using the device make / model)
+ # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
+ # - Build different analysis models for each device/version.
+ "model": "A String", # End-user visible model name for the device.
+ "version": "A String", # Version string for the device hardware/software.
+ "type": "A String", # A constant representing the type of the device.
+ "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
+ "manufacturer": "A String", # Manufacturer of the product/hardware.
+ },
+ "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
#
+ #
+ # - The physical device's manufacturer, model, and serial number (UID).
+ # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
+ # - The data source's type.
+ # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
+ #
+ # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
+ #
+ # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
+ "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
+ #
# The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
- #
+ #
# Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
"name": "A String", # An end-user visible name for this data source.
"dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
@@ -143,82 +206,90 @@
"manufacturer": "A String", # Manufacturer of the product/hardware.
},
"dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
- #
- #
+ #
+ #
# - The physical device's manufacturer, model, and serial number (UID).
# - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
# - The data source's type.
# - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
- #
+ #
# The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
- #
+ #
# The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
- #
+ #
# When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
- #
+ #
# Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
"type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
- }
+ }</pre>
+</div>
+<div class="method">
+ <code class="details" id="delete">delete(userId, dataSourceId)</code>
+ <pre>Delete the data source if there are no datapoints associated with it
+
+Args:
+ userId: string, Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
+ dataSourceId: string, The data stream ID of the data source to delete. (required)
Returns:
An object of the form:
{ # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
+ #
+ # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
+ #
+ # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
+ "name": "A String", # An end-user visible name for this data source.
+ "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
+ "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
+ "field": [ # A field represents one dimension of a data type.
+ { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
+ #
+ # This message is only instantiated in code and not used for wire comms or stored in any way.
+ "optional": True or False,
+ "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
+ "format": "A String", # The different supported formats for each field in a data type.
+ },
+ ],
+ "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
+ },
+ "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
+ "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
+ "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
+ "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
+ "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
+ },
+ "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
#
- # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
+ # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
+ # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
+ # - Display the source of data to the user (by using the device make / model)
+ # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
+ # - Build different analysis models for each device/version.
+ "model": "A String", # End-user visible model name for the device.
+ "version": "A String", # Version string for the device hardware/software.
+ "type": "A String", # A constant representing the type of the device.
+ "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
+ "manufacturer": "A String", # Manufacturer of the product/hardware.
+ },
+ "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
#
- # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
- "name": "A String", # An end-user visible name for this data source.
- "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
- "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
- "field": [ # A field represents one dimension of a data type.
- { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
- #
- # This message is only instantiated in code and not used for wire comms or stored in any way.
- "optional": True or False,
- "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
- "format": "A String", # The different supported formats for each field in a data type.
- },
- ],
- "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
- },
- "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
- "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
- "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
- "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
- "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
- },
- "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
- #
- # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
- # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
- # - Display the source of data to the user (by using the device make / model)
- # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
- # - Build different analysis models for each device/version.
- "model": "A String", # End-user visible model name for the device.
- "version": "A String", # Version string for the device hardware/software.
- "type": "A String", # A constant representing the type of the device.
- "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
- "manufacturer": "A String", # Manufacturer of the product/hardware.
- },
- "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
- #
- #
- # - The physical device's manufacturer, model, and serial number (UID).
- # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
- # - The data source's type.
- # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
- #
- # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
- #
- # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
- #
- # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
- #
- # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
- "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
- }</pre>
+ #
+ # - The physical device's manufacturer, model, and serial number (UID).
+ # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
+ # - The data source's type.
+ # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
+ #
+ # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
+ #
+ # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
+ "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
+ }</pre>
</div>
<div class="method">
@@ -233,60 +304,60 @@
An object of the form:
{ # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
+ #
+ # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
+ #
+ # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
+ "name": "A String", # An end-user visible name for this data source.
+ "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
+ "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
+ "field": [ # A field represents one dimension of a data type.
+ { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
+ #
+ # This message is only instantiated in code and not used for wire comms or stored in any way.
+ "optional": True or False,
+ "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
+ "format": "A String", # The different supported formats for each field in a data type.
+ },
+ ],
+ "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
+ },
+ "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
+ "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
+ "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
+ "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
+ "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
+ },
+ "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
#
- # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
+ # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
+ # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
+ # - Display the source of data to the user (by using the device make / model)
+ # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
+ # - Build different analysis models for each device/version.
+ "model": "A String", # End-user visible model name for the device.
+ "version": "A String", # Version string for the device hardware/software.
+ "type": "A String", # A constant representing the type of the device.
+ "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
+ "manufacturer": "A String", # Manufacturer of the product/hardware.
+ },
+ "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
#
- # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
- "name": "A String", # An end-user visible name for this data source.
- "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
- "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
- "field": [ # A field represents one dimension of a data type.
- { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
- #
- # This message is only instantiated in code and not used for wire comms or stored in any way.
- "optional": True or False,
- "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
- "format": "A String", # The different supported formats for each field in a data type.
- },
- ],
- "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
- },
- "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
- "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
- "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
- "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
- "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
- },
- "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
- #
- # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
- # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
- # - Display the source of data to the user (by using the device make / model)
- # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
- # - Build different analysis models for each device/version.
- "model": "A String", # End-user visible model name for the device.
- "version": "A String", # Version string for the device hardware/software.
- "type": "A String", # A constant representing the type of the device.
- "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
- "manufacturer": "A String", # Manufacturer of the product/hardware.
- },
- "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
- #
- #
- # - The physical device's manufacturer, model, and serial number (UID).
- # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
- # - The data source's type.
- # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
- #
- # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
- #
- # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
- #
- # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
- #
- # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
- "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
- }</pre>
+ #
+ # - The physical device's manufacturer, model, and serial number (UID).
+ # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
+ # - The data source's type.
+ # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
+ #
+ # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
+ #
+ # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
+ "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
+ }</pre>
</div>
<div class="method">
@@ -303,60 +374,60 @@
{
"dataSource": [ # A previously created data source.
{ # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
- #
- # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
- #
- # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
- "name": "A String", # An end-user visible name for this data source.
- "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
- "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
- "field": [ # A field represents one dimension of a data type.
- { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
- #
- # This message is only instantiated in code and not used for wire comms or stored in any way.
- "optional": True or False,
- "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
- "format": "A String", # The different supported formats for each field in a data type.
- },
- ],
- "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
- },
- "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
- "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
- "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
- "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
- "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
- },
- "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
- #
- # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
- # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
- # - Display the source of data to the user (by using the device make / model)
- # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
- # - Build different analysis models for each device/version.
- "model": "A String", # End-user visible model name for the device.
- "version": "A String", # Version string for the device hardware/software.
- "type": "A String", # A constant representing the type of the device.
- "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
- "manufacturer": "A String", # Manufacturer of the product/hardware.
- },
- "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
- #
- #
- # - The physical device's manufacturer, model, and serial number (UID).
- # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
- # - The data source's type.
- # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
- #
- # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
- #
- # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
- #
- # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
- #
- # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
- "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
+ #
+ # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
+ #
+ # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
+ "name": "A String", # An end-user visible name for this data source.
+ "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
+ "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
+ "field": [ # A field represents one dimension of a data type.
+ { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
+ #
+ # This message is only instantiated in code and not used for wire comms or stored in any way.
+ "optional": True or False,
+ "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
+ "format": "A String", # The different supported formats for each field in a data type.
+ },
+ ],
+ "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
},
+ "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
+ "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
+ "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
+ "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
+ "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
+ },
+ "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
+ #
+ # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
+ # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
+ # - Display the source of data to the user (by using the device make / model)
+ # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
+ # - Build different analysis models for each device/version.
+ "model": "A String", # End-user visible model name for the device.
+ "version": "A String", # Version string for the device hardware/software.
+ "type": "A String", # A constant representing the type of the device.
+ "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
+ "manufacturer": "A String", # Manufacturer of the product/hardware.
+ },
+ "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
+ #
+ #
+ # - The physical device's manufacturer, model, and serial number (UID).
+ # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
+ # - The data source's type.
+ # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
+ #
+ # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
+ #
+ # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
+ "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
+ },
],
}</pre>
</div>
@@ -374,9 +445,69 @@
The object takes the form of:
{ # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
+ #
+ # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
+ #
+ # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
+ "name": "A String", # An end-user visible name for this data source.
+ "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
+ "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
+ "field": [ # A field represents one dimension of a data type.
+ { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
+ #
+ # This message is only instantiated in code and not used for wire comms or stored in any way.
+ "optional": True or False,
+ "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
+ "format": "A String", # The different supported formats for each field in a data type.
+ },
+ ],
+ "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
+ },
+ "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
+ "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
+ "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
+ "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
+ "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
+ },
+ "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
+ #
+ # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
+ # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
+ # - Display the source of data to the user (by using the device make / model)
+ # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
+ # - Build different analysis models for each device/version.
+ "model": "A String", # End-user visible model name for the device.
+ "version": "A String", # Version string for the device hardware/software.
+ "type": "A String", # A constant representing the type of the device.
+ "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
+ "manufacturer": "A String", # Manufacturer of the product/hardware.
+ },
+ "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
#
+ #
+ # - The physical device's manufacturer, model, and serial number (UID).
+ # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
+ # - The data source's type.
+ # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
+ #
+ # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
+ #
+ # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
+ "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
+ #
# The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
- #
+ #
# Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
"name": "A String", # An end-user visible name for this data source.
"dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
@@ -412,82 +543,22 @@
"manufacturer": "A String", # Manufacturer of the product/hardware.
},
"dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
- #
- #
+ #
+ #
# - The physical device's manufacturer, model, and serial number (UID).
# - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
# - The data source's type.
# - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
- #
+ #
# The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
- #
+ #
# The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
- #
+ #
# When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
- #
+ #
# Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
"type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
- }
-
-
-Returns:
- An object of the form:
-
- { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
- #
- # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
- #
- # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
- "name": "A String", # An end-user visible name for this data source.
- "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
- "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
- "field": [ # A field represents one dimension of a data type.
- { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
- #
- # This message is only instantiated in code and not used for wire comms or stored in any way.
- "optional": True or False,
- "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
- "format": "A String", # The different supported formats for each field in a data type.
- },
- ],
- "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
- },
- "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
- "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
- "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
- "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
- "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
- },
- "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
- #
- # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
- # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
- # - Display the source of data to the user (by using the device make / model)
- # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
- # - Build different analysis models for each device/version.
- "model": "A String", # End-user visible model name for the device.
- "version": "A String", # Version string for the device hardware/software.
- "type": "A String", # A constant representing the type of the device.
- "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
- "manufacturer": "A String", # Manufacturer of the product/hardware.
- },
- "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
- #
- #
- # - The physical device's manufacturer, model, and serial number (UID).
- # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
- # - The data source's type.
- # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
- #
- # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
- #
- # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
- #
- # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
- #
- # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
- "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -503,9 +574,69 @@
The object takes the form of:
{ # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
+ #
+ # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
+ #
+ # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
+ "name": "A String", # An end-user visible name for this data source.
+ "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
+ "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
+ "field": [ # A field represents one dimension of a data type.
+ { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
+ #
+ # This message is only instantiated in code and not used for wire comms or stored in any way.
+ "optional": True or False,
+ "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
+ "format": "A String", # The different supported formats for each field in a data type.
+ },
+ ],
+ "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
+ },
+ "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
+ "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
+ "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
+ "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
+ "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
+ },
+ "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
+ #
+ # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
+ # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
+ # - Display the source of data to the user (by using the device make / model)
+ # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
+ # - Build different analysis models for each device/version.
+ "model": "A String", # End-user visible model name for the device.
+ "version": "A String", # Version string for the device hardware/software.
+ "type": "A String", # A constant representing the type of the device.
+ "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
+ "manufacturer": "A String", # Manufacturer of the product/hardware.
+ },
+ "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
#
+ #
+ # - The physical device's manufacturer, model, and serial number (UID).
+ # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
+ # - The data source's type.
+ # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
+ #
+ # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
+ #
+ # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
+ #
+ # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
+ "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
+ #
# The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
- #
+ #
# Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
"name": "A String", # An end-user visible name for this data source.
"dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
@@ -541,82 +672,22 @@
"manufacturer": "A String", # Manufacturer of the product/hardware.
},
"dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
- #
- #
+ #
+ #
# - The physical device's manufacturer, model, and serial number (UID).
# - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
# - The data source's type.
# - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
- #
+ #
# The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
- #
+ #
# The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
- #
+ #
# When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
- #
+ #
# Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
"type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
- }
-
-
-Returns:
- An object of the form:
-
- { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
- #
- # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
- #
- # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
- "name": "A String", # An end-user visible name for this data source.
- "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
- "dataType": { # See: google3/java/com/google/android/apps/heart/platform/api/DataType.java # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
- "field": [ # A field represents one dimension of a data type.
- { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
- #
- # This message is only instantiated in code and not used for wire comms or stored in any way.
- "optional": True or False,
- "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
- "format": "A String", # The different supported formats for each field in a data type.
- },
- ],
- "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
- },
- "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # Information about an application which feeds sensor data into the platform.
- "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
- "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
- "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
- "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
- },
- "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
- #
- # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
- # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
- # - Display the source of data to the user (by using the device make / model)
- # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
- # - Build different analysis models for each device/version.
- "model": "A String", # End-user visible model name for the device.
- "version": "A String", # Version string for the device hardware/software.
- "type": "A String", # A constant representing the type of the device.
- "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
- "manufacturer": "A String", # Manufacturer of the product/hardware.
- },
- "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
- #
- #
- # - The physical device's manufacturer, model, and serial number (UID).
- # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
- # - The data source's type.
- # - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
- #
- # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
- #
- # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
- #
- # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
- #
- # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
- "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
- }</pre>
+ }</pre>
</div>
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/fitness_v1.users.dataset.html b/docs/dyn/fitness_v1.users.dataset.html
new file mode 100644
index 0000000..5865962
--- /dev/null
+++ b/docs/dyn/fitness_v1.users.dataset.html
@@ -0,0 +1,182 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="fitness_v1.html">Fitness</a> . <a href="fitness_v1.users.html">users</a> . <a href="fitness_v1.users.dataset.html">dataset</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregate">aggregate(userId, 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="aggregate">aggregate(userId, body)</code>
+ <pre>A description of how to use this function
+
+Args:
+ userId: string, A parameter (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "aggregateBy": [
+ {
+ "outputDataTypeName": "A String",
+ "dataSourceId": "A String",
+ "dataTypeName": "A String", # by dataype or by datasource
+ "outputDataSourceId": "A String",
+ },
+ ],
+ "bucketByActivitySegment": {
+ "activityDataSourceId": "A String", # default activity stream will be used if not specified
+ "minDurationMillis": "A String", # Only activity segments of duration longer than this is used
+ },
+ "endTimeMillis": "A String",
+ "bucketBySession": {
+ "minDurationMillis": "A String", # Only sessions of duration longer than this is used
+ },
+ "bucketByActivityType": {
+ "activityDataSourceId": "A String", # default activity stream will be used if not specified
+ "minDurationMillis": "A String", # Only activity segments of duration longer than this is used
+ },
+ "startTimeMillis": "A String", # required time range
+ "bucketByTime": { # apparently oneof is not supported by reduced_nano_proto
+ "durationMillis": "A String",
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "bucket": [
+ {
+ "endTimeMillis": "A String",
+ "dataset": [ # There will be one dataset per datatype/datasource
+ { # A dataset represents a projection container for data points. They do not carry any info of their own. Datasets represent a set of data points from a particular data source. A data point can be found in more than one dataset.
+ "minStartTimeNs": "A String", # The smallest start time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.
+ "nextPageToken": "A String", # This token will be set when a dataset is received in response to a GET request and the dataset is too large to be included in a single response. Provide this value in a subsequent GET request to return the next page of data points within this dataset.
+ "maxEndTimeNs": "A String", # The largest end time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.
+ "dataSourceId": "A String", # The data stream ID of the data source that created the points in this dataset.
+ "point": [ # A partial list of data points contained in the dataset, ordered by largest endTimeNanos first. This list is considered complete when retrieving a small dataset and partial when patching a dataset or retrieving a dataset that is too large to include in a single response.
+ { # Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and an optional start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type.
+ #
+ # A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type.
+ #
+ # Data points always contain one value for each field of the data type.
+ "modifiedTimeMillis": "A String", # Indicates the last time this data point was modified. Useful only in contexts where we are listing the data changes, rather than representing the current state of the data.
+ "startTimeNanos": "A String", # The start time of the interval represented by this data point, in nanoseconds since epoch.
+ "dataTypeName": "A String", # The data type defining the format of the values in this data point.
+ "endTimeNanos": "A String", # The end time of the interval represented by this data point, in nanoseconds since epoch.
+ "value": [ # Values of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed with in the data type specified in a data source.
+ #
+ # Only one of integer and floating point fields will be populated, depending on the format enum value within data source's type field.
+ { # Holder object for the value of a single field in a data point.
+ #
+ # A field value has a particular format and is only ever set to one of an integer or a floating point value.
+ "fpVal": 3.14, # Floating point value. When this is set, intVal must not be set.
+ "intVal": 42, # Integer value. When this is set, fpVal must not be set.
+ },
+ ],
+ "computationTimeMillis": "A String", # Used for version checking during transformation; that is, a datapoint can only replace another datapoint that has an older computation time stamp.
+ "originDataSourceId": "A String", # If the data point is contained in a dataset for a derived data source, this field will be populated with the data source stream ID that created the data point originally.
+ "rawTimestampNanos": "A String", # The raw timestamp from the original SensorEvent.
+ },
+ ],
+ },
+ ],
+ "session": { # Sessions contain metadata, such as a user-friendly name and time interval information. # available for Bucket.Type.SESSION
+ "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
+ "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
+ "description": "A String", # A description for this session.
+ "activityType": 42, # The type of activity this session represents.
+ "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # The application that created the session.
+ "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
+ "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
+ "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
+ "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
+ },
+ "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
+ "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
+ "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
+ "name": "A String", # A human readable name of the session.
+ },
+ "activity": 42, # available for Bucket.Type.ACTIVITY_TYPE, Bucket.Type.ACTIVITY_SEGMENT
+ "startTimeMillis": "A String",
+ "type": "A String", # The type of a bucket signifies how the data aggregation is performed in the bucket.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/fitness_v1.users.html b/docs/dyn/fitness_v1.users.html
index 463a3b8..a129cb3 100644
--- a/docs/dyn/fitness_v1.users.html
+++ b/docs/dyn/fitness_v1.users.html
@@ -80,6 +80,11 @@
<p class="firstline">Returns the dataSources Resource.</p>
<p class="toc_element">
+ <code><a href="fitness_v1.users.dataset.html">dataset()</a></code>
+</p>
+<p class="firstline">Returns the dataset Resource.</p>
+
+<p class="toc_element">
<code><a href="fitness_v1.users.sessions.html">sessions()</a></code>
</p>
<p class="firstline">Returns the sessions Resource.</p>
diff --git a/docs/dyn/fitness_v1.users.sessions.html b/docs/dyn/fitness_v1.users.sessions.html
index 27afc3d..70ee2fb 100644
--- a/docs/dyn/fitness_v1.users.sessions.html
+++ b/docs/dyn/fitness_v1.users.sessions.html
@@ -127,6 +127,7 @@
"detailsUrl": "A String", # An optional URI that can be used to link back to the application.
},
"startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
+ "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
"id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
"name": "A String", # A human readable name of the session.
},
@@ -144,6 +145,7 @@
"detailsUrl": "A String", # An optional URI that can be used to link back to the application.
},
"startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
+ "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
"id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
"name": "A String", # A human readable name of the session.
},
@@ -187,6 +189,7 @@
"detailsUrl": "A String", # An optional URI that can be used to link back to the application.
},
"startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
+ "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
"id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
"name": "A String", # A human readable name of the session.
}
@@ -208,6 +211,7 @@
"detailsUrl": "A String", # An optional URI that can be used to link back to the application.
},
"startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
+ "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
"id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
"name": "A String", # A human readable name of the session.
}</pre>
diff --git a/docs/dyn/freebase_v1.html b/docs/dyn/freebase_v1.html
index 23a63f5..80b485d 100644
--- a/docs/dyn/freebase_v1.html
+++ b/docs/dyn/freebase_v1.html
@@ -75,6 +75,9 @@
<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">
@@ -85,6 +88,23 @@
<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.
diff --git a/docs/dyn/fusiontables_v2.column.html b/docs/dyn/fusiontables_v2.column.html
index 6fc0a8a..1c7319c 100644
--- a/docs/dyn/fusiontables_v2.column.html
+++ b/docs/dyn/fusiontables_v2.column.html
@@ -76,10 +76,10 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(tableId, columnId)</a></code></p>
-<p class="firstline">Deletes the column.</p>
+<p class="firstline">Deletes the specified column.</p>
<p class="toc_element">
<code><a href="#get">get(tableId, columnId)</a></code></p>
-<p class="firstline">Retrieves a specific column by its id.</p>
+<p class="firstline">Retrieves a specific column by its ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(tableId, body)</a></code></p>
<p class="firstline">Adds a new column to the table.</p>
@@ -98,7 +98,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(tableId, columnId)</code>
- <pre>Deletes the column.
+ <pre>Deletes the specified column.
Args:
tableId: string, Table from which the column is being deleted. (required)
@@ -108,7 +108,7 @@
<div class="method">
<code class="details" id="get">get(tableId, columnId)</code>
- <pre>Retrieves a specific column by its id.
+ <pre>Retrieves a specific column by its ID.
Args:
tableId: string, Table to which the column belongs. (required)
@@ -120,8 +120,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -133,6 +133,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -152,8 +153,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -165,6 +166,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -178,8 +180,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -191,6 +193,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -211,13 +214,13 @@
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 details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -229,13 +232,14 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
"columnId": 42, # Identifier for the column.
},
],
- "kind": "fusiontables#columnList", # Type name: a list of all columns.
+ "kind": "fusiontables#columnList", # The kind of item this is. For a column list, this is always fusiontables#columnList.
"totalItems": 42, # Total number of columns for the table.
}</pre>
</div>
@@ -267,8 +271,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -280,6 +284,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -293,8 +298,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -306,6 +311,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -326,8 +332,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -339,6 +345,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -352,8 +359,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -365,6 +372,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
diff --git a/docs/dyn/fusiontables_v2.html b/docs/dyn/fusiontables_v2.html
index 7930899..c0792ef 100644
--- a/docs/dyn/fusiontables_v2.html
+++ b/docs/dyn/fusiontables_v2.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_v2.query.html b/docs/dyn/fusiontables_v2.query.html
index aa3b393..04597bb 100644
--- a/docs/dyn/fusiontables_v2.query.html
+++ b/docs/dyn/fusiontables_v2.query.html
@@ -75,32 +75,46 @@
<h1><a href="fusiontables_v2.html">Fusion Tables API</a> . <a href="fusiontables_v2.query.html">query</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#sql">sql(sql, hdrs=None, typed=None)</a></code></p>
-<p class="firstline">Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE statement.</p>
+ <code><a href="#sql">sql(sql=None, hdrs=None, typed=None)</a></code></p>
+<p class="firstline">Executes a Fusion Tables SQL statement, which can be any of </p>
<p class="toc_element">
- <code><a href="#sqlGet">sqlGet(sql, hdrs=None, typed=None)</a></code></p>
-<p class="firstline">Executes an SQL SELECT/SHOW/DESCRIBE statement.</p>
+ <code><a href="#sqlGet">sqlGet(sql=None, hdrs=None, typed=None)</a></code></p>
+<p class="firstline">Executes a SQL statement which can be any of </p>
<p class="toc_element">
- <code><a href="#sqlGet_media">sqlGet_media(sql, hdrs=None, typed=None)</a></code></p>
-<p class="firstline">Executes an SQL SELECT/SHOW/DESCRIBE statement.</p>
+ <code><a href="#sqlGet_media">sqlGet_media(sql=None, hdrs=None, typed=None)</a></code></p>
+<p class="firstline">Executes a SQL statement which can be any of </p>
<p class="toc_element">
- <code><a href="#sql_media">sql_media(sql, hdrs=None, typed=None)</a></code></p>
-<p class="firstline">Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE statement.</p>
+ <code><a href="#sql_media">sql_media(sql=None, hdrs=None, typed=None)</a></code></p>
+<p class="firstline">Executes a Fusion Tables SQL statement, which can be any of </p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="sql">sql(sql, hdrs=None, typed=None)</code>
- <pre>Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE statement.
+ <code class="details" id="sql">sql(sql=None, hdrs=None, typed=None)</code>
+ <pre>Executes a Fusion Tables SQL statement, which can be any of
+- SELECT
+- INSERT
+- UPDATE
+- DELETE
+- SHOW
+- DESCRIBE
+- CREATE statement.
Args:
- sql: string, An SQL SELECT/SHOW/DESCRIBE/INSERT/UPDATE/DELETE/CREATE statement. (required)
- hdrs: boolean, Should column names be included (in the first row)?. Default is true.
- typed: boolean, Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true.
+ sql: string, A Fusion Tables SQL statement, which can be any of
+- SELECT
+- INSERT
+- UPDATE
+- DELETE
+- SHOW
+- DESCRIBE
+- CREATE (required)
+ hdrs: boolean, Whether column names are included in the first row. Default is true.
+ typed: boolean, Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true.
Returns:
An object of the form:
- { # Represents a response to an sql statement.
- "kind": "fusiontables#sqlresponse", # Type name: a template for an individual table.
+ { # Represents a response to a SQL statement.
+ "kind": "fusiontables#sqlresponse", # The kind of item this is. For responses to SQL queries, this is always fusiontables#sqlresponse.
"rows": [ # The rows in the table. For each cell we print out whatever cell value (e.g., numeric, string) exists. Thus it is important that each cell contains only one value.
[
"",
@@ -113,19 +127,25 @@
</div>
<div class="method">
- <code class="details" id="sqlGet">sqlGet(sql, hdrs=None, typed=None)</code>
- <pre>Executes an SQL SELECT/SHOW/DESCRIBE statement.
+ <code class="details" id="sqlGet">sqlGet(sql=None, hdrs=None, typed=None)</code>
+ <pre>Executes a SQL statement which can be any of
+- SELECT
+- SHOW
+- DESCRIBE
Args:
- sql: string, An SQL SELECT/SHOW/DESCRIBE statement. (required)
- hdrs: boolean, Should column names be included (in the first row)?. Default is true.
- typed: boolean, Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true.
+ sql: string, A SQL statement which can be any of
+- SELECT
+- SHOW
+- DESCRIBE (required)
+ hdrs: boolean, Whether column names are included (in the first row). Default is true.
+ typed: boolean, Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true.
Returns:
An object of the form:
- { # Represents a response to an sql statement.
- "kind": "fusiontables#sqlresponse", # Type name: a template for an individual table.
+ { # Represents a response to a SQL statement.
+ "kind": "fusiontables#sqlresponse", # The kind of item this is. For responses to SQL queries, this is always fusiontables#sqlresponse.
"rows": [ # The rows in the table. For each cell we print out whatever cell value (e.g., numeric, string) exists. Thus it is important that each cell contains only one value.
[
"",
@@ -138,13 +158,19 @@
</div>
<div class="method">
- <code class="details" id="sqlGet_media">sqlGet_media(sql, hdrs=None, typed=None)</code>
- <pre>Executes an SQL SELECT/SHOW/DESCRIBE statement.
+ <code class="details" id="sqlGet_media">sqlGet_media(sql=None, hdrs=None, typed=None)</code>
+ <pre>Executes a SQL statement which can be any of
+- SELECT
+- SHOW
+- DESCRIBE
Args:
- sql: string, An SQL SELECT/SHOW/DESCRIBE statement. (required)
- hdrs: boolean, Should column names be included (in the first row)?. Default is true.
- typed: boolean, Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true.
+ sql: string, A SQL statement which can be any of
+- SELECT
+- SHOW
+- DESCRIBE (required)
+ hdrs: boolean, Whether column names are included (in the first row). Default is true.
+ typed: boolean, Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true.
Returns:
The media object as a string.
@@ -153,13 +179,27 @@
</div>
<div class="method">
- <code class="details" id="sql_media">sql_media(sql, hdrs=None, typed=None)</code>
- <pre>Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE statement.
+ <code class="details" id="sql_media">sql_media(sql=None, hdrs=None, typed=None)</code>
+ <pre>Executes a Fusion Tables SQL statement, which can be any of
+- SELECT
+- INSERT
+- UPDATE
+- DELETE
+- SHOW
+- DESCRIBE
+- CREATE statement.
Args:
- sql: string, An SQL SELECT/SHOW/DESCRIBE/INSERT/UPDATE/DELETE/CREATE statement. (required)
- hdrs: boolean, Should column names be included (in the first row)?. Default is true.
- typed: boolean, Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true.
+ sql: string, A Fusion Tables SQL statement, which can be any of
+- SELECT
+- INSERT
+- UPDATE
+- DELETE
+- SHOW
+- DESCRIBE
+- CREATE (required)
+ hdrs: boolean, Whether column names are included in the first row. Default is true.
+ typed: boolean, Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true.
Returns:
The media object as a string.
diff --git a/docs/dyn/fusiontables_v2.style.html b/docs/dyn/fusiontables_v2.style.html
index e23b5e6..9212cf3 100644
--- a/docs/dyn/fusiontables_v2.style.html
+++ b/docs/dyn/fusiontables_v2.style.html
@@ -141,11 +141,11 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
},
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
+ "kind": "fusiontables#styleSetting", # The kind of item this is. A StyleSetting contains the style definitions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
"name": "A String", # Optional name for the style setting.
"polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
"strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
@@ -170,7 +170,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeWeight": 42, # Width of the polyon border in pixels.
"strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
@@ -196,7 +196,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
"gradient": { # Gradient function that interpolates a range of colors based on column value.
@@ -220,7 +220,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
"strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
@@ -250,7 +250,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeColor": "A String", # Color of the line in #RRGGBB format.
"strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
@@ -276,7 +276,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
},
"tableId": "A String", # Identifier for the table.
@@ -317,11 +317,11 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
},
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
+ "kind": "fusiontables#styleSetting", # The kind of item this is. A StyleSetting contains the style definitions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
"name": "A String", # Optional name for the style setting.
"polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
"strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
@@ -346,7 +346,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeWeight": 42, # Width of the polyon border in pixels.
"strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
@@ -372,7 +372,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
"gradient": { # Gradient function that interpolates a range of colors based on column value.
@@ -396,7 +396,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
"strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
@@ -426,7 +426,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeColor": "A String", # Color of the line in #RRGGBB format.
"strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
@@ -452,7 +452,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
},
"tableId": "A String", # Identifier for the table.
@@ -487,11 +487,11 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
},
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
+ "kind": "fusiontables#styleSetting", # The kind of item this is. A StyleSetting contains the style definitions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
"name": "A String", # Optional name for the style setting.
"polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
"strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
@@ -516,7 +516,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeWeight": 42, # Width of the polyon border in pixels.
"strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
@@ -542,7 +542,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
"gradient": { # Gradient function that interpolates a range of colors based on column value.
@@ -566,7 +566,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
"strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
@@ -596,7 +596,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeColor": "A String", # Color of the line in #RRGGBB format.
"strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
@@ -622,7 +622,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
},
"tableId": "A String", # Identifier for the table.
@@ -669,11 +669,11 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
},
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
+ "kind": "fusiontables#styleSetting", # The kind of item this is. A StyleSetting contains the style definitions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
"name": "A String", # Optional name for the style setting.
"polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
"strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
@@ -698,7 +698,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeWeight": 42, # Width of the polyon border in pixels.
"strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
@@ -724,7 +724,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
"gradient": { # Gradient function that interpolates a range of colors based on column value.
@@ -748,7 +748,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
"strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
@@ -778,7 +778,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeColor": "A String", # Color of the line in #RRGGBB format.
"strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
@@ -804,14 +804,14 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
},
"tableId": "A String", # Identifier for the table.
"styleId": 42, # Identifier for the style setting (unique only within tables).
},
],
- "kind": "fusiontables#styleSettingList", # Type name: in this case, a list of style settings.
+ "kind": "fusiontables#styleSettingList", # The kind of item this is. For a style list, this is always fusiontables#styleSettingList .
"totalItems": 42, # Total number of styles for the table.
}</pre>
</div>
@@ -864,11 +864,11 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
},
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
+ "kind": "fusiontables#styleSetting", # The kind of item this is. A StyleSetting contains the style definitions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
"name": "A String", # Optional name for the style setting.
"polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
"strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
@@ -893,7 +893,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeWeight": 42, # Width of the polyon border in pixels.
"strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
@@ -919,7 +919,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
"gradient": { # Gradient function that interpolates a range of colors based on column value.
@@ -943,7 +943,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
"strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
@@ -973,7 +973,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeColor": "A String", # Color of the line in #RRGGBB format.
"strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
@@ -999,7 +999,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
},
"tableId": "A String", # Identifier for the table.
@@ -1034,11 +1034,11 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
},
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
+ "kind": "fusiontables#styleSetting", # The kind of item this is. A StyleSetting contains the style definitions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
"name": "A String", # Optional name for the style setting.
"polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
"strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
@@ -1063,7 +1063,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeWeight": 42, # Width of the polyon border in pixels.
"strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
@@ -1089,7 +1089,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
"gradient": { # Gradient function that interpolates a range of colors based on column value.
@@ -1113,7 +1113,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
"strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
@@ -1143,7 +1143,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeColor": "A String", # Color of the line in #RRGGBB format.
"strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
@@ -1169,7 +1169,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
},
"tableId": "A String", # Identifier for the table.
@@ -1211,11 +1211,11 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
},
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
+ "kind": "fusiontables#styleSetting", # The kind of item this is. A StyleSetting contains the style definitions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
"name": "A String", # Optional name for the style setting.
"polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
"strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
@@ -1240,7 +1240,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeWeight": 42, # Width of the polyon border in pixels.
"strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
@@ -1266,7 +1266,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
"gradient": { # Gradient function that interpolates a range of colors based on column value.
@@ -1290,7 +1290,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
"strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
@@ -1320,7 +1320,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeColor": "A String", # Color of the line in #RRGGBB format.
"strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
@@ -1346,7 +1346,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
},
"tableId": "A String", # Identifier for the table.
@@ -1381,11 +1381,11 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
},
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
+ "kind": "fusiontables#styleSetting", # The kind of item this is. A StyleSetting contains the style definitions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
"name": "A String", # Optional name for the style setting.
"polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
"strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
@@ -1410,7 +1410,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeWeight": 42, # Width of the polyon border in pixels.
"strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
@@ -1436,7 +1436,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
"gradient": { # Gradient function that interpolates a range of colors based on column value.
@@ -1460,7 +1460,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
"strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
@@ -1490,7 +1490,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
"strokeColor": "A String", # Color of the line in #RRGGBB format.
"strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
@@ -1516,7 +1516,7 @@
"icon": "A String", # Icon name used for a point.
},
],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
+ "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls.
},
},
"tableId": "A String", # Identifier for the table.
diff --git a/docs/dyn/fusiontables_v2.table.html b/docs/dyn/fusiontables_v2.table.html
index 9be0397..04969af 100644
--- a/docs/dyn/fusiontables_v2.table.html
+++ b/docs/dyn/fusiontables_v2.table.html
@@ -82,13 +82,13 @@
<p class="firstline">Deletes a table.</p>
<p class="toc_element">
<code><a href="#get">get(tableId)</a></code></p>
-<p class="firstline">Retrieves a specific table by its id.</p>
+<p class="firstline">Retrieves a specific table by its ID.</p>
<p class="toc_element">
<code><a href="#importRows">importRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, delimiter=None, endLine=None)</a></code></p>
-<p class="firstline">Import more rows into a table.</p>
+<p class="firstline">Imports more rows into a table.</p>
<p class="toc_element">
<code><a href="#importTable">importTable(name, media_body=None, encoding=None, delimiter=None)</a></code></p>
-<p class="firstline">Import a new table.</p>
+<p class="firstline">Imports a new table.</p>
<p class="toc_element">
<code><a href="#insert">insert(body)</a></code></p>
<p class="firstline">Creates a new table.</p>
@@ -121,7 +121,7 @@
{ # Represents a table.
"tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
+ "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
"attribution": "A String", # Attribution assigned to the table.
"description": "A String", # Description assigned to the table.
"columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
@@ -137,8 +137,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -150,6 +150,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -165,23 +166,23 @@
<pre>Deletes a table.
Args:
- tableId: string, ID of the table that is being deleted. (required)
+ tableId: string, ID of the table to be deleted. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(tableId)</code>
- <pre>Retrieves a specific table by its id.
+ <pre>Retrieves a specific table by its ID.
Args:
- tableId: string, Identifier(ID) for the table being requested. (required)
+ tableId: string, Identifier for the table being requested. (required)
Returns:
An object of the form:
{ # Represents a table.
"tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
+ "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
"attribution": "A String", # Attribution assigned to the table.
"description": "A String", # Description assigned to the table.
"columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
@@ -197,8 +198,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -210,6 +211,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -222,42 +224,42 @@
<div class="method">
<code class="details" id="importRows">importRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, delimiter=None, endLine=None)</code>
- <pre>Import more rows into a table.
+ <pre>Imports more rows into a table.
Args:
tableId: string, The table into which new rows are being imported. (required)
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
startLine: integer, The index of the first line from which to start importing, inclusive. Default is 0.
- isStrict: boolean, Whether the CSV must have the same number of values for each row. If false, rows with fewer values will be padded with empty values. Default is true.
- encoding: string, The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding.
- delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ','.
- endLine: integer, The index of the last line from which to start importing, exclusive. Thus, the number of imported lines is endLine - startLine. If this parameter is not provided, the file will be imported until the last line of the file. If endLine is negative, then the imported content will exclude the last endLine lines. That is, if endline is negative, no line will be imported whose index is greater than N + endLine where N is the number of lines in the file, and the number of imported lines will be N + endLine - startLine.
+ isStrict: boolean, Whether the imported CSV must have the same number of values for each row. If false, rows with fewer values will be padded with empty values. Default is true.
+ encoding: string, The encoding of the content. Default is UTF-8. Use auto-detect if you are unsure of the encoding.
+ delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ,.
+ endLine: integer, The index of the line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines.
Returns:
An object of the form:
{ # Represents an import request.
"numRowsReceived": "A String", # The number of rows received from the import request.
- "kind": "fusiontables#import", # Type name: a template for an import request.
+ "kind": "fusiontables#import", # The kind of item this is. For an import, this is always fusiontables#import.
}</pre>
</div>
<div class="method">
<code class="details" id="importTable">importTable(name, media_body=None, encoding=None, delimiter=None)</code>
- <pre>Import a new table.
+ <pre>Imports a new table.
Args:
name: string, The name to be assigned to the new table. (required)
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- encoding: string, The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding.
- delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ','.
+ encoding: string, The encoding of the content. Default is UTF-8. Use auto-detect if you are unsure of the encoding.
+ delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ,.
Returns:
An object of the form:
{ # Represents a table.
"tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
+ "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
"attribution": "A String", # Attribution assigned to the table.
"description": "A String", # Description assigned to the table.
"columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
@@ -273,8 +275,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -286,6 +288,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -306,7 +309,7 @@
{ # Represents a table.
"tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
+ "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
"attribution": "A String", # Attribution assigned to the table.
"description": "A String", # Description assigned to the table.
"columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
@@ -322,8 +325,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -335,6 +338,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -350,7 +354,7 @@
{ # Represents a table.
"tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
+ "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
"attribution": "A String", # Attribution assigned to the table.
"description": "A String", # Description assigned to the table.
"columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
@@ -366,8 +370,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -379,6 +383,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -394,18 +399,18 @@
<pre>Retrieves a list of tables a user owns.
Args:
- pageToken: string, Continuation token specifying which result page to return. Optional.
- maxResults: integer, Maximum number of styles to return. Optional. Default is 5.
+ pageToken: string, Continuation token specifying which result page to return.
+ maxResults: integer, Maximum number of tables to return. Default is 5.
Returns:
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.
"tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
+ "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
"attribution": "A String", # Attribution assigned to the table.
"description": "A String", # Description assigned to the table.
"columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
@@ -421,8 +426,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -434,6 +439,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -443,7 +449,7 @@
"name": "A String", # Name assigned to a table.
},
],
- "kind": "fusiontables#tableList", # Type name: a list of all tables.
+ "kind": "fusiontables#tableList", # The kind of item this is. For table list, this is always fusiontables#tableList.
}</pre>
</div>
@@ -472,7 +478,7 @@
{ # Represents a table.
"tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
+ "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
"attribution": "A String", # Attribution assigned to the table.
"description": "A String", # Description assigned to the table.
"columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
@@ -488,8 +494,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -501,6 +507,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -510,14 +517,14 @@
"name": "A String", # Name assigned to a table.
}
- replaceViewDefinition: boolean, Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition.
+ replaceViewDefinition: boolean, Whether the view definition is also updated. The specified view definition replaces the existing one. Only a view can be updated with a new definition.
Returns:
An object of the form:
{ # Represents a table.
"tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
+ "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
"attribution": "A String", # Attribution assigned to the table.
"description": "A String", # Description assigned to the table.
"columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
@@ -533,8 +540,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -546,6 +553,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -564,19 +572,19 @@
tableId: string, Table whose rows will be replaced. (required)
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
startLine: integer, The index of the first line from which to start importing, inclusive. Default is 0.
- isStrict: boolean, Whether the CSV must have the same number of column values for each row. If true, throws an exception if the CSV does not not have the same number of columns. If false, rows with fewer column values will be padded with empty values. Default is true.
+ isStrict: boolean, Whether the imported CSV must have the same number of column values for each row. If true, throws an exception if the CSV does not have the same number of columns. If false, rows with fewer column values will be padded with empty values. Default is true.
encoding: string, The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding.
- delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ','.
- endLine: integer, The index of the last line to import, exclusive. 'endLine - startLine' rows will be imported. Default is to import through the end of the file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines.
+ delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ,.
+ endLine: integer, The index of the line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines.
Returns:
An object of the form:
- { # A background task on a table, initiated for time and or resource consuming operations such as a column type change or delete all rows operation.
- "started": True or False, # True if the task is in progress, its progress indicator will indicated where it is, and it can't be deleted.
+ { # A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows.
+ "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", # Task percentage completion.
- "kind": "fusiontables#task", # Type name: a template for an individual task.
- "type": "A String", # The type of task being executed in the background.
+ "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
+ "type": "A String", # Type of background task.
"taskId": "A String", # Identifier for the task.
}</pre>
</div>
@@ -592,7 +600,7 @@
{ # Represents a table.
"tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
+ "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
"attribution": "A String", # Attribution assigned to the table.
"description": "A String", # Description assigned to the table.
"columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
@@ -608,8 +616,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -621,6 +629,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
@@ -630,14 +639,14 @@
"name": "A String", # Name assigned to a table.
}
- replaceViewDefinition: boolean, Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition.
+ replaceViewDefinition: boolean, Whether the view definition is also updated. The specified view definition replaces the existing one. Only a view can be updated with a new definition.
Returns:
An object of the form:
{ # Represents a table.
"tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
+ "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
"attribution": "A String", # Attribution assigned to the table.
"description": "A String", # Description assigned to the table.
"columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
@@ -653,8 +662,8 @@
{ # Specifies the details of a column in a table.
"graphPredicate": "A String", # Column graph predicate.
# Used to map table to graph data model (subject,predicate,object)
- # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
- "kind": "fusiontables#column", # Type name: a template for an individual column.
+ # See W3C Graph-based Data Model.
+ "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
"validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
"A String",
],
@@ -666,6 +675,7 @@
"name": "A String", # Name of the column.
"columnPropertiesJson": "A String", # JSON object containing custom column properties.
"formatPattern": "A String", # Format pattern.
+ # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows JSON editing of text in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
"columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
"type": "A String", # Type of the column.
"validateData": True or False, # If true, data entered via the web application is validated.
diff --git a/docs/dyn/fusiontables_v2.task.html b/docs/dyn/fusiontables_v2.task.html
index 2884501..55e2a3e 100644
--- a/docs/dyn/fusiontables_v2.task.html
+++ b/docs/dyn/fusiontables_v2.task.html
@@ -76,10 +76,10 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(tableId, taskId)</a></code></p>
-<p class="firstline">Deletes the task, unless already started.</p>
+<p class="firstline">Deletes a specific task by its ID, unless that task has already started running.</p>
<p class="toc_element">
<code><a href="#get">get(tableId, taskId)</a></code></p>
-<p class="firstline">Retrieves a specific task by its id.</p>
+<p class="firstline">Retrieves a specific task by its ID.</p>
<p class="toc_element">
<code><a href="#list">list(tableId, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
<p class="firstline">Retrieves a list of tasks.</p>
@@ -89,30 +89,30 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(tableId, taskId)</code>
- <pre>Deletes the task, unless already started.
+ <pre>Deletes a specific task by its ID, unless that task has already started running.
Args:
tableId: string, Table from which the task is being deleted. (required)
- taskId: string, A parameter (required)
+ taskId: string, The identifier of the task to delete. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(tableId, taskId)</code>
- <pre>Retrieves a specific task by its id.
+ <pre>Retrieves a specific task by its ID.
Args:
tableId: string, Table to which the task belongs. (required)
- taskId: string, A parameter (required)
+ taskId: string, The identifier of the task to get. (required)
Returns:
An object of the form:
- { # A background task on a table, initiated for time and or resource consuming operations such as a column type change or delete all rows operation.
- "started": True or False, # True if the task is in progress, its progress indicator will indicated where it is, and it can't be deleted.
+ { # A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows.
+ "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", # Task percentage completion.
- "kind": "fusiontables#task", # Type name: a template for an individual task.
- "type": "A String", # The type of task being executed in the background.
+ "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
+ "type": "A String", # Type of background task.
"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.
- { # A background task on a table, initiated for time and or resource consuming operations such as a column type change or delete all rows operation.
- "started": True or False, # True if the task is in progress, its progress indicator will indicated where it is, and it can't be deleted.
+ { # A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows.
+ "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", # Task percentage completion.
- "kind": "fusiontables#task", # Type name: a template for an individual task.
- "type": "A String", # The type of task being executed in the background.
+ "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
+ "type": "A String", # Type of background task.
"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_v2.template.html b/docs/dyn/fusiontables_v2.template.html
index 7652798..490c4b2 100644
--- a/docs/dyn/fusiontables_v2.template.html
+++ b/docs/dyn/fusiontables_v2.template.html
@@ -119,7 +119,7 @@
{ # 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.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
+ "kind": "fusiontables#template", # The kind of item this is. For a template, this is always fusiontables#template.
"name": "A String", # Optional name assigned to a template.
"automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
"A String",
@@ -140,7 +140,7 @@
{ # 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.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
+ "kind": "fusiontables#template", # The kind of item this is. For a template, this is always fusiontables#template.
"name": "A String", # Optional name assigned to a template.
"automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
"A String",
@@ -155,7 +155,7 @@
{ # 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.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
+ "kind": "fusiontables#template", # The kind of item this is. For a template, this is always fusiontables#template.
"name": "A String", # Optional name assigned to a template.
"automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
"A String",
@@ -178,11 +178,11 @@
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.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
+ "kind": "fusiontables#template", # The kind of item this is. For a template, this is always fusiontables#template.
"name": "A String", # Optional name assigned to a template.
"automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
"A String",
@@ -191,7 +191,7 @@
"templateId": 42, # Identifier for the template, unique within the context of a particular table.
},
],
- "kind": "fusiontables#templateList", # Type name: a list of all templates.
+ "kind": "fusiontables#templateList", # The kind of item this is. For a template list, this is always fusiontables#templateList .
"totalItems": 42, # Total number of templates for the table.
}</pre>
</div>
@@ -222,7 +222,7 @@
{ # 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.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
+ "kind": "fusiontables#template", # The kind of item this is. For a template, this is always fusiontables#template.
"name": "A String", # Optional name assigned to a template.
"automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
"A String",
@@ -237,7 +237,7 @@
{ # 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.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
+ "kind": "fusiontables#template", # The kind of item this is. For a template, this is always fusiontables#template.
"name": "A String", # Optional name assigned to a template.
"automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
"A String",
@@ -259,7 +259,7 @@
{ # 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.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
+ "kind": "fusiontables#template", # The kind of item this is. For a template, this is always fusiontables#template.
"name": "A String", # Optional name assigned to a template.
"automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
"A String",
@@ -274,7 +274,7 @@
{ # 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.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
+ "kind": "fusiontables#template", # The kind of item this is. For a template, this is always fusiontables#template.
"name": "A String", # Optional name assigned to a template.
"automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
"A String",
diff --git a/docs/dyn/gamesConfiguration_v1configuration.html b/docs/dyn/gamesConfiguration_v1configuration.html
index e8926f2..1f15400 100644
--- a/docs/dyn/gamesConfiguration_v1configuration.html
+++ b/docs/dyn/gamesConfiguration_v1configuration.html
@@ -89,4 +89,25 @@
</p>
<p class="firstline">Returns the leaderboardConfigurations 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/gamesManagement_v1management.html b/docs/dyn/gamesManagement_v1management.html
index 97b01b0..136025e 100644
--- a/docs/dyn/gamesManagement_v1management.html
+++ b/docs/dyn/gamesManagement_v1management.html
@@ -114,4 +114,25 @@
</p>
<p class="firstline">Returns the turnBasedMatches 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/games_v1.html b/docs/dyn/games_v1.html
index 9c3a051..9a530ea 100644
--- a/docs/dyn/games_v1.html
+++ b/docs/dyn/games_v1.html
@@ -149,4 +149,25 @@
</p>
<p class="firstline">Returns the turnBasedMatches 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/gan_v1beta1.html b/docs/dyn/gan_v1beta1.html
index 10402cc..a51a20f 100644
--- a/docs/dyn/gan_v1beta1.html
+++ b/docs/dyn/gan_v1beta1.html
@@ -104,4 +104,25 @@
</p>
<p class="firstline">Returns the reports 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/genomics_v1.html b/docs/dyn/genomics_v1.html
new file mode 100644
index 0000000..523caee
--- /dev/null
+++ b/docs/dyn/genomics_v1.html
@@ -0,0 +1,98 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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_v1.html">Genomics API</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>
+<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/genomics_v1beta2.annotationSets.html b/docs/dyn/genomics_v1beta2.annotationSets.html
index 2667900..01b14da 100644
--- a/docs/dyn/genomics_v1beta2.annotationSets.html
+++ b/docs/dyn/genomics_v1beta2.annotationSets.html
@@ -88,7 +88,7 @@
<p class="firstline">Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#search">search(body)</a></code></p>
-<p class="firstline">Searches for annotation sets which match the given criteria. Results are returned in a deterministic order. Caller must have READ permission for the queried datasets.</p>
+<p class="firstline">Searches for annotation sets that match the given criteria. Results are returned in a deterministic order. Caller must have READ permission for the queried datasets.</p>
<p class="toc_element">
<code><a href="#update">update(annotationSetId, body)</a></code></p>
<p class="firstline">Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.</p>
@@ -101,8 +101,8 @@
body: object, The request body. (required)
The object takes the form of:
-{ # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
- "info": { # A map of additional data for this annotation set.
+{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -110,7 +110,7 @@
"name": "A String", # The display name for this annotation set.
"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
"type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
"id": "A String", # The generated unique ID for this annotation set.
"datasetId": "A String", # The ID of the containing dataset.
}
@@ -119,8 +119,8 @@
Returns:
An object of the form:
- { # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
- "info": { # A map of additional data for this annotation set.
+ { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -128,7 +128,7 @@
"name": "A String", # The display name for this annotation set.
"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
"type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
"id": "A String", # The generated unique ID for this annotation set.
"datasetId": "A String", # The ID of the containing dataset.
}</pre>
@@ -153,8 +153,8 @@
Returns:
An object of the form:
- { # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
- "info": { # A map of additional data for this annotation set.
+ { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -162,7 +162,7 @@
"name": "A String", # The display name for this annotation set.
"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
"type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
"id": "A String", # The generated unique ID for this annotation set.
"datasetId": "A String", # The ID of the containing dataset.
}</pre>
@@ -177,8 +177,8 @@
body: object, The request body. (required)
The object takes the form of:
-{ # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
- "info": { # A map of additional data for this annotation set.
+{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -186,7 +186,7 @@
"name": "A String", # The display name for this annotation set.
"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
"type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
"id": "A String", # The generated unique ID for this annotation set.
"datasetId": "A String", # The ID of the containing dataset.
}
@@ -195,8 +195,8 @@
Returns:
An object of the form:
- { # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
- "info": { # A map of additional data for this annotation set.
+ { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -204,7 +204,7 @@
"name": "A String", # The display name for this annotation set.
"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
"type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
"id": "A String", # The generated unique ID for this annotation set.
"datasetId": "A String", # The ID of the containing dataset.
}</pre>
@@ -212,7 +212,7 @@
<div class="method">
<code class="details" id="search">search(body)</code>
- <pre>Searches for annotation sets which match the given criteria. Results are returned in a deterministic order. Caller must have READ permission for the queried datasets.
+ <pre>Searches for annotation sets that match the given criteria. Results are returned in a deterministic order. Caller must have READ permission for the queried datasets.
Args:
body: object, The request body. (required)
@@ -226,7 +226,7 @@
],
"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.
"referenceSetId": "A String", # If specified, only annotation sets associated with the given reference set are returned.
- "types": [ # If specified, only annotation sets which have any of these types are returned.
+ "types": [ # If specified, only annotation sets that have any of these types are returned.
"A String",
],
}
@@ -238,8 +238,8 @@
{
"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.
"annotationSets": [ # The matching annotation sets.
- { # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
- "info": { # A map of additional data for this annotation set.
+ { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -247,7 +247,7 @@
"name": "A String", # The display name for this annotation set.
"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
"type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
"id": "A String", # The generated unique ID for this annotation set.
"datasetId": "A String", # The ID of the containing dataset.
},
@@ -264,8 +264,8 @@
body: object, The request body. (required)
The object takes the form of:
-{ # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
- "info": { # A map of additional data for this annotation set.
+{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -273,7 +273,7 @@
"name": "A String", # The display name for this annotation set.
"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
"type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
"id": "A String", # The generated unique ID for this annotation set.
"datasetId": "A String", # The ID of the containing dataset.
}
@@ -282,8 +282,8 @@
Returns:
An object of the form:
- { # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
- "info": { # A map of additional data for this annotation set.
+ { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -291,7 +291,7 @@
"name": "A String", # The display name for this annotation set.
"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
"type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
"id": "A String", # The generated unique ID for this annotation set.
"datasetId": "A String", # The ID of the containing dataset.
}</pre>
diff --git a/docs/dyn/genomics_v1beta2.annotations.html b/docs/dyn/genomics_v1beta2.annotations.html
index 4926994..4ab30d7 100644
--- a/docs/dyn/genomics_v1beta2.annotations.html
+++ b/docs/dyn/genomics_v1beta2.annotations.html
@@ -91,7 +91,7 @@
<p class="firstline">Updates an annotation. The update must respect all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#search">search(body)</a></code></p>
-<p class="firstline">Searches for annotations which match the given criteria. Results are returned ordered by start position. Annotations which have matching start positions are ordered deterministically. Caller must have READ permission for the queried annotation sets.</p>
+<p class="firstline">Searches for annotations that match the given criteria. Results are returned ordered by start position. Annotations that have matching start positions are ordered deterministically. Caller must have READ permission for the queried annotation sets.</p>
<p class="toc_element">
<code><a href="#update">update(annotationId, body)</a></code></p>
<p class="firstline">Updates an annotation. The update must respect all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset.</p>
@@ -109,18 +109,18 @@
{
"annotations": [ # The annotations to be created. At most 4096 can be specified in a single request.
- { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample/individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
- "info": { # A map of additional data for this annotation.
+ { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The display name of this annotation.
"type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
- "variant": { # A Variant annotation. # A variant annotation which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
+ "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
"type": "A String", # Type has been adapted from ClinVar's list of variant types.
"effect": "A String", # Effect of the variant on the coding sequence.
- "transcriptIds": [ # Google annotation ID of the transcripts affected by this variant. These should be provided when the variant is created.
+ "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
"A String",
],
"alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
@@ -129,7 +129,7 @@
{
"conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
"omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
- "externalIds": [ # The set of external ids for this condition.
+ "externalIds": [ # The set of external IDs for this condition.
{
"sourceName": "A String", # The name of the source of this data.
"id": "A String", # The id used by the source of this data.
@@ -150,7 +150,7 @@
"reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
"referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
},
- "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternate splicing pattern would be represented as separate transcript object. This field is only set for annotations of type TRANSCRIPT.
+ "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
"codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
#
# Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
@@ -158,10 +158,10 @@
"end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
},
"geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
- "exons": [ # The exons which compose this transcript. Exons are the pieces of the transcript which are spliced together, may be exported from a cell's nucleus, and may then be translated to protein. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
+ "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
#
#
- # Introns are regions of the transcript which are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript which are not exons are introns.
+ # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
#
#
# Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
@@ -170,9 +170,11 @@
# Exons are ordered by start position and may not overlap.
{
"start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
- "frame": { # Wrapper message for int32. # The frame of this exon. Contains a value of 0, 1, or 2 which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
+ "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
#
# Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
+ #
+ # The JSON representation for `Int32Value` is JSON number.
"value": 42, # The int32 value.
},
"end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
@@ -195,18 +197,18 @@
"message": "A String", # Error message for this status, if any.
"code": 42, # The HTTP status code for this operation.
},
- "annotation": { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample/individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'. # The annotation, if any.
- "info": { # A map of additional data for this annotation.
+ "annotation": { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'. # The annotation, if any.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The display name of this annotation.
"type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
- "variant": { # A Variant annotation. # A variant annotation which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
+ "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
"type": "A String", # Type has been adapted from ClinVar's list of variant types.
"effect": "A String", # Effect of the variant on the coding sequence.
- "transcriptIds": [ # Google annotation ID of the transcripts affected by this variant. These should be provided when the variant is created.
+ "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
"A String",
],
"alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
@@ -215,7 +217,7 @@
{
"conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
"omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
- "externalIds": [ # The set of external ids for this condition.
+ "externalIds": [ # The set of external IDs for this condition.
{
"sourceName": "A String", # The name of the source of this data.
"id": "A String", # The id used by the source of this data.
@@ -236,7 +238,7 @@
"reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
"referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
},
- "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternate splicing pattern would be represented as separate transcript object. This field is only set for annotations of type TRANSCRIPT.
+ "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
"codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
#
# Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
@@ -244,10 +246,10 @@
"end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
},
"geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
- "exons": [ # The exons which compose this transcript. Exons are the pieces of the transcript which are spliced together, may be exported from a cell's nucleus, and may then be translated to protein. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
+ "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
#
#
- # Introns are regions of the transcript which are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript which are not exons are introns.
+ # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
#
#
# Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
@@ -256,9 +258,11 @@
# Exons are ordered by start position and may not overlap.
{
"start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
- "frame": { # Wrapper message for int32. # The frame of this exon. Contains a value of 0, 1, or 2 which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
+ "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
#
# Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
+ #
+ # The JSON representation for `Int32Value` is JSON number.
"value": 42, # The int32 value.
},
"end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
@@ -280,18 +284,18 @@
body: object, The request body. (required)
The object takes the form of:
-{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample/individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
- "info": { # A map of additional data for this annotation.
+{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The display name of this annotation.
"type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
- "variant": { # A Variant annotation. # A variant annotation which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
+ "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
"type": "A String", # Type has been adapted from ClinVar's list of variant types.
"effect": "A String", # Effect of the variant on the coding sequence.
- "transcriptIds": [ # Google annotation ID of the transcripts affected by this variant. These should be provided when the variant is created.
+ "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
"A String",
],
"alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
@@ -300,7 +304,7 @@
{
"conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
"omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
- "externalIds": [ # The set of external ids for this condition.
+ "externalIds": [ # The set of external IDs for this condition.
{
"sourceName": "A String", # The name of the source of this data.
"id": "A String", # The id used by the source of this data.
@@ -321,7 +325,7 @@
"reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
"referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
},
- "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternate splicing pattern would be represented as separate transcript object. This field is only set for annotations of type TRANSCRIPT.
+ "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
"codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
#
# Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
@@ -329,10 +333,10 @@
"end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
},
"geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
- "exons": [ # The exons which compose this transcript. Exons are the pieces of the transcript which are spliced together, may be exported from a cell's nucleus, and may then be translated to protein. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
+ "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
#
#
- # Introns are regions of the transcript which are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript which are not exons are introns.
+ # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
#
#
# Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
@@ -341,9 +345,11 @@
# Exons are ordered by start position and may not overlap.
{
"start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
- "frame": { # Wrapper message for int32. # The frame of this exon. Contains a value of 0, 1, or 2 which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
+ "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
#
# Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
+ #
+ # The JSON representation for `Int32Value` is JSON number.
"value": 42, # The int32 value.
},
"end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
@@ -357,18 +363,18 @@
Returns:
An object of the form:
- { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample/individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
- "info": { # A map of additional data for this annotation.
+ { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The display name of this annotation.
"type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
- "variant": { # A Variant annotation. # A variant annotation which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
+ "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
"type": "A String", # Type has been adapted from ClinVar's list of variant types.
"effect": "A String", # Effect of the variant on the coding sequence.
- "transcriptIds": [ # Google annotation ID of the transcripts affected by this variant. These should be provided when the variant is created.
+ "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
"A String",
],
"alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
@@ -377,7 +383,7 @@
{
"conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
"omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
- "externalIds": [ # The set of external ids for this condition.
+ "externalIds": [ # The set of external IDs for this condition.
{
"sourceName": "A String", # The name of the source of this data.
"id": "A String", # The id used by the source of this data.
@@ -398,7 +404,7 @@
"reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
"referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
},
- "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternate splicing pattern would be represented as separate transcript object. This field is only set for annotations of type TRANSCRIPT.
+ "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
"codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
#
# Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
@@ -406,10 +412,10 @@
"end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
},
"geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
- "exons": [ # The exons which compose this transcript. Exons are the pieces of the transcript which are spliced together, may be exported from a cell's nucleus, and may then be translated to protein. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
+ "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
#
#
- # Introns are regions of the transcript which are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript which are not exons are introns.
+ # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
#
#
# Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
@@ -418,9 +424,11 @@
# Exons are ordered by start position and may not overlap.
{
"start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
- "frame": { # Wrapper message for int32. # The frame of this exon. Contains a value of 0, 1, or 2 which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
+ "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
#
# Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
+ #
+ # The JSON representation for `Int32Value` is JSON number.
"value": 42, # The int32 value.
},
"end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
@@ -450,18 +458,18 @@
Returns:
An object of the form:
- { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample/individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
- "info": { # A map of additional data for this annotation.
+ { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The display name of this annotation.
"type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
- "variant": { # A Variant annotation. # A variant annotation which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
+ "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
"type": "A String", # Type has been adapted from ClinVar's list of variant types.
"effect": "A String", # Effect of the variant on the coding sequence.
- "transcriptIds": [ # Google annotation ID of the transcripts affected by this variant. These should be provided when the variant is created.
+ "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
"A String",
],
"alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
@@ -470,7 +478,7 @@
{
"conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
"omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
- "externalIds": [ # The set of external ids for this condition.
+ "externalIds": [ # The set of external IDs for this condition.
{
"sourceName": "A String", # The name of the source of this data.
"id": "A String", # The id used by the source of this data.
@@ -491,7 +499,7 @@
"reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
"referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
},
- "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternate splicing pattern would be represented as separate transcript object. This field is only set for annotations of type TRANSCRIPT.
+ "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
"codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
#
# Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
@@ -499,10 +507,10 @@
"end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
},
"geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
- "exons": [ # The exons which compose this transcript. Exons are the pieces of the transcript which are spliced together, may be exported from a cell's nucleus, and may then be translated to protein. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
+ "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
#
#
- # Introns are regions of the transcript which are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript which are not exons are introns.
+ # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
#
#
# Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
@@ -511,9 +519,11 @@
# Exons are ordered by start position and may not overlap.
{
"start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
- "frame": { # Wrapper message for int32. # The frame of this exon. Contains a value of 0, 1, or 2 which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
+ "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
#
# Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
+ #
+ # The JSON representation for `Int32Value` is JSON number.
"value": 42, # The int32 value.
},
"end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
@@ -533,18 +543,18 @@
body: object, The request body. (required)
The object takes the form of:
-{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample/individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
- "info": { # A map of additional data for this annotation.
+{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The display name of this annotation.
"type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
- "variant": { # A Variant annotation. # A variant annotation which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
+ "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
"type": "A String", # Type has been adapted from ClinVar's list of variant types.
"effect": "A String", # Effect of the variant on the coding sequence.
- "transcriptIds": [ # Google annotation ID of the transcripts affected by this variant. These should be provided when the variant is created.
+ "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
"A String",
],
"alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
@@ -553,7 +563,7 @@
{
"conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
"omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
- "externalIds": [ # The set of external ids for this condition.
+ "externalIds": [ # The set of external IDs for this condition.
{
"sourceName": "A String", # The name of the source of this data.
"id": "A String", # The id used by the source of this data.
@@ -574,7 +584,7 @@
"reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
"referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
},
- "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternate splicing pattern would be represented as separate transcript object. This field is only set for annotations of type TRANSCRIPT.
+ "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
"codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
#
# Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
@@ -582,10 +592,10 @@
"end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
},
"geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
- "exons": [ # The exons which compose this transcript. Exons are the pieces of the transcript which are spliced together, may be exported from a cell's nucleus, and may then be translated to protein. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
+ "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
#
#
- # Introns are regions of the transcript which are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript which are not exons are introns.
+ # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
#
#
# Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
@@ -594,9 +604,11 @@
# Exons are ordered by start position and may not overlap.
{
"start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
- "frame": { # Wrapper message for int32. # The frame of this exon. Contains a value of 0, 1, or 2 which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
+ "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
#
# Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
+ #
+ # The JSON representation for `Int32Value` is JSON number.
"value": 42, # The int32 value.
},
"end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
@@ -610,18 +622,18 @@
Returns:
An object of the form:
- { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample/individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
- "info": { # A map of additional data for this annotation.
+ { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The display name of this annotation.
"type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
- "variant": { # A Variant annotation. # A variant annotation which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
+ "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
"type": "A String", # Type has been adapted from ClinVar's list of variant types.
"effect": "A String", # Effect of the variant on the coding sequence.
- "transcriptIds": [ # Google annotation ID of the transcripts affected by this variant. These should be provided when the variant is created.
+ "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
"A String",
],
"alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
@@ -630,7 +642,7 @@
{
"conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
"omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
- "externalIds": [ # The set of external ids for this condition.
+ "externalIds": [ # The set of external IDs for this condition.
{
"sourceName": "A String", # The name of the source of this data.
"id": "A String", # The id used by the source of this data.
@@ -651,7 +663,7 @@
"reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
"referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
},
- "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternate splicing pattern would be represented as separate transcript object. This field is only set for annotations of type TRANSCRIPT.
+ "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
"codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
#
# Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
@@ -659,10 +671,10 @@
"end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
},
"geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
- "exons": [ # The exons which compose this transcript. Exons are the pieces of the transcript which are spliced together, may be exported from a cell's nucleus, and may then be translated to protein. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
+ "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
#
#
- # Introns are regions of the transcript which are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript which are not exons are introns.
+ # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
#
#
# Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
@@ -671,9 +683,11 @@
# Exons are ordered by start position and may not overlap.
{
"start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
- "frame": { # Wrapper message for int32. # The frame of this exon. Contains a value of 0, 1, or 2 which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
+ "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
#
# Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
+ #
+ # The JSON representation for `Int32Value` is JSON number.
"value": 42, # The int32 value.
},
"end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
@@ -686,7 +700,7 @@
<div class="method">
<code class="details" id="search">search(body)</code>
- <pre>Searches for annotations which match the given criteria. Results are returned ordered by start position. Annotations which have matching start positions are ordered deterministically. Caller must have READ permission for the queried annotation sets.
+ <pre>Searches for annotations that match the given criteria. Results are returned ordered by start position. Annotations that have matching start positions are ordered deterministically. Caller must have READ permission for the queried annotation sets.
Args:
body: object, The request body. (required)
@@ -694,7 +708,7 @@
{
"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.
- "range": { # A 0-based half-open genomic coordinate range for search requests. # If specified, this query matches only annotations which overlap this range.
+ "range": { # A 0-based half-open genomic coordinate range for search requests. # If specified, this query matches only annotations that overlap this range.
"start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, referenceId or referenceName must also be specified. Defaults to 0.
"referenceId": "A String", # The ID of the reference to query. At most one of referenceId and referenceName should be specified.
"end": "A String", # The end position of the range on the reference, 0-based exclusive. If specified, referenceId or referenceName must also be specified. If unset or 0, defaults to the length of the reference.
@@ -713,18 +727,18 @@
{
"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.
"annotations": [ # The matching annotations.
- { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample/individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
- "info": { # A map of additional data for this annotation.
+ { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The display name of this annotation.
"type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
- "variant": { # A Variant annotation. # A variant annotation which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
+ "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
"type": "A String", # Type has been adapted from ClinVar's list of variant types.
"effect": "A String", # Effect of the variant on the coding sequence.
- "transcriptIds": [ # Google annotation ID of the transcripts affected by this variant. These should be provided when the variant is created.
+ "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
"A String",
],
"alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
@@ -733,7 +747,7 @@
{
"conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
"omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
- "externalIds": [ # The set of external ids for this condition.
+ "externalIds": [ # The set of external IDs for this condition.
{
"sourceName": "A String", # The name of the source of this data.
"id": "A String", # The id used by the source of this data.
@@ -754,7 +768,7 @@
"reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
"referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
},
- "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternate splicing pattern would be represented as separate transcript object. This field is only set for annotations of type TRANSCRIPT.
+ "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
"codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
#
# Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
@@ -762,10 +776,10 @@
"end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
},
"geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
- "exons": [ # The exons which compose this transcript. Exons are the pieces of the transcript which are spliced together, may be exported from a cell's nucleus, and may then be translated to protein. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
+ "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
#
#
- # Introns are regions of the transcript which are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript which are not exons are introns.
+ # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
#
#
# Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
@@ -774,9 +788,11 @@
# Exons are ordered by start position and may not overlap.
{
"start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
- "frame": { # Wrapper message for int32. # The frame of this exon. Contains a value of 0, 1, or 2 which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
+ "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
#
# Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
+ #
+ # The JSON representation for `Int32Value` is JSON number.
"value": 42, # The int32 value.
},
"end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
@@ -798,18 +814,18 @@
body: object, The request body. (required)
The object takes the form of:
-{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample/individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
- "info": { # A map of additional data for this annotation.
+{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The display name of this annotation.
"type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
- "variant": { # A Variant annotation. # A variant annotation which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
+ "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
"type": "A String", # Type has been adapted from ClinVar's list of variant types.
"effect": "A String", # Effect of the variant on the coding sequence.
- "transcriptIds": [ # Google annotation ID of the transcripts affected by this variant. These should be provided when the variant is created.
+ "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
"A String",
],
"alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
@@ -818,7 +834,7 @@
{
"conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
"omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
- "externalIds": [ # The set of external ids for this condition.
+ "externalIds": [ # The set of external IDs for this condition.
{
"sourceName": "A String", # The name of the source of this data.
"id": "A String", # The id used by the source of this data.
@@ -839,7 +855,7 @@
"reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
"referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
},
- "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternate splicing pattern would be represented as separate transcript object. This field is only set for annotations of type TRANSCRIPT.
+ "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
"codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
#
# Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
@@ -847,10 +863,10 @@
"end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
},
"geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
- "exons": [ # The exons which compose this transcript. Exons are the pieces of the transcript which are spliced together, may be exported from a cell's nucleus, and may then be translated to protein. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
+ "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
#
#
- # Introns are regions of the transcript which are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript which are not exons are introns.
+ # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
#
#
# Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
@@ -859,9 +875,11 @@
# Exons are ordered by start position and may not overlap.
{
"start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
- "frame": { # Wrapper message for int32. # The frame of this exon. Contains a value of 0, 1, or 2 which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
+ "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
#
# Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
+ #
+ # The JSON representation for `Int32Value` is JSON number.
"value": 42, # The int32 value.
},
"end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
@@ -875,18 +893,18 @@
Returns:
An object of the form:
- { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample/individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
- "info": { # A map of additional data for this annotation.
+ { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. A variant annotation is represented by one or more of these canonical types. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are 'Gene' and 'Variant'.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The display name of this annotation.
"type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
- "variant": { # A Variant annotation. # A variant annotation which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
+ "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
"type": "A String", # Type has been adapted from ClinVar's list of variant types.
"effect": "A String", # Effect of the variant on the coding sequence.
- "transcriptIds": [ # Google annotation ID of the transcripts affected by this variant. These should be provided when the variant is created.
+ "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
"A String",
],
"alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
@@ -895,7 +913,7 @@
{
"conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
"omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
- "externalIds": [ # The set of external ids for this condition.
+ "externalIds": [ # The set of external IDs for this condition.
{
"sourceName": "A String", # The name of the source of this data.
"id": "A String", # The id used by the source of this data.
@@ -916,7 +934,7 @@
"reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
"referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
},
- "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternate splicing pattern would be represented as separate transcript object. This field is only set for annotations of type TRANSCRIPT.
+ "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
"codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
#
# Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
@@ -924,10 +942,10 @@
"end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
},
"geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
- "exons": [ # The exons which compose this transcript. Exons are the pieces of the transcript which are spliced together, may be exported from a cell's nucleus, and may then be translated to protein. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
+ "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
#
#
- # Introns are regions of the transcript which are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript which are not exons are introns.
+ # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
#
#
# Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
@@ -936,9 +954,11 @@
# Exons are ordered by start position and may not overlap.
{
"start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
- "frame": { # Wrapper message for int32. # The frame of this exon. Contains a value of 0, 1, or 2 which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
+ "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
#
# Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
+ #
+ # The JSON representation for `Int32Value` is JSON number.
"value": 42, # The int32 value.
},
"end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
diff --git a/docs/dyn/genomics_v1beta2.callsets.html b/docs/dyn/genomics_v1beta2.callsets.html
index 0cdcefc..48c2455 100644
--- a/docs/dyn/genomics_v1beta2.callsets.html
+++ b/docs/dyn/genomics_v1beta2.callsets.html
@@ -102,7 +102,7 @@
The object takes the form of:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
- "info": { # A map of additional call set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -121,7 +121,7 @@
An object of the form:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
- "info": { # A map of additional call set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -156,7 +156,7 @@
An object of the form:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
- "info": { # A map of additional call set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -181,7 +181,7 @@
The object takes the form of:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
- "info": { # A map of additional call set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -200,7 +200,7 @@
An object of the form:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
- "info": { # A map of additional call set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -231,7 +231,7 @@
"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.
+ "pageSize": 42, # The maximum number of call sets to return. If unspecified, defaults to 1000.
}
@@ -242,7 +242,7 @@
"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 call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
- "info": { # A map of additional call set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -269,7 +269,7 @@
The object takes the form of:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
- "info": { # A map of additional call set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -288,7 +288,7 @@
An object of the form:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
- "info": { # A map of additional call set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
diff --git a/docs/dyn/genomics_v1beta2.datasets.html b/docs/dyn/genomics_v1beta2.datasets.html
index 7cfe7e4..8f61601 100644
--- a/docs/dyn/genomics_v1beta2.datasets.html
+++ b/docs/dyn/genomics_v1beta2.datasets.html
@@ -85,7 +85,7 @@
<p class="firstline">Gets a dataset by ID.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, projectNumber=None, pageSize=None)</a></code></p>
-<p class="firstline">Lists all datasets.</p>
+<p class="firstline">Lists datasets within 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>
@@ -155,12 +155,12 @@
<div class="method">
<code class="details" id="list">list(pageToken=None, projectNumber=None, pageSize=None)</code>
- <pre>Lists all datasets.
+ <pre>Lists datasets within a project.
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.
- projectNumber: 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.
- pageSize: integer, The maximum number of results returned by this request.
+ projectNumber: string, The project to list datasets for.
+ pageSize: integer, The maximum number of results returned by this request. If unspecified, defaults to 50.
Returns:
An object of the form:
diff --git a/docs/dyn/genomics_v1beta2.html b/docs/dyn/genomics_v1beta2.html
index f057d43..d98228e 100644
--- a/docs/dyn/genomics_v1beta2.html
+++ b/docs/dyn/genomics_v1beta2.html
@@ -134,4 +134,25 @@
</p>
<p class="firstline">Returns the variantsets 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/genomics_v1beta2.readgroupsets.html b/docs/dyn/genomics_v1beta2.readgroupsets.html
index ea482f3..ca00d29 100644
--- a/docs/dyn/genomics_v1beta2.readgroupsets.html
+++ b/docs/dyn/genomics_v1beta2.readgroupsets.html
@@ -204,14 +204,14 @@
The object takes the form of:
{ # The read group set export request.
- "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.
+ "exportUri": "A String", # Required. A Google Cloud Storage URI for the exported BAM file. The currently authenticated user must have write access to the new file. 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",
],
- "readGroupSetIds": [ # The IDs of the read group sets to export.
+ "readGroupSetIds": [ # Required. The IDs of the read group sets to export.
"A String",
],
- "projectNumber": "A String", # The Google Developers Console project number that owns this export.
+ "projectNumber": "A String", # Required. The Google Developers Console project number that owns this export.
}
@@ -237,7 +237,7 @@
# - A read group set belongs to one dataset.
# - A read group belongs to one read group set.
# - A read belongs to one read group.
- "info": { # A map of additional read group set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -245,7 +245,7 @@
"name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
"readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
{ # A read group is all the data that's processed the same way by the sequencer.
- "info": { # A map of additional read group information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -322,7 +322,7 @@
# - A read group set belongs to one dataset.
# - A read group belongs to one read group set.
# - A read belongs to one read group.
- "info": { # A map of additional read group set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -330,7 +330,7 @@
"name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
"readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
{ # A read group is all the data that's processed the same way by the sequencer.
- "info": { # A map of additional read group information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -373,7 +373,7 @@
# - A read group set belongs to one dataset.
# - A read group belongs to one read group set.
# - A read belongs to one read group.
- "info": { # A map of additional read group set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -381,7 +381,7 @@
"name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
"readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
{ # A read group is all the data that's processed the same way by the sequencer.
- "info": { # A map of additional read group information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -433,7 +433,7 @@
"A String",
],
"name": "A String", # Only return read group sets for which a substring of the name matches this string.
- "pageSize": 42, # Specifies number of results to return in a single page. If unspecified, it will default to 128. The maximum value is 1024.
+ "pageSize": 42, # Specifies number of results to return in a single page. If unspecified, it will default to 256. The maximum value is 1024.
}
@@ -447,7 +447,7 @@
# - A read group set belongs to one dataset.
# - A read group belongs to one read group set.
# - A read belongs to one read group.
- "info": { # A map of additional read group set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -455,7 +455,7 @@
"name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
"readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
{ # A read group is all the data that's processed the same way by the sequencer.
- "info": { # A map of additional read group information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -506,7 +506,7 @@
# - A read group set belongs to one dataset.
# - A read group belongs to one read group set.
# - A read belongs to one read group.
- "info": { # A map of additional read group set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -514,7 +514,7 @@
"name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
"readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
{ # A read group is all the data that's processed the same way by the sequencer.
- "info": { # A map of additional read group information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -557,7 +557,7 @@
# - A read group set belongs to one dataset.
# - A read group belongs to one read group set.
# - A read belongs to one read group.
- "info": { # A map of additional read group set information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -565,7 +565,7 @@
"name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
"readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
{ # A read group is all the data that's processed the same way by the sequencer.
- "info": { # A map of additional read group information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
diff --git a/docs/dyn/genomics_v1beta2.reads.html b/docs/dyn/genomics_v1beta2.reads.html
index 8b2b960..777cbeb 100644
--- a/docs/dyn/genomics_v1beta2.reads.html
+++ b/docs/dyn/genomics_v1beta2.reads.html
@@ -117,7 +117,7 @@
# out = "" offset = 0 for c in read.alignment.cigar { switch c.operation { case "ALIGNMENT_MATCH", "SEQUENCE_MATCH", "SEQUENCE_MISMATCH": out += read.alignedSequence[offset:offset+c.operationLength] offset += c.operationLength break case "CLIP_SOFT", "INSERT": offset += c.operationLength break case "PAD": out += repeat("*", c.operationLength) break case "DELETE": out += repeat("-", c.operationLength) break case "SKIP": out += repeat(" ", c.operationLength) break case "CLIP_HARD": break } } return out
# Converting to SAM's CIGAR string The following pseudocode generates a SAM CIGAR string from the cigar field. Note that this is a lossy conversion (cigar.referenceSequence is lost).
# cigarMap = { "ALIGNMENT_MATCH": "M", "INSERT": "I", "DELETE": "D", "SKIP": "N", "CLIP_SOFT": "S", "CLIP_HARD": "H", "PAD": "P", "SEQUENCE_MATCH": "=", "SEQUENCE_MISMATCH": "X", } cigarStr = "" for c in read.alignment.cigar { cigarStr += c.operationLength + cigarMap[c.operation] } return cigarStr
- "info": { # A map of additional read alignment information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -131,7 +131,7 @@
"fragmentName": "A String", # The fragment name. Equivalent to QNAME (query template name) in SAM.
"readNumber": 42, # The read number in sequencing. 0-based and less than numberReads. This field replaces SAM flag 0x40 and 0x80.
"properPlacement": True or False, # The orientation and the distance between reads from the fragment are consistent with the sequencing protocol (SAM flag 0x2)
- "nextMatePosition": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The mapping of the primary alignment of the (readNumber+1)%numberReads read in the fragment. It replaces mate position and mate strand in SAM.
+ "nextMatePosition": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The position of the primary alignment of the (readNumber+1)%numberReads read in the fragment. It replaces mate position and mate strand in SAM. This field will be unset if that read is unmapped or if the fragment only has a single read.
"position": "A String", # The 0-based offset from the start of the forward strand for that reference.
"reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand.
"referenceName": "A String", # The name of the reference in whatever reference set is being used.
@@ -142,7 +142,7 @@
"secondaryAlignment": True or False, # Whether this alignment is secondary. Equivalent to SAM flag 0x100. A secondary alignment represents an alternative to the primary alignment for this read. Aligners may return secondary alignments if a read can map ambiguously to multiple coordinates in the genome. By convention, each read has one and only one alignment where both secondaryAlignment and supplementaryAlignment are false.
"alignedSequence": "A String", # The bases of the read sequence contained in this alignment record, without CIGAR operations applied. alignedSequence and alignedQuality may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
"id": "A String", # The unique ID for this read. This is a generated unique ID, not to be confused with fragmentName.
- "alignment": { # A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference. # The linear alignment for this alignment record. This field will be null if the read is unmapped.
+ "alignment": { # A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference. # The linear alignment for this alignment record. This field will be unset if the read is unmapped.
"position": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The position of this alignment.
"position": "A String", # The 0-based offset from the start of the forward strand for that reference.
"reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand.
diff --git a/docs/dyn/genomics_v1beta2.referencesets.html b/docs/dyn/genomics_v1beta2.referencesets.html
index 035b36b..7eef51c 100644
--- a/docs/dyn/genomics_v1beta2.referencesets.html
+++ b/docs/dyn/genomics_v1beta2.referencesets.html
@@ -94,7 +94,7 @@
An object of the form:
{ # A reference set is a set of references which typically comprise a reference assembly for a species, such as GRCh38 which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references.
- "description": "A String", # free text description of this reference set.
+ "description": "A String", # Free text description of this reference set.
"sourceURI": "A String", # The URI from which the references were obtained.
"referenceIds": [ # The IDs of the reference objects that are part of this set. Reference.md5checksum must be unique within this set.
"A String",
@@ -139,7 +139,7 @@
"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.
"referenceSets": [ # The matching references sets.
{ # A reference set is a set of references which typically comprise a reference assembly for a species, such as GRCh38 which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references.
- "description": "A String", # free text description of this reference set.
+ "description": "A String", # Free text description of this reference set.
"sourceURI": "A String", # The URI from which the references were obtained.
"referenceIds": [ # The IDs of the reference objects that are part of this set. Reference.md5checksum must be unique within this set.
"A String",
diff --git a/docs/dyn/genomics_v1beta2.variants.html b/docs/dyn/genomics_v1beta2.variants.html
index 7b1c3f1..9943984 100644
--- a/docs/dyn/genomics_v1beta2.variants.html
+++ b/docs/dyn/genomics_v1beta2.variants.html
@@ -99,7 +99,7 @@
The object takes the form of:
{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
- "info": { # A map of additional variant information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -108,7 +108,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -146,7 +146,7 @@
An object of the form:
{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
- "info": { # A map of additional variant information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -155,7 +155,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -209,7 +209,7 @@
An object of the form:
{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
- "info": { # A map of additional variant information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -218,7 +218,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -263,17 +263,17 @@
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.
+ "end": "A String", # The end of the window, 0-based exclusive. If unspecified or 0, defaults to the length of the reference.
+ "pageSize": 42, # The maximum number of variants to return. If unspecified, defaults to 5000.
+ "start": "A String", # The beginning of the window (0-based, inclusive) for which overlapping variants should be returned. If unspecified, defaults to 0.
+ "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. If unspecified, defaults to 5000.
"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.
+ "variantSetIds": [ # At most one variant set ID must be provided. Only variants from this variant set will be returned. If omitted, a call set id must be included in the request.
"A String",
],
}
@@ -286,7 +286,7 @@
"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 a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
- "info": { # A map of additional variant information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -295,7 +295,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -341,7 +341,7 @@
The object takes the form of:
{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
- "info": { # A map of additional variant information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -350,7 +350,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -388,7 +388,7 @@
An object of the form:
{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
- "info": { # A map of additional variant information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -397,7 +397,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
diff --git a/docs/dyn/genomics_v1beta2.variantsets.html b/docs/dyn/genomics_v1beta2.variantsets.html
index 56df3eb..8202903 100644
--- a/docs/dyn/genomics_v1beta2.variantsets.html
+++ b/docs/dyn/genomics_v1beta2.variantsets.html
@@ -118,13 +118,13 @@
The object takes the form of:
{ # The variant data export request.
- "bigqueryDataset": "A String", # The BigQuery dataset to export data to. Note that this is distinct from the Genomics concept of "dataset".
+ "bigqueryDataset": "A String", # Required. The BigQuery dataset to export data to. This dataset must already exist. Note that this is distinct from the Genomics concept of "dataset".
"format": "A String", # The format for the exported data.
"callSetIds": [ # If provided, only variant call information from the specified call sets will be exported. By default all variant calls are exported.
"A String",
],
- "projectNumber": "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.
- "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.
+ "projectNumber": "A String", # Required. 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.
+ "bigqueryTable": "A String", # Required. 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.
}
@@ -157,7 +157,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -185,10 +185,11 @@
The object takes the form of:
{ # The variant data import request.
- "sourceUris": [ # A list of URIs pointing at VCF files in Google Cloud Storage. See the VCF Specification for more details on the input format.
+ "normalizeReferenceNames": True or False, # Convert reference names to the canonical representation. hg19 haploytypes (those reference names containing "_hap") are not modified in any way. All other reference names are modified according to the following rules: The reference name is capitalized. The "chr" prefix is dropped for all autosomes and sex chromsomes. For example "chr17" becomes "17" and "chrX" becomes "X". All mitochondrial chromosomes ("chrM", "chrMT", etc) become "MT".
+ "sourceUris": [ # A list of URIs referencing variant files in Google Cloud Storage. URIs can include wildcards as described here. Note that recursive wildcards ('**') are not supported.
"A String",
],
- "format": "A String", # The format of the variant data being imported.
+ "format": "A String", # The format of the variant data being imported. If unspecified, defaults to to "VCF".
}
@@ -214,7 +215,7 @@
{
"variants": [ # The variants to be merged with existing variants.
{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
- "info": { # A map of additional variant information.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -223,7 +224,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -266,7 +267,7 @@
<pre>Updates a variant set's metadata. All other modifications are silently ignored. This method supports patch semantics.
Args:
- variantSetId: string, The ID of the variant to be updated. (required)
+ variantSetId: string, The ID of the variant to be updated (must already exist). (required)
body: object, The request body. (required)
The object takes the form of:
@@ -281,7 +282,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -311,7 +312,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -363,7 +364,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -386,7 +387,7 @@
<pre>Updates a variant set's metadata. All other modifications are silently ignored.
Args:
- variantSetId: string, The ID of the variant to be updated. (required)
+ variantSetId: string, The ID of the variant to be updated (must already exist). (required)
body: object, The request body. (required)
The object takes the form of:
@@ -401,7 +402,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
@@ -431,7 +432,7 @@
"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.
+ "info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
diff --git a/docs/dyn/gmail_v1.html b/docs/dyn/gmail_v1.html
index 481c80b..026d3dd 100644
--- a/docs/dyn/gmail_v1.html
+++ b/docs/dyn/gmail_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the users 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/gmail_v1.users.html b/docs/dyn/gmail_v1.users.html
index d53f22e..1ec240f 100644
--- a/docs/dyn/gmail_v1.users.html
+++ b/docs/dyn/gmail_v1.users.html
@@ -102,6 +102,12 @@
<p class="toc_element">
<code><a href="#getProfile">getProfile(userId)</a></code></p>
<p class="firstline">Gets the current user's Gmail profile.</p>
+<p class="toc_element">
+ <code><a href="#stop">stop(userId)</a></code></p>
+<p class="firstline">Stop receiving push notifications for the given user mailbox.</p>
+<p class="toc_element">
+ <code><a href="#watch">watch(userId, body)</a></code></p>
+<p class="firstline">Set up or update a push notification watch on the given user mailbox.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="getProfile">getProfile(userId)</code>
@@ -121,4 +127,42 @@
}</pre>
</div>
+<div class="method">
+ <code class="details" id="stop">stop(userId)</code>
+ <pre>Stop receiving push notifications for the given user mailbox.
+
+Args:
+ userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="watch">watch(userId, body)</code>
+ <pre>Set up or update a push notification watch on the given user mailbox.
+
+Args:
+ userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Set up or update a new push notification watch on this user's mailbox.
+ "labelIds": [ # List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.
+ "A String",
+ ],
+ "topicName": "A String", # Fully qualified Cloud PubSub API topic name to publish events to. This topic name should already exist in Cloud PubSub and you should have already granted gmail "publish" privileges on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the new Cloud PubSub "v1beta2" topic naming format).
+ #
+ # Note that the "my-project-identifier" portion must exactly match your developer console project id (the one executing this watch request).
+ "labelFilterAction": "A String", # Filtering behavior of labelIds list specified.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Push notification watch response.
+ "expiration": "A String", # When Gmail will stop sending notifications for mailbox updates. Call watch again before this time to renew the subscription.
+ "historyId": "A String", # The ID of the mailbox's current history record.
+ }</pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/gmail_v1.users.messages.html b/docs/dyn/gmail_v1.users.messages.html
index e2b224c..b712e94 100644
--- a/docs/dyn/gmail_v1.users.messages.html
+++ b/docs/dyn/gmail_v1.users.messages.html
@@ -89,7 +89,7 @@
<code><a href="#import_">import_(userId, body=None, media_body=None, internalDateSource=None, neverMarkSpam=None, processForCalendar=None, deleted=None)</a></code></p>
<p class="firstline">Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.</p>
<p class="toc_element">
- <code><a href="#insert">insert(userId, body=None, media_body=None, internalDateSource=None)</a></code></p>
+ <code><a href="#insert">insert(userId, body=None, media_body=None, internalDateSource=None, deleted=None)</a></code></p>
<p class="firstline">Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.</p>
<p class="toc_element">
<code><a href="#list">list(userId, labelIds=None, q=None, pageToken=None, maxResults=None, includeSpamTrash=None)</a></code></p>
@@ -264,7 +264,7 @@
</div>
<div class="method">
- <code class="details" id="insert">insert(userId, body=None, media_body=None, internalDateSource=None)</code>
+ <code class="details" id="insert">insert(userId, body=None, media_body=None, internalDateSource=None, deleted=None)</code>
<pre>Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.
Args:
@@ -311,6 +311,7 @@
Allowed values
dateHeader -
receivedTime -
+ deleted: boolean, Mark the email as permanently deleted (not TRASH) and only visible in Google Apps Vault to a Vault administrator. Only used for Google Apps for Work accounts.
Returns:
An object of the form:
diff --git a/docs/dyn/groupsmigration_v1.html b/docs/dyn/groupsmigration_v1.html
index 4ff4e68..eee2ad5 100644
--- a/docs/dyn/groupsmigration_v1.html
+++ b/docs/dyn/groupsmigration_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the archive 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/groupssettings_v1.html b/docs/dyn/groupssettings_v1.html
index 4c44371..9400669 100644
--- a/docs/dyn/groupssettings_v1.html
+++ b/docs/dyn/groupssettings_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the groups 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/identitytoolkit_v3.html b/docs/dyn/identitytoolkit_v3.html
index 5922397..703f4e7 100644
--- a/docs/dyn/identitytoolkit_v3.html
+++ b/docs/dyn/identitytoolkit_v3.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the relyingparty 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/identitytoolkit_v3.relyingparty.html b/docs/dyn/identitytoolkit_v3.relyingparty.html
index f3e5244..c829479 100644
--- a/docs/dyn/identitytoolkit_v3.relyingparty.html
+++ b/docs/dyn/identitytoolkit_v3.relyingparty.html
@@ -93,6 +93,9 @@
<code><a href="#getPublicKeys">getPublicKeys()</a></code></p>
<p class="firstline">Get token signing public key.</p>
<p class="toc_element">
+ <code><a href="#getRecaptchaParam">getRecaptchaParam()</a></code></p>
+<p class="firstline">Get recaptcha secure param.</p>
+<p class="toc_element">
<code><a href="#resetPassword">resetPassword(body)</a></code></p>
<p class="firstline">Reset password for a user.</p>
<p class="toc_element">
@@ -117,14 +120,16 @@
The object takes the form of:
{ # Request to get the IDP authentication URL.
- "identifier": "A String", # The email or federated ID of the user.
+ "openidRealm": "A String", # Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.
+ "oauthScope": "A String", # Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant
"clientId": "A String", # The relying party OAuth client ID.
"otaApp": "A String", # The native app package for OTA installation.
+ "oauthConsumerKey": "A String", # The developer's consumer key for OpenId OAuth Extension
"providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
"context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
"appId": "A String", # The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
"continueUri": "A String", # The URI to which the IDP redirects the user after the federated login flow.
- "openidRealm": "A String", # Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.
+ "identifier": "A String", # The email or federated ID of the user.
}
@@ -186,9 +191,11 @@
{ # Template for an individual account info.
"displayName": "A String", # The name of the user.
"localId": "A String", # The local ID of the user.
+ "validSince": "A String", # Timestamp in seconds for valid login token.
"photoUrl": "A String", # The URL of the user profile photo.
"emailVerified": True or False, # Whether the email has been verified.
"passwordHash": "A String", # The user's hashed password.
+ "disabled": True or False, # Whether the user is disabled.
"version": 42, # Version of the user's password.
"providerUserInfo": [ # The IDP of the user.
{
@@ -234,9 +241,11 @@
{ # Template for an individual account info.
"displayName": "A String", # The name of the user.
"localId": "A String", # The local ID of the user.
+ "validSince": "A String", # Timestamp in seconds for valid login token.
"photoUrl": "A String", # The URL of the user profile photo.
"emailVerified": True or False, # Whether the email has been verified.
"passwordHash": "A String", # The user's hashed password.
+ "disabled": True or False, # Whether the user is disabled.
"version": 42, # Version of the user's password.
"providerUserInfo": [ # The IDP of the user.
{
@@ -298,6 +307,22 @@
</div>
<div class="method">
+ <code class="details" id="getRecaptchaParam">getRecaptchaParam()</code>
+ <pre>Get recaptcha secure param.
+
+Args:
+
+Returns:
+ An object of the form:
+
+ { # Response of getting recaptcha param.
+ "kind": "identitytoolkit#GetRecaptchaParamResponse", # The fixed string "identitytoolkit#GetRecaptchaParamResponse".
+ "recaptchaSiteKey": "A String", # Site key registered at recaptcha.
+ "recaptchaStoken": "A String", # The stoken field for the recaptcha widget, used to request captcha challenge.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="resetPassword">resetPassword(body)</code>
<pre>Reset password for a user.
@@ -333,14 +358,16 @@
{ # Request to set the account information.
"displayName": "A String", # The name of the user.
"localId": "A String", # The local ID of the user.
+ "validSince": "A String", # Timestamp in seconds for valid login token.
"upgradeToFederatedLogin": True or False, # Mark the user to upgrade to federated login.
"captchaResponse": "A String", # Response to the captcha.
- "idToken": "A String", # The GITKit token of the authenticated user.
+ "emailVerified": True or False, # Mark the email as verified or not.
"provider": [ # The associated IDPs of the user.
"A String",
],
+ "disableUser": True or False, # Whether to disable the user.
"captchaChallenge": "A String", # The captcha challenge.
- "emailVerified": True or False, # Mark the email as verified or not.
+ "idToken": "A String", # The GITKit token of the authenticated user.
"oobCode": "A String", # The out-of-band code of the change email request.
"password": "A String", # The new password of the user.
"email": "A String", # The email of the user.
@@ -379,9 +406,11 @@
{ # Template for an individual account info.
"displayName": "A String", # The name of the user.
"localId": "A String", # The local ID of the user.
+ "validSince": "A String", # Timestamp in seconds for valid login token.
"photoUrl": "A String", # The URL of the user profile photo.
"emailVerified": True or False, # Whether the email has been verified.
"passwordHash": "A String", # The user's hashed password.
+ "disabled": True or False, # Whether the user is disabled.
"version": 42, # Version of the user's password.
"providerUserInfo": [ # The IDP of the user.
{
@@ -428,6 +457,7 @@
{ # Request to verify the IDP assertion.
"requestUri": "A String", # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.
"postBody": "A String", # The post body if the request is a HTTP POST.
+ "returnRefreshToken": True or False, # Whether to return refresh tokens.
"pendingIdToken": "A String", # The GITKit token for the non-trusted IDP pending to be confirmed by the user.
}
@@ -448,6 +478,7 @@
"dateOfBirth": "A String", # The birth date of the IdP account.
"nickName": "A String", # The nick name of the user.
"email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
+ "oauthAccessToken": "A String", # The OAuth2 access token.
"language": "A String", # The language preference of the user.
"needConfirmation": True or False, # Whether the assertion is from a non-trusted IDP and need account linking confirmation.
"fullName": "A String", # The full name of the user.
@@ -456,9 +487,11 @@
"displayName": "A String", # The display name of the user.
"appInstallationUrl": "A String", # URL for OTA app installation.
"firstName": "A String", # The first name of the user.
+ "oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.
"emailVerified": True or False, # The value is true if the IDP is also the email provider. It means the user owns the email.
"oauthScope": "A String", # The scope for the OpenID OAuth extension.
"oauthRequestToken": "A String", # The user approved request token for the OpenID OAuth extension.
+ "oauthAuthorizationCode": "A String", # The OAuth2 authorization code.
"originalEmail": "A String", # The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email.
"context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
"lastName": "A String", # The last name of the user.
diff --git a/docs/dyn/licensing_v1.html b/docs/dyn/licensing_v1.html
index ab4efbb..26a1c8a 100644
--- a/docs/dyn/licensing_v1.html
+++ b/docs/dyn/licensing_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the licenseAssignments 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/logging_v1beta3.html
new file mode 100644
index 0000000..db3cf63
--- /dev/null
+++ b/docs/dyn/logging_v1beta3.html
@@ -0,0 +1,103 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="logging_v1beta3.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/logging_v1beta3.projects.html b/docs/dyn/logging_v1beta3.projects.html
new file mode 100644
index 0000000..ebc41c0
--- /dev/null
+++ b/docs/dyn/logging_v1beta3.projects.html
@@ -0,0 +1,87 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.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>
+</p>
+<p class="firstline">Returns the logs Resource.</p>
+
+</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
new file mode 100644
index 0000000..bc16fe5
--- /dev/null
+++ b/docs/dyn/logging_v1beta3.projects.logServices.html
@@ -0,0 +1,135 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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 log services associated with log entries ingested 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="list">list(projectsId, log=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists log services associated with log entries ingested for a project.
+
+Args:
+ projectsId: string, Part of `projectName`. The project resource whose services are to be listed. (required)
+ log: string, The name of the log resource whose services are to be listed. log for which to list services. When empty, all services are listed.
+ 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.
+ { # A log service object.
+ "indexKeys": [ # Label keys used when labeling log entries for this service. The order of the keys is significant, with higher priority keys coming earlier in the list.
+ "A String",
+ ],
+ "name": "A String", # The service'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/logging_v1beta3.projects.logServices.indexes.html b/docs/dyn/logging_v1beta3.projects.logServices.indexes.html
new file mode 100644
index 0000000..92f3494
--- /dev/null
+++ b/docs/dyn/logging_v1beta3.projects.logServices.indexes.html
@@ -0,0 +1,123 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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, log=None, pageSize=None, depth=None, indexPrefix=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists log service indexes associated with 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, log=None, pageSize=None, depth=None, indexPrefix=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists log service indexes associated with a log service.
+
+Args:
+ projectsId: string, Part of `serviceName`. A log service resource of the form `/projects/*/logServices/*`. The service indexes of the log service are returned. Example: `"/projects/myProj/logServices/appengine.googleapis.com"`. (required)
+ logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required)
+ log: string, A log resource like `/projects/project_id/logs/log_name`, identifying the log for which to list service indexes.
+ pageSize: integer, The maximum number of log service index resources to return in one operation.
+ depth: integer, A limit to the number of levels of the index hierarchy that are expanded. If `depth` is 0, it defaults to the level specified by the prefix field (the number of slash separators). The default empty prefix implies a `depth` of 1. It is an error for `depth` to be any non-zero value less than the number of components in `indexPrefix`.
+ indexPrefix: string, Restricts the indexes returned to be those with a specified prefix. The prefix has the form `"/label_value/label_value/..."`, in order corresponding to the [`LogService indexKeys`][google.logging.v1.LogService.index_keys]. Non-empty prefixes must begin with `/` . Example prefixes: + `"/myModule/"` retrieves App Engine versions associated with `myModule`. The trailing slash terminates the value. + `"/myModule"` retrieves App Engine modules with names beginning with `myModule`. + `""` retrieves all indexes.
+ 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.
+ x__xgafv: string, V1 error format.
+
+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 `ListLogServiceIndexess`. If `nextPageToken` is empty, then there are no more results.
+ "serviceIndexPrefixes": [ # A list of log service index prefixes.
+ "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
new file mode 100644
index 0000000..537b61e
--- /dev/null
+++ b/docs/dyn/logging_v1beta3.projects.logServices.sinks.html
@@ -0,0 +1,294 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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 the specified log service sink resource.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes the specified log service sink.</p>
+<p class="toc_element">
+ <code><a href="#get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the specified log service sink resource.</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 the specified service.</p>
+<p class="toc_element">
+ <code><a href="#update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates or update the specified log service sink resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(projectsId, logServicesId, body, x__xgafv=None)</code>
+ <pre>Creates the specified log service sink resource.
+
+Args:
+ projectsId: string, Part of `serviceName`. The name of the service in which to create a sink. (required)
+ logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</code>
+ <pre>Deletes the specified log service sink.
+
+Args:
+ projectsId: string, Part of `sinkName`. The name of the 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); }
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</code>
+ <pre>Gets the specified log service sink resource.
+
+Args:
+ projectsId: string, Part of `sinkName`. The name of the 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:
+
+ { # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(projectsId, logServicesId, x__xgafv=None)</code>
+ <pre>Lists log service sinks associated with the specified service.
+
+Args:
+ projectsId: string, Part of `serviceName`. The name of the service for which to list sinks. (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 any of the returned `LogSink` objects have an empty `destination` field, then call `logServices.sinks.get` to retrieve the complete `LogSink` object.
+ { # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</code>
+ <pre>Creates or update the specified log service sink resource.
+
+Args:
+ projectsId: string, Part of `sinkName`. The name of the 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:
+
+{ # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ }</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
new file mode 100644
index 0000000..adf523c
--- /dev/null
+++ b/docs/dyn/logging_v1beta3.projects.logs.entries.html
@@ -0,0 +1,131 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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">Creates one or more log entries in a log. You must supply a list of `LogEntry` objects, named `entries`. Each `LogEntry` object must contain a payload object and a `LogEntryMetadata` object that describes the entry. You must fill in all the fields of the entry, metadata, and payload. You can also supply a map, `commonLabels`, that supplies default (key, value) data for the `entries[].metadata.labels` maps, 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>Creates one or more log entries in a log. You must supply a list of `LogEntry` objects, named `entries`. Each `LogEntry` object must contain a payload object and a `LogEntryMetadata` object that describes the entry. You must fill in all the fields of the entry, metadata, and payload. You can also supply a map, `commonLabels`, that supplies default (key, value) data for the `entries[].metadata.labels` maps, saving you the trouble of creating identical copies for each entry.
+
+Args:
+ projectsId: string, Part of `logName`. The name of the log resource into which to insert 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 entries in this request. If one 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.
+ "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
new file mode 100644
index 0000000..54a118c
--- /dev/null
+++ b/docs/dyn/logging_v1beta3.projects.logs.html
@@ -0,0 +1,154 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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 the specified log resource and all log entries contained in it.</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 log resources belonging to the specified project.</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(projectsId, logsId, x__xgafv=None)</code>
+ <pre>Deletes the specified log resource and all log entries contained in it.
+
+Args:
+ projectsId: string, Part of `logName`. The log resource to delete. (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); }
+ }</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 log resources belonging to the specified project.
+
+Args:
+ projectsId: string, Part of `projectName`. The project name for which to list the log resources. (required)
+ pageSize: integer, The maximum number of results to return.
+ serviceName: string, A service name for which to list logs. Only logs containing entries whose metadata includes this service name are returned. If `serviceName` and `serviceIndexPrefix` are both empty, then all log names are returned. To list all log names, regardless of service, leave both the `serviceName` and `serviceIndexPrefix` empty. To list log names containing entries with a particular service name (or explicitly empty service name) set `serviceName` to the desired value and `serviceIndexPrefix` to `"/"`.
+ 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, A log service index prefix for which to list logs. Only logs containing entries whose metadata that includes these label values (associated with index keys) are returned. The prefix is a slash separated list of values, and need not specify all index labels. An empty index (or a single slash) matches all log service indexes.
+
+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 resources.
+ { # A log object.
+ "payloadType": "A String", # Type URL describing the expected payload type for the log.
+ "displayName": "A String", # Name used when displaying the log to the user (for example, in a UI). Example: `"activity_log"`
+ "name": "A String", # REQUIRED: The log's name name. Example: `"compute.googleapis.com/activity_log"`.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object 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
new file mode 100644
index 0000000..8fd7fac
--- /dev/null
+++ b/docs/dyn/logging_v1beta3.projects.logs.sinks.html
@@ -0,0 +1,294 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 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 the specified log sink resource.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(projectsId, logsId, sinksId, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes the specified log sink resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(projectsId, logsId, sinksId, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the specified log sink resource.</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 the specified log.</p>
+<p class="toc_element">
+ <code><a href="#update">update(projectsId, logsId, sinksId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates or updates the specified log sink resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(projectsId, logsId, body, x__xgafv=None)</code>
+ <pre>Creates the specified log sink resource.
+
+Args:
+ projectsId: string, Part of `logName`. The log in which to create a sink resource. (required)
+ logsId: string, Part of `logName`. See documentation of `projectsId`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(projectsId, logsId, sinksId, x__xgafv=None)</code>
+ <pre>Deletes the specified log sink resource.
+
+Args:
+ projectsId: string, Part of `sinkName`. The name of the 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); }
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(projectsId, logsId, sinksId, x__xgafv=None)</code>
+ <pre>Gets the specified log sink resource.
+
+Args:
+ projectsId: string, Part of `sinkName`. The name of the sink resource 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:
+
+ { # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(projectsId, logsId, x__xgafv=None)</code>
+ <pre>Lists log sinks associated with the specified log.
+
+Args:
+ projectsId: string, Part of `logName`. The log for which to list sinks. (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 any of the returned `LogSink` objects have an empty `destination` field, then call `logServices.sinks.get` to retrieve the complete `LogSink` object.
+ { # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(projectsId, logsId, sinksId, body, x__xgafv=None)</code>
+ <pre>Creates or updates the specified log sink resource.
+
+Args:
+ projectsId: string, Part of `sinkName`. The 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:
+
+{ # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An object that describes where a log may be written.
+ "errors": [ # _Output only._ All active errors found for this sink.
+ { # A problem in a sink or the sink's configuration.
+ "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
+ "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
+ "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 last time the error was observed, in nanoseconds since the Unix epoch.
+ "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
+ },
+ ],
+ "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
+ "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/manager_v1beta2.html b/docs/dyn/manager_v1beta2.html
index f8fbc2d..44fc028 100644
--- a/docs/dyn/manager_v1beta2.html
+++ b/docs/dyn/manager_v1beta2.html
@@ -84,4 +84,25 @@
</p>
<p class="firstline">Returns the templates 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.html b/docs/dyn/mapsengine_v1.html
index 8e42f78..f75bdf8 100644
--- a/docs/dyn/mapsengine_v1.html
+++ b/docs/dyn/mapsengine_v1.html
@@ -109,4 +109,25 @@
</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/mirror_v1.html b/docs/dyn/mirror_v1.html
index f0a382b..6cb80f8 100644
--- a/docs/dyn/mirror_v1.html
+++ b/docs/dyn/mirror_v1.html
@@ -104,4 +104,25 @@
</p>
<p class="firstline">Returns the timeline 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/oauth2_v2.html b/docs/dyn/oauth2_v2.html
index f56acb7..d69da45 100644
--- a/docs/dyn/oauth2_v2.html
+++ b/docs/dyn/oauth2_v2.html
@@ -83,7 +83,10 @@
<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="#tokeninfo">tokeninfo(access_token=None, id_token=None)</a></code></p>
+ <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(token_handle=None, access_token=None, id_token=None)</a></code></p>
<p class="firstline">A description of how to use this function</p>
<h3>Method Details</h3>
<div class="method">
@@ -110,10 +113,28 @@
</div>
<div class="method">
- <code class="details" id="tokeninfo">tokeninfo(access_token=None, id_token=None)</code>
+ <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(token_handle=None, access_token=None, id_token=None)</code>
<pre>A description of how to use this function
Args:
+ token_handle: string, A parameter
access_token: string, A parameter
id_token: string, A parameter
@@ -122,7 +143,8 @@
{
"issued_to": "A String", # To whom was the token issued to. In general the same as audience.
- "user_id": "A String", # The Gaia obfuscated user id.
+ "token_handle": "A String", # The token handle associated with this token.
+ "user_id": "A String", # The obfuscated user id.
"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.
diff --git a/docs/dyn/pagespeedonline_v2.html b/docs/dyn/pagespeedonline_v2.html
index d4cd497..fe5de05 100644
--- a/docs/dyn/pagespeedonline_v2.html
+++ b/docs/dyn/pagespeedonline_v2.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/plusDomains_v1.html b/docs/dyn/plusDomains_v1.html
index c5285f3..e8a624a 100644
--- a/docs/dyn/plusDomains_v1.html
+++ b/docs/dyn/plusDomains_v1.html
@@ -104,4 +104,25 @@
</p>
<p class="firstline">Returns the people 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/plus_v1.html b/docs/dyn/plus_v1.html
index 6a3ff6d..bc4f7ec 100644
--- a/docs/dyn/plus_v1.html
+++ b/docs/dyn/plus_v1.html
@@ -94,4 +94,25 @@
</p>
<p class="firstline">Returns the people 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/prediction_v1_6.html b/docs/dyn/prediction_v1_6.html
index a6a9760..498b89e 100644
--- a/docs/dyn/prediction_v1_6.html
+++ b/docs/dyn/prediction_v1_6.html
@@ -84,4 +84,25 @@
</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>
+<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/pubsub_v1beta1.html b/docs/dyn/pubsub_v1beta1.html
index 6f791c8..f0a882d 100644
--- a/docs/dyn/pubsub_v1beta1.html
+++ b/docs/dyn/pubsub_v1beta1.html
@@ -84,4 +84,25 @@
</p>
<p class="firstline">Returns the topics 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/pubsub_v1beta1.subscriptions.html b/docs/dyn/pubsub_v1beta1.subscriptions.html
index 3261e3a..929a0c6 100644
--- a/docs/dyn/pubsub_v1beta1.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta1.subscriptions.html
@@ -138,7 +138,7 @@
#
# 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 a specific pull request (message) 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).
+ # 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.
"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".
@@ -155,7 +155,7 @@
#
# 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 a specific pull request (message) 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).
+ # 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.
"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".
@@ -188,7 +188,7 @@
#
# 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 a specific pull request (message) 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).
+ # 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.
"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".
@@ -217,7 +217,7 @@
#
# 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 a specific pull request (message) 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).
+ # 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.
"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".
@@ -251,9 +251,12 @@
The object takes the form of:
{ # Request for the ModifyAckDeadline method.
- "ackDeadlineSeconds": 42, # The new Ack deadline. Must be >= 0.
- "ackId": "A String", # The acknowledgment ID.
- "subscription": "A String", # The name of the subscription from which messages are being pulled.
+ "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. TODO(handrei): mark the above field deprecated once it's not used internally.
+ "A String",
+ ],
}
</pre>
diff --git a/docs/dyn/pubsub_v1beta1.topics.html b/docs/dyn/pubsub_v1beta1.topics.html
index 5cb4e6e..9dbfbfc 100644
--- a/docs/dyn/pubsub_v1beta1.topics.html
+++ b/docs/dyn/pubsub_v1beta1.topics.html
@@ -79,7 +79,7 @@
<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>
-<p class="firstline">Deletes the topic with the given name. All subscriptions to this topic are also deleted. 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="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>
<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>
@@ -119,7 +119,7 @@
<div class="method">
<code class="details" id="delete">delete(topic)</code>
- <pre>Deletes the topic with the given name. All subscriptions to this topic are also deleted. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name.
+ <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)
diff --git a/docs/dyn/pubsub_v1beta2.html b/docs/dyn/pubsub_v1beta2.html
index 6543ae3..8ba035c 100644
--- a/docs/dyn/pubsub_v1beta2.html
+++ b/docs/dyn/pubsub_v1beta2.html
@@ -79,4 +79,25 @@
</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/pubsub_v1beta2.projects.subscriptions.html b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
index b6f7747..bdbcd55 100644
--- a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
@@ -75,156 +75,234 @@
<h1><a href="pubsub_v1beta2.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1beta2.projects.html">projects</a> . <a href="pubsub_v1beta2.projects.subscriptions.html">subscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#acknowledge">acknowledge(subscription, body)</a></code></p>
+ <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="toc_element">
- <code><a href="#create">create(name, body)</a></code></p>
+ <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="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. 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)</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(project, pageSize=None, pageToken=None)</a></code></p>
+ <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="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>
<p class="toc_element">
<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(subscription, body)</a></code></p>
+ <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="toc_element">
- <code><a href="#modifyPushConfig">modifyPushConfig(subscription, body)</a></code></p>
+ <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="toc_element">
- <code><a href="#pull">pull(subscription, body)</a></code></p>
+ <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="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>
+<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 resource.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="acknowledge">acknowledge(subscription, body)</code>
+ <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.
Args:
- subscription: string, A parameter (required)
+ subscription: string, The subscription whose message is being acknowledged. (required)
body: object, The request body. (required)
The object takes the form of:
-{
- "ackIds": [
+{ # 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.
"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); }
}</pre>
</div>
<div class="method">
- <code class="details" id="create">create(name, body)</code>
+ <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.
Args:
- name: string, A parameter (required)
+ 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)
body: object, The request body. (required)
The object takes the form of:
-{
- "ackDeadlineSeconds": 42,
- "topic": "A String",
- "pushConfig": {
- "attributes": {
+{ # 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.
"a_key": "A String",
},
- "pushEndpoint": "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",
+ "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".
}
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
- {
- "ackDeadlineSeconds": 42,
- "topic": "A String",
- "pushConfig": {
- "attributes": {
+ { # 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.
"a_key": "A String",
},
- "pushEndpoint": "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",
+ "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".
}</pre>
</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. 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, A parameter (required)
+ subscription: string, The subscription to delete. (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); }
}</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, A parameter (required)
+ subscription: string, The name of the subscription to get. (required)
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
- {
- "ackDeadlineSeconds": 42,
- "topic": "A String",
- "pushConfig": {
- "attributes": {
+ { # 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.
"a_key": "A String",
},
- "pushEndpoint": "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",
+ "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".
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, pageSize=None, pageToken=None)</code>
- <pre>Lists matching subscriptions.
+ <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.
Args:
- project: string, A parameter (required)
- pageSize: integer, A parameter
- pageToken: string, A parameter
+ resource: string, REQUIRED: The resource for which policy is being requested. Usually some path like projects/{project}. (required)
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
- {
- "nextPageToken": "A String",
- "subscriptions": [
- {
- "ackDeadlineSeconds": 42,
- "topic": "A String",
- "pushConfig": {
- "attributes": {
+ { # # 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.
+ "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.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists matching subscriptions.
+
+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.
+ 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.
+ "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.
"a_key": "A String",
},
- "pushEndpoint": "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",
+ "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".
},
],
}</pre>
@@ -245,85 +323,239 @@
</div>
<div class="method">
- <code class="details" id="modifyAckDeadline">modifyAckDeadline(subscription, body)</code>
+ <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.
Args:
- subscription: string, A parameter (required)
+ subscription: string, The name of the subscription. (required)
body: object, The request body. (required)
The object takes the form of:
-{
- "ackDeadlineSeconds": 42,
- "ackId": "A String",
+{ # 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.
+ "ackIds": [ # List of acknowledgment IDs.
+ "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); }
}</pre>
</div>
<div class="method">
- <code class="details" id="modifyPushConfig">modifyPushConfig(subscription, body)</code>
+ <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.
Args:
- subscription: string, A parameter (required)
+ subscription: string, The name of the subscription. (required)
body: object, The request body. (required)
The object takes the form of:
-{
- "pushConfig": {
- "attributes": {
+{ # 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.
"a_key": "A String",
},
- "pushEndpoint": "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".
},
}
+ 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); }
}</pre>
</div>
<div class="method">
- <code class="details" id="pull">pull(subscription, body)</code>
+ <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.
Args:
- subscription: string, A parameter (required)
+ subscription: string, The subscription from which messages should be pulled. (required)
body: object, The request body. (required)
The object takes the form of:
-{
- "returnImmediately": True or False,
- "maxMessages": 42,
+{ # 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.
}
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
- {
- "receivedMessages": [
- {
- "ackId": "A String",
- "message": {
- "attributes": {
+ { # 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.
+ "attributes": { # Optional attributes for this message.
"a_key": "A String",
},
- "data": "A String",
- "messageId": "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.
},
},
],
}</pre>
</div>
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
+ <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)
+ 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.
+ "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.
+ },
+ }
+
+ 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.
+ "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.
+ }</pre>
+</div>
+
+<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 resource.
+
+Args:
+ resource: string, REQUIRED: The resource for which policy detail is being requested. Usually some path like 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.
+ "A String",
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "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/pubsub_v1beta2.projects.topics.html b/docs/dyn/pubsub_v1beta2.projects.topics.html
index f74a90a..f6d3b5b 100644
--- a/docs/dyn/pubsub_v1beta2.projects.topics.html
+++ b/docs/dyn/pubsub_v1beta2.projects.topics.html
@@ -80,93 +80,170 @@
<p class="firstline">Returns the subscriptions Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(name, body)</a></code></p>
+ <code><a href="#create">create(name, 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>
-<p class="firstline">Deletes the topic with the given name. All subscriptions to this topic are detached from the topic. 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.</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; 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="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.</p>
<p class="toc_element">
- <code><a href="#list">list(project, pageSize=None, pageToken=None)</a></code></p>
+ <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="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>
<p class="toc_element">
<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(topic, body)</a></code></p>
+ <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="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>
+<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 resource.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(name, body)</code>
+ <code class="details" id="create">create(name, body, x__xgafv=None)</code>
<pre>Creates the given topic with the given name.
Args:
- name: string, A parameter (required)
+ 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)
body: object, The request body. (required)
The object takes the form of:
-{
- "name": "A String",
- }
+{ # 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".
+}
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
- {
- "name": "A String",
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(topic)</code>
- <pre>Deletes the topic with the given name. All subscriptions to this topic are detached from the topic. 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.
-
-Args:
- topic: string, A parameter (required)
-
-Returns:
- 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".
}</pre>
</div>
<div class="method">
- <code class="details" id="get">get(topic)</code>
- <pre>Gets the configuration of a topic.
+ <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.
Args:
- topic: string, A parameter (required)
+ topic: string, Name of the topic to delete. (required)
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
- {
- "name": "A String",
- }</pre>
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, pageSize=None, pageToken=None)</code>
- <pre>Lists matching topics.
+ <code class="details" id="get">get(topic, x__xgafv=None)</code>
+ <pre>Gets the configuration of a topic.
Args:
- project: string, A parameter (required)
- pageSize: integer, A parameter
- pageToken: string, A parameter
+ topic: string, The name of the topic to get. (required)
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
- {
- "nextPageToken": "A String",
- "topics": [
- {
- "name": "A String",
- },
+ { # 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".
+ }</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.
+
+Args:
+ resource: string, REQUIRED: The resource for which policy is being requested. Usually some path like 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.
+ "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.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists matching topics.
+
+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.
+ 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.
+ "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".
+ },
],
}</pre>
</div>
@@ -186,32 +263,181 @@
</div>
<div class="method">
- <code class="details" id="publish">publish(topic, body)</code>
+ <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.
Args:
- topic: string, A parameter (required)
+ topic: string, The messages in the request will be published on this topic. (required)
body: object, The request body. (required)
The object takes the form of:
-{
- "messages": [
- {
- "attributes": {
+{ # Request for the Publish method.
+ "messages": [ # The messages to publish.
+ { # A message data and its attributes.
+ "attributes": { # Optional attributes for this message.
"a_key": "A String",
},
- "data": "A String",
- "messageId": "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.
},
],
}
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
- {
- "messageIds": [
+ { # 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",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
+ <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)
+ 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.
+ "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.
+ },
+ }
+
+ 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.
+ "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.
+ }</pre>
+</div>
+
+<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 resource.
+
+Args:
+ resource: string, REQUIRED: The resource for which policy detail is being requested. Usually some path like 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.
+ "A String",
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}</pre>
diff --git a/docs/dyn/pubsub_v1beta2.projects.topics.subscriptions.html b/docs/dyn/pubsub_v1beta2.projects.topics.subscriptions.html
index 94451ef..5091d5a 100644
--- a/docs/dyn/pubsub_v1beta2.projects.topics.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta2.projects.topics.subscriptions.html
@@ -75,27 +75,28 @@
<h1><a href="pubsub_v1beta2.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1beta2.projects.html">projects</a> . <a href="pubsub_v1beta2.projects.topics.html">topics</a> . <a href="pubsub_v1beta2.projects.topics.subscriptions.html">subscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(topic, pageSize=None, pageToken=None)</a></code></p>
+ <code><a href="#list">list(topic, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the name of the subscriptions for this topic.</p>
<p class="toc_element">
<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(topic, pageSize=None, pageToken=None)</code>
+ <code class="details" id="list">list(topic, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the name of the subscriptions for this topic.
Args:
- topic: string, A parameter (required)
- pageSize: integer, A parameter
- pageToken: string, A parameter
+ 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.
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
- {
- "nextPageToken": "A String",
- "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",
],
}</pre>
diff --git a/docs/dyn/qpxExpress_v1.html b/docs/dyn/qpxExpress_v1.html
index 1379be3..4980cf1 100644
--- a/docs/dyn/qpxExpress_v1.html
+++ b/docs/dyn/qpxExpress_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the trips 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/replicapool_v1beta2.html b/docs/dyn/replicapool_v1beta2.html
index d6675d9..21e36a8 100644
--- a/docs/dyn/replicapool_v1beta2.html
+++ b/docs/dyn/replicapool_v1beta2.html
@@ -84,4 +84,25 @@
</p>
<p class="firstline">Returns the zoneOperations 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/replicapool_v1beta2.instanceGroupManagers.html b/docs/dyn/replicapool_v1beta2.instanceGroupManagers.html
index a2a3b33..54a9d8d 100644
--- a/docs/dyn/replicapool_v1beta2.instanceGroupManagers.html
+++ b/docs/dyn/replicapool_v1beta2.instanceGroupManagers.html
@@ -82,7 +82,7 @@
<p class="firstline">Deletes the instance group manager and all instances contained within. If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group.</p>
<p class="toc_element">
<code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</a></code></p>
-<p class="firstline">Deletes the specified instances. The instances are removed from the instance group and any target pools of which they are a member, then deleted. The targetSize of the instance group manager is reduced by the number of instances deleted.</p>
+<p class="firstline">Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.</p>
<p class="toc_element">
<code><a href="#get">get(project, zone, instanceGroupManager)</a></code></p>
<p class="firstline">Returns the specified Instance Group Manager resource.</p>
@@ -234,7 +234,7 @@
<div class="method">
<code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</code>
- <pre>Deletes the specified instances. The instances are removed from the instance group and any target pools of which they are a member, then deleted. The targetSize of the instance group manager is reduced by the number of instances deleted.
+ <pre>Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.
Args:
project: string, The Google Developers Console project name. (required)
@@ -316,6 +316,11 @@
"kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
"group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
"description": "A String", # An optional textual description of the instance group manager.
+ "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.
+ },
+ ],
"targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
"A String",
],
@@ -346,6 +351,11 @@
"kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
"group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
"description": "A String", # An optional textual description of the instance group manager.
+ "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.
+ },
+ ],
"targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
"A String",
],
@@ -430,6 +440,11 @@
"kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
"group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
"description": "A String", # An optional textual description of the instance group manager.
+ "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.
+ },
+ ],
"targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
"A String",
],
diff --git a/docs/dyn/replicapoolupdater_v1beta1.html b/docs/dyn/replicapoolupdater_v1beta1.html
index d3f800b..58bbaae 100644
--- a/docs/dyn/replicapoolupdater_v1beta1.html
+++ b/docs/dyn/replicapoolupdater_v1beta1.html
@@ -84,4 +84,25 @@
</p>
<p class="firstline">Returns the zoneOperations 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/replicapoolupdater_v1beta1.rollingUpdates.html b/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html
index 6df9e24..b3abcbe 100644
--- a/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html
+++ b/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html
@@ -120,9 +120,9 @@
{ # 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",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "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 (output only).
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
"operationType": "A String",
"httpErrorMessage": "A String",
"progress": 42,
@@ -145,20 +145,20 @@
"user": "A String",
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
"kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error 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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"endTime": "A String",
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -185,35 +185,31 @@
"kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
- "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
- "instances": [ # List of fully-qualified URLs of instances to be updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
- "A String",
- ],
+ "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
"instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
- "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups and explicit lists of instances.
+ "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
- "error": { # [Output Only] Errors that occurred during rolling update.
+ "error": { # [Output Only] Errors that occurred during the rolling update.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error 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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"policy": { # Parameters of the update process.
- "instanceStartupTimeoutSec": 42, # Maximum amount of time we will wait after finishing all steps until we receive HEALTHY state for instance. If this deadline is exceeded instance update is considered as failed.
- "maxNumConcurrentInstances": 42, # Maximum number of instances that can be updated simultaneously (concurrently). An update of an instance starts when the instance is about to be restarted and finishes after the instance has been restarted and the sleep period (defined by sleepAfterInstanceRestartSec) has passed.
- "minInstanceUpdateTimeSec": 42, # Specifies minimum amount of time we will spend on updating single instance, measuring at the start of the first update action (e.g. Recreate call on Instance Group Manager or Stop call on Instance resource). If actual instance update takes less time we will simply sleep before proceeding with next instance.
- "sleepAfterInstanceRestartSec": 42, # Time period after the instance has been restarted but before marking the update of this instance as done. This field is deprecated and ignored by Rolling Updater.
- "maxNumFailedInstances": 42, # Maximum number of instance updates that can fail without failing the group update. Instance update is considered failed if any of it's update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if after finishing all update actions this instance is in UNHEALTHY state.
- "autoPauseAfterInstances": 42, # Number of instances updated before the update gets automatically paused.
+ "autoPauseAfterInstances": 42, # Number of instances to update before the updater pauses the rolling update.
+ "instanceStartupTimeoutSec": 42, # The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
+ "maxNumConcurrentInstances": 42, # The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
+ "minInstanceUpdateTimeSec": 42, # The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
+ "maxNumFailedInstances": 42, # The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
},
"progress": 42, # [Output Only] An optional progress indicator that ranges from 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 update will be complete. This number should be monotonically increasing as the update progresses.
"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] The fully qualified URL for the resource.
- "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
+ "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
}</pre>
</div>
@@ -238,35 +234,31 @@
"kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
- "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
- "instances": [ # List of fully-qualified URLs of instances to be updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
- "A String",
- ],
+ "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
"instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
- "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups and explicit lists of instances.
+ "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
- "error": { # [Output Only] Errors that occurred during rolling update.
+ "error": { # [Output Only] Errors that occurred during the rolling update.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error 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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"policy": { # Parameters of the update process.
- "instanceStartupTimeoutSec": 42, # Maximum amount of time we will wait after finishing all steps until we receive HEALTHY state for instance. If this deadline is exceeded instance update is considered as failed.
- "maxNumConcurrentInstances": 42, # Maximum number of instances that can be updated simultaneously (concurrently). An update of an instance starts when the instance is about to be restarted and finishes after the instance has been restarted and the sleep period (defined by sleepAfterInstanceRestartSec) has passed.
- "minInstanceUpdateTimeSec": 42, # Specifies minimum amount of time we will spend on updating single instance, measuring at the start of the first update action (e.g. Recreate call on Instance Group Manager or Stop call on Instance resource). If actual instance update takes less time we will simply sleep before proceeding with next instance.
- "sleepAfterInstanceRestartSec": 42, # Time period after the instance has been restarted but before marking the update of this instance as done. This field is deprecated and ignored by Rolling Updater.
- "maxNumFailedInstances": 42, # Maximum number of instance updates that can fail without failing the group update. Instance update is considered failed if any of it's update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if after finishing all update actions this instance is in UNHEALTHY state.
- "autoPauseAfterInstances": 42, # Number of instances updated before the update gets automatically paused.
+ "autoPauseAfterInstances": 42, # Number of instances to update before the updater pauses the rolling update.
+ "instanceStartupTimeoutSec": 42, # The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
+ "maxNumConcurrentInstances": 42, # The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
+ "minInstanceUpdateTimeSec": 42, # The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
+ "maxNumFailedInstances": 42, # The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
},
"progress": 42, # [Output Only] An optional progress indicator that ranges from 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 update will be complete. This number should be monotonically increasing as the update progresses.
"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] The fully qualified URL for the resource.
- "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
+ "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
}
@@ -276,9 +268,9 @@
{ # 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",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "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 (output only).
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
"operationType": "A String",
"httpErrorMessage": "A String",
"progress": 42,
@@ -301,20 +293,20 @@
"user": "A String",
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
"kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error 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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"endTime": "A String",
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -327,7 +319,7 @@
zone: string, The name of the zone in which the update's target resides. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- instanceGroupManager: string, The name of the instance group manager used for filtering.
+ instanceGroupManager: string, The name of the instance group manager. Use this parameter to return only updates to instances that are part of a specific instance group.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
@@ -347,35 +339,31 @@
"kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
- "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
- "instances": [ # List of fully-qualified URLs of instances to be updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
- "A String",
- ],
+ "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
"instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
- "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups and explicit lists of instances.
+ "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
- "error": { # [Output Only] Errors that occurred during rolling update.
+ "error": { # [Output Only] Errors that occurred during the rolling update.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error 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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"policy": { # Parameters of the update process.
- "instanceStartupTimeoutSec": 42, # Maximum amount of time we will wait after finishing all steps until we receive HEALTHY state for instance. If this deadline is exceeded instance update is considered as failed.
- "maxNumConcurrentInstances": 42, # Maximum number of instances that can be updated simultaneously (concurrently). An update of an instance starts when the instance is about to be restarted and finishes after the instance has been restarted and the sleep period (defined by sleepAfterInstanceRestartSec) has passed.
- "minInstanceUpdateTimeSec": 42, # Specifies minimum amount of time we will spend on updating single instance, measuring at the start of the first update action (e.g. Recreate call on Instance Group Manager or Stop call on Instance resource). If actual instance update takes less time we will simply sleep before proceeding with next instance.
- "sleepAfterInstanceRestartSec": 42, # Time period after the instance has been restarted but before marking the update of this instance as done. This field is deprecated and ignored by Rolling Updater.
- "maxNumFailedInstances": 42, # Maximum number of instance updates that can fail without failing the group update. Instance update is considered failed if any of it's update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if after finishing all update actions this instance is in UNHEALTHY state.
- "autoPauseAfterInstances": 42, # Number of instances updated before the update gets automatically paused.
+ "autoPauseAfterInstances": 42, # Number of instances to update before the updater pauses the rolling update.
+ "instanceStartupTimeoutSec": 42, # The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
+ "maxNumConcurrentInstances": 42, # The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
+ "minInstanceUpdateTimeSec": 42, # The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
+ "maxNumFailedInstances": 42, # The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
},
"progress": 42, # [Output Only] An optional progress indicator that ranges from 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 update will be complete. This number should be monotonically increasing as the update progresses.
"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] The fully qualified URL for the resource.
- "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
+ "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
},
],
"kind": "replicapoolupdater#rollingUpdateList", # [Output Only] Type of the resource.
@@ -416,7 +404,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error 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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -470,9 +458,9 @@
{ # 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",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "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 (output only).
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
"operationType": "A String",
"httpErrorMessage": "A String",
"progress": 42,
@@ -495,20 +483,20 @@
"user": "A String",
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
"kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error 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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"endTime": "A String",
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -527,9 +515,9 @@
{ # 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",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "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 (output only).
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
"operationType": "A String",
"httpErrorMessage": "A String",
"progress": 42,
@@ -552,20 +540,20 @@
"user": "A String",
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
"kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error 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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"endTime": "A String",
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -584,9 +572,9 @@
{ # 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",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "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 (output only).
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
"operationType": "A String",
"httpErrorMessage": "A String",
"progress": 42,
@@ -609,20 +597,20 @@
"user": "A String",
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
"kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error 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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"endTime": "A String",
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/replicapoolupdater_v1beta1.zoneOperations.html b/docs/dyn/replicapoolupdater_v1beta1.zoneOperations.html
index 37a042e..2a5be5b 100644
--- a/docs/dyn/replicapoolupdater_v1beta1.zoneOperations.html
+++ b/docs/dyn/replicapoolupdater_v1beta1.zoneOperations.html
@@ -93,9 +93,9 @@
{ # 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",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "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 (output only).
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
"operationType": "A String",
"httpErrorMessage": "A String",
"progress": 42,
@@ -118,20 +118,20 @@
"user": "A String",
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
"kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error 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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"endTime": "A String",
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/reseller_v1.html b/docs/dyn/reseller_v1.html
index d8e9e0a..4acbb82 100644
--- a/docs/dyn/reseller_v1.html
+++ b/docs/dyn/reseller_v1.html
@@ -84,4 +84,25 @@
</p>
<p class="firstline">Returns the subscriptions 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/reseller_v1.subscriptions.html b/docs/dyn/reseller_v1.subscriptions.html
index a5bb7ff..47b0b2e 100644
--- a/docs/dyn/reseller_v1.subscriptions.html
+++ b/docs/dyn/reseller_v1.subscriptions.html
@@ -130,10 +130,9 @@
"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
"isInTrial": True or False, # Whether the subscription is in trial.
},
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
+ "suspensionReasons": [ # Suspension Reasons
+ "A String",
+ ],
"resourceUiUrl": "A String", # Ui url for subscription resource.
"seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
"kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
@@ -142,6 +141,10 @@
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
"creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
+ "transferInfo": { # Transfer related information for the subscription.
+ "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
+ "minimumTransferableSeats": 42,
+ },
"status": "A String", # Status of the subscription.
"plan": { # Plan details of the subscription
"planName": "A String", # The plan name of this subscription's plan.
@@ -195,10 +198,9 @@
"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
"isInTrial": True or False, # Whether the subscription is in trial.
},
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
+ "suspensionReasons": [ # Suspension Reasons
+ "A String",
+ ],
"resourceUiUrl": "A String", # Ui url for subscription resource.
"seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
"kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
@@ -207,6 +209,10 @@
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
"creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
+ "transferInfo": { # Transfer related information for the subscription.
+ "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
+ "minimumTransferableSeats": 42,
+ },
"status": "A String", # Status of the subscription.
"plan": { # Plan details of the subscription
"planName": "A String", # The plan name of this subscription's plan.
@@ -253,10 +259,9 @@
"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
"isInTrial": True or False, # Whether the subscription is in trial.
},
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
+ "suspensionReasons": [ # Suspension Reasons
+ "A String",
+ ],
"resourceUiUrl": "A String", # Ui url for subscription resource.
"seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
"kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
@@ -265,6 +270,10 @@
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
"creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
+ "transferInfo": { # Transfer related information for the subscription.
+ "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
+ "minimumTransferableSeats": 42,
+ },
"status": "A String", # Status of the subscription.
"plan": { # Plan details of the subscription
"planName": "A String", # The plan name of this subscription's plan.
@@ -313,10 +322,9 @@
"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
"isInTrial": True or False, # Whether the subscription is in trial.
},
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
+ "suspensionReasons": [ # Suspension Reasons
+ "A String",
+ ],
"resourceUiUrl": "A String", # Ui url for subscription resource.
"seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
"kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
@@ -325,6 +333,10 @@
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
"creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
+ "transferInfo": { # Transfer related information for the subscription.
+ "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
+ "minimumTransferableSeats": 42,
+ },
"status": "A String", # Status of the subscription.
"plan": { # Plan details of the subscription
"planName": "A String", # The plan name of this subscription's plan.
@@ -379,10 +391,9 @@
"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
"isInTrial": True or False, # Whether the subscription is in trial.
},
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
+ "suspensionReasons": [ # Suspension Reasons
+ "A String",
+ ],
"resourceUiUrl": "A String", # Ui url for subscription resource.
"seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
"kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
@@ -391,6 +402,10 @@
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
"creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
+ "transferInfo": { # Transfer related information for the subscription.
+ "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
+ "minimumTransferableSeats": 42,
+ },
"status": "A String", # Status of the subscription.
"plan": { # Plan details of the subscription
"planName": "A String", # The plan name of this subscription's plan.
@@ -427,10 +442,9 @@
"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
"isInTrial": True or False, # Whether the subscription is in trial.
},
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
+ "suspensionReasons": [ # Suspension Reasons
+ "A String",
+ ],
"resourceUiUrl": "A String", # Ui url for subscription resource.
"seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
"kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
@@ -439,6 +453,10 @@
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
"creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
+ "transferInfo": { # Transfer related information for the subscription.
+ "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
+ "minimumTransferableSeats": 42,
+ },
"status": "A String", # Status of the subscription.
"plan": { # Plan details of the subscription
"planName": "A String", # The plan name of this subscription's plan.
@@ -470,10 +488,9 @@
"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
"isInTrial": True or False, # Whether the subscription is in trial.
},
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
+ "suspensionReasons": [ # Suspension Reasons
+ "A String",
+ ],
"resourceUiUrl": "A String", # Ui url for subscription resource.
"seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
"kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
@@ -482,6 +499,10 @@
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
"creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
+ "transferInfo": { # Transfer related information for the subscription.
+ "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
+ "minimumTransferableSeats": 42,
+ },
"status": "A String", # Status of the subscription.
"plan": { # Plan details of the subscription
"planName": "A String", # The plan name of this subscription's plan.
@@ -527,10 +548,9 @@
"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
"isInTrial": True or False, # Whether the subscription is in trial.
},
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
+ "suspensionReasons": [ # Suspension Reasons
+ "A String",
+ ],
"resourceUiUrl": "A String", # Ui url for subscription resource.
"seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
"kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
@@ -539,6 +559,10 @@
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
"creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
+ "transferInfo": { # Transfer related information for the subscription.
+ "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
+ "minimumTransferableSeats": 42,
+ },
"status": "A String", # Status of the subscription.
"plan": { # Plan details of the subscription
"planName": "A String", # The plan name of this subscription's plan.
@@ -593,10 +617,9 @@
"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
"isInTrial": True or False, # Whether the subscription is in trial.
},
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
+ "suspensionReasons": [ # Suspension Reasons
+ "A String",
+ ],
"resourceUiUrl": "A String", # Ui url for subscription resource.
"seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
"kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
@@ -605,6 +628,10 @@
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
"creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
+ "transferInfo": { # Transfer related information for the subscription.
+ "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
+ "minimumTransferableSeats": 42,
+ },
"status": "A String", # Status of the subscription.
"plan": { # Plan details of the subscription
"planName": "A String", # The plan name of this subscription's plan.
@@ -643,10 +670,9 @@
"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
"isInTrial": True or False, # Whether the subscription is in trial.
},
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
+ "suspensionReasons": [ # Suspension Reasons
+ "A String",
+ ],
"resourceUiUrl": "A String", # Ui url for subscription resource.
"seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
"kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
@@ -655,6 +681,10 @@
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
"creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
+ "transferInfo": { # Transfer related information for the subscription.
+ "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
+ "minimumTransferableSeats": 42,
+ },
"status": "A String", # Status of the subscription.
"plan": { # Plan details of the subscription
"planName": "A String", # The plan name of this subscription's plan.
diff --git a/docs/dyn/resourceviews_v1beta2.html b/docs/dyn/resourceviews_v1beta2.html
index 09b07cd..76ab143 100644
--- a/docs/dyn/resourceviews_v1beta2.html
+++ b/docs/dyn/resourceviews_v1beta2.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="resourceviews_v1beta2.html">Resource Views API</a></h1>
+<h1><a href="resourceviews_v1beta2.html">Google Compute Engine Instance Groups API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="resourceviews_v1beta2.zoneOperations.html">zoneOperations()</a></code>
@@ -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/resourceviews_v1beta2.zoneOperations.html b/docs/dyn/resourceviews_v1beta2.zoneOperations.html
index 7352c9b..020c29a 100644
--- a/docs/dyn/resourceviews_v1beta2.zoneOperations.html
+++ b/docs/dyn/resourceviews_v1beta2.zoneOperations.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="resourceviews_v1beta2.html">Resource Views API</a> . <a href="resourceviews_v1beta2.zoneOperations.html">zoneOperations</a></h1>
+<h1><a href="resourceviews_v1beta2.html">Google Compute Engine Instance Groups API</a> . <a href="resourceviews_v1beta2.zoneOperations.html">zoneOperations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(project, zone, operation)</a></code></p>
diff --git a/docs/dyn/resourceviews_v1beta2.zoneViews.html b/docs/dyn/resourceviews_v1beta2.zoneViews.html
index cd715ba..2149411 100644
--- a/docs/dyn/resourceviews_v1beta2.zoneViews.html
+++ b/docs/dyn/resourceviews_v1beta2.zoneViews.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="resourceviews_v1beta2.html">Resource Views API</a> . <a href="resourceviews_v1beta2.zoneViews.html">zoneViews</a></h1>
+<h1><a href="resourceviews_v1beta2.html">Google Compute Engine Instance Groups API</a> . <a href="resourceviews_v1beta2.zoneViews.html">zoneViews</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addResources">addResources(project, zone, resourceView, body)</a></code></p>
diff --git a/docs/dyn/siteVerification_v1.html b/docs/dyn/siteVerification_v1.html
index a9eb596..3d082f4 100644
--- a/docs/dyn/siteVerification_v1.html
+++ b/docs/dyn/siteVerification_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the webResource 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/spectrum_v1explorer.html b/docs/dyn/spectrum_v1explorer.html
index 6968837..d272919 100644
--- a/docs/dyn/spectrum_v1explorer.html
+++ b/docs/dyn/spectrum_v1explorer.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the paws 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_v1beta4.databases.html b/docs/dyn/sqladmin_v1beta4.databases.html
index db420f5..432681a 100644
--- a/docs/dyn/sqladmin_v1beta4.databases.html
+++ b/docs/dyn/sqladmin_v1beta4.databases.html
@@ -121,7 +121,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -144,10 +144,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -227,7 +228,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -250,10 +251,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -338,7 +340,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -361,10 +363,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -421,7 +424,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -444,10 +447,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
diff --git a/docs/dyn/sqladmin_v1beta4.html b/docs/dyn/sqladmin_v1beta4.html
index f764fea..7346948 100644
--- a/docs/dyn/sqladmin_v1beta4.html
+++ b/docs/dyn/sqladmin_v1beta4.html
@@ -114,4 +114,25 @@
</p>
<p class="firstline">Returns the users 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_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index a493aae..734af62 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -165,7 +165,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -188,10 +188,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -233,7 +234,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -256,10 +257,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -325,7 +327,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -348,10 +350,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -378,10 +381,34 @@
An object of the form:
{ # A Cloud SQL instance resource.
- "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ },
"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.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters.
+ "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
+ "username": "A String", # The username for the replication connection.
+ "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
+ "password": "A String", # The password for the replication connection.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ },
+ },
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "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.
"serverCaCert": { # SslCerts Resource # SSL configuration.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
@@ -391,17 +418,31 @@
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
- "selfLink": "A String",
+ "selfLink": "A String", # The URI of this resource.
},
- "replicaNames": [ # The replicas of the instance.
- "A String",
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
+ # RUNNABLE: The instance is running, or is ready to run when accessed.
+ # SUSPENDED: The instance is not available, for example due to problems with billing.
+ # PENDING_CREATE: The instance is being created.
+ # MAINTENANCE: The instance is down for maintenance.
+ # FAILED: The instance creation failed.
+ # 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.
+ },
],
- "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.
+ "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 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.
@@ -430,9 +471,10 @@
},
],
},
+ "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
- "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled.
"pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
@@ -441,25 +483,9 @@
"followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
},
},
- "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
- "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
- "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
- # RUNNABLE: The instance is running, or is ready to run when accessed.
- # SUSPENDED: The instance is not available, for example due to problems with billing.
- # PENDING_CREATE: The instance is being created.
- # 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.
- },
- ],
- "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 can not be changed after instance creation.
"instanceType": "A String", # The instance type. This can be one of the following.
# CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.
+ # ON_PREMISES_INSTANCE: An instance running on the customer's premises.
# READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
"selfLink": "A String", # The URI of this resource.
"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
@@ -513,7 +539,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -536,10 +562,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -564,10 +591,34 @@
The object takes the form of:
{ # A Cloud SQL instance resource.
- "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ },
"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.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters.
+ "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
+ "username": "A String", # The username for the replication connection.
+ "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
+ "password": "A String", # The password for the replication connection.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ },
+ },
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "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.
"serverCaCert": { # SslCerts Resource # SSL configuration.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
@@ -577,17 +628,31 @@
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
- "selfLink": "A String",
+ "selfLink": "A String", # The URI of this resource.
},
- "replicaNames": [ # The replicas of the instance.
- "A String",
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
+ # RUNNABLE: The instance is running, or is ready to run when accessed.
+ # SUSPENDED: The instance is not available, for example due to problems with billing.
+ # PENDING_CREATE: The instance is being created.
+ # MAINTENANCE: The instance is down for maintenance.
+ # FAILED: The instance creation failed.
+ # 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.
+ },
],
- "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.
+ "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 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.
@@ -616,9 +681,10 @@
},
],
},
+ "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
- "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled.
"pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
@@ -627,25 +693,9 @@
"followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
},
},
- "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
- "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
- "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
- # RUNNABLE: The instance is running, or is ready to run when accessed.
- # SUSPENDED: The instance is not available, for example due to problems with billing.
- # PENDING_CREATE: The instance is being created.
- # 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.
- },
- ],
- "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 can not be changed after instance creation.
"instanceType": "A String", # The instance type. This can be one of the following.
# CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.
+ # ON_PREMISES_INSTANCE: An instance running on the customer's premises.
# READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
"selfLink": "A String", # The URI of this resource.
"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
@@ -671,7 +721,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -694,10 +744,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -728,10 +779,34 @@
"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": [ # List of database instance resources.
{ # A Cloud SQL instance resource.
- "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ },
"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.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters.
+ "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
+ "username": "A String", # The username for the replication connection.
+ "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
+ "password": "A String", # The password for the replication connection.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ },
+ },
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "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.
"serverCaCert": { # SslCerts Resource # SSL configuration.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
@@ -741,17 +816,31 @@
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
- "selfLink": "A String",
+ "selfLink": "A String", # The URI of this resource.
},
- "replicaNames": [ # The replicas of the instance.
- "A String",
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
+ # RUNNABLE: The instance is running, or is ready to run when accessed.
+ # SUSPENDED: The instance is not available, for example due to problems with billing.
+ # PENDING_CREATE: The instance is being created.
+ # MAINTENANCE: The instance is down for maintenance.
+ # FAILED: The instance creation failed.
+ # 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.
+ },
],
- "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.
+ "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 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.
@@ -780,9 +869,10 @@
},
],
},
+ "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
- "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled.
"pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
@@ -791,25 +881,9 @@
"followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
},
},
- "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
- "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
- "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
- # RUNNABLE: The instance is running, or is ready to run when accessed.
- # SUSPENDED: The instance is not available, for example due to problems with billing.
- # PENDING_CREATE: The instance is being created.
- # 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.
- },
- ],
- "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 can not be changed after instance creation.
"instanceType": "A String", # The instance type. This can be one of the following.
# CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.
+ # ON_PREMISES_INSTANCE: An instance running on the customer's premises.
# READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
"selfLink": "A String", # The URI of this resource.
"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
@@ -844,10 +918,34 @@
The object takes the form of:
{ # A Cloud SQL instance resource.
- "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ },
"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.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters.
+ "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
+ "username": "A String", # The username for the replication connection.
+ "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
+ "password": "A String", # The password for the replication connection.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ },
+ },
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "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.
"serverCaCert": { # SslCerts Resource # SSL configuration.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
@@ -857,17 +955,31 @@
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
- "selfLink": "A String",
+ "selfLink": "A String", # The URI of this resource.
},
- "replicaNames": [ # The replicas of the instance.
- "A String",
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
+ # RUNNABLE: The instance is running, or is ready to run when accessed.
+ # SUSPENDED: The instance is not available, for example due to problems with billing.
+ # PENDING_CREATE: The instance is being created.
+ # MAINTENANCE: The instance is down for maintenance.
+ # FAILED: The instance creation failed.
+ # 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.
+ },
],
- "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.
+ "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 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.
@@ -896,9 +1008,10 @@
},
],
},
+ "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
- "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled.
"pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
@@ -907,25 +1020,9 @@
"followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
},
},
- "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
- "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
- "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
- # RUNNABLE: The instance is running, or is ready to run when accessed.
- # SUSPENDED: The instance is not available, for example due to problems with billing.
- # PENDING_CREATE: The instance is being created.
- # 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.
- },
- ],
- "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 can not be changed after instance creation.
"instanceType": "A String", # The instance type. This can be one of the following.
# CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.
+ # ON_PREMISES_INSTANCE: An instance running on the customer's premises.
# READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
"selfLink": "A String", # The URI of this resource.
"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
@@ -951,7 +1048,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -974,10 +1071,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -1019,7 +1117,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -1042,10 +1140,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -1087,7 +1186,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -1110,10 +1209,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -1155,7 +1255,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -1178,10 +1278,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -1208,6 +1309,7 @@
{ # Database instance restore backup request.
"restoreBackupContext": { # Database instance restore from backup context. # Parameters required to perform the restore backup operation.
+ "instanceId": "A String", # The ID of the instance that the backup was taken from.
"kind": "sql#restoreBackupContext", # This is always sql#restoreBackupContext.
"backupRunId": "A String", # The ID of the backup run to restore from.
},
@@ -1233,7 +1335,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -1256,10 +1358,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -1301,7 +1404,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -1324,10 +1427,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -1369,7 +1473,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -1392,10 +1496,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -1421,10 +1526,34 @@
The object takes the form of:
{ # A Cloud SQL instance resource.
- "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ },
"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.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters.
+ "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
+ "username": "A String", # The username for the replication connection.
+ "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
+ "password": "A String", # The password for the replication connection.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ },
+ },
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "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.
"serverCaCert": { # SslCerts Resource # SSL configuration.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
@@ -1434,17 +1563,31 @@
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
- "selfLink": "A String",
+ "selfLink": "A String", # The URI of this resource.
},
- "replicaNames": [ # The replicas of the instance.
- "A String",
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
+ # RUNNABLE: The instance is running, or is ready to run when accessed.
+ # SUSPENDED: The instance is not available, for example due to problems with billing.
+ # PENDING_CREATE: The instance is being created.
+ # MAINTENANCE: The instance is down for maintenance.
+ # FAILED: The instance creation failed.
+ # 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.
+ },
],
- "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.
+ "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 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.
@@ -1473,9 +1616,10 @@
},
],
},
+ "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
- "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled.
"pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
@@ -1484,25 +1628,9 @@
"followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
},
},
- "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
- "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
- "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
- # RUNNABLE: The instance is running, or is ready to run when accessed.
- # SUSPENDED: The instance is not available, for example due to problems with billing.
- # PENDING_CREATE: The instance is being created.
- # 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.
- },
- ],
- "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 can not be changed after instance creation.
"instanceType": "A String", # The instance type. This can be one of the following.
# CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.
+ # ON_PREMISES_INSTANCE: An instance running on the customer's premises.
# READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
"selfLink": "A String", # The URI of this resource.
"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
@@ -1528,7 +1656,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -1551,10 +1679,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
diff --git a/docs/dyn/sqladmin_v1beta4.operations.html b/docs/dyn/sqladmin_v1beta4.operations.html
index 80970e8..9b0d89a 100644
--- a/docs/dyn/sqladmin_v1beta4.operations.html
+++ b/docs/dyn/sqladmin_v1beta4.operations.html
@@ -111,7 +111,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -134,10 +134,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -184,7 +185,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -207,10 +208,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
diff --git a/docs/dyn/sqladmin_v1beta4.sslCerts.html b/docs/dyn/sqladmin_v1beta4.sslCerts.html
index 21675da..58e35a2 100644
--- a/docs/dyn/sqladmin_v1beta4.sslCerts.html
+++ b/docs/dyn/sqladmin_v1beta4.sslCerts.html
@@ -115,7 +115,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -138,10 +138,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -177,7 +178,7 @@
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
- "selfLink": "A String",
+ "selfLink": "A String", # The URI of this resource.
}</pre>
</div>
@@ -212,7 +213,7 @@
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
- "selfLink": "A String",
+ "selfLink": "A String", # The URI of this resource.
},
},
"serverCaCert": { # SslCerts Resource # The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource.
@@ -224,7 +225,7 @@
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
- "selfLink": "A String",
+ "selfLink": "A String", # The URI of this resource.
},
}</pre>
</div>
@@ -251,7 +252,7 @@
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
- "selfLink": "A String",
+ "selfLink": "A String", # The URI of this resource.
},
],
"kind": "sql#sslCertsList", # This is always sql#sslCertsList.
diff --git a/docs/dyn/sqladmin_v1beta4.users.html b/docs/dyn/sqladmin_v1beta4.users.html
index 8c18bc1..df22d0c 100644
--- a/docs/dyn/sqladmin_v1beta4.users.html
+++ b/docs/dyn/sqladmin_v1beta4.users.html
@@ -116,7 +116,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -139,10 +139,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -172,7 +173,7 @@
"name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified on the URL.
"project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL.
"instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL.
- "host": "A String", # The host name from which the user can connect. For insert operations, host is set to '%'. For update operations, host is specified as part of the request URL. The host name is not mutable with this API.
+ "host": "A String", # The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name is not mutable with this API.
"etag": "A String", # HTTP 1.1 Entity tag for the resource.
"password": "A String", # The password for the user.
}
@@ -197,7 +198,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -220,10 +221,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
@@ -257,7 +259,7 @@
"name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified on the URL.
"project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL.
"instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL.
- "host": "A String", # The host name from which the user can connect. For insert operations, host is set to '%'. For update operations, host is specified as part of the request URL. The host name is not mutable with this API.
+ "host": "A String", # The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name is not mutable with this API.
"etag": "A String", # HTTP 1.1 Entity tag for the resource.
"password": "A String", # The password for the user.
},
@@ -283,7 +285,7 @@
"name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified on the URL.
"project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL.
"instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL.
- "host": "A String", # The host name from which the user can connect. For insert operations, host is set to '%'. For update operations, host is specified as part of the request URL. The host name is not mutable with this API.
+ "host": "A String", # The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name is not mutable with this API.
"etag": "A String", # HTTP 1.1 Entity tag for the resource.
"password": "A String", # The password for the user.
}
@@ -308,7 +310,7 @@
],
},
},
- "kind": "sql#operation", # This is always sql#instanceOperation.
+ "kind": "sql#operation", # This is always sql#operation.
"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
@@ -331,10 +333,11 @@
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
- "operationType": "A String", # TODO(b/18431310): update this list to reflect current values. The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
+ "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
"targetLink": "A String", # The URI of the instance related to the operation.
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # If errors occurred during processing of this operation, this field will be populated.
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+ "kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html
index 47ebd6d..f70717f 100644
--- a/docs/dyn/storage_v1.buckets.html
+++ b/docs/dyn/storage_v1.buckets.html
@@ -237,7 +237,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. 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. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
}</pre>
</div>
@@ -364,7 +364,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. 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. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults 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.
@@ -504,7 +504,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. 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. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
}</pre>
</div>
@@ -642,7 +642,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. 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. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults 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.
@@ -786,7 +786,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. 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. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
}
projection: string, Set of properties to return. Defaults to full.
@@ -928,7 +928,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. 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. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
}</pre>
</div>
@@ -1055,7 +1055,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. 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. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
}
projection: string, Set of properties to return. Defaults to full.
@@ -1197,7 +1197,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. 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. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
}</pre>
</div>
diff --git a/docs/dyn/storage_v1.html b/docs/dyn/storage_v1.html
index 131abc8..04ddbc9 100644
--- a/docs/dyn/storage_v1.html
+++ b/docs/dyn/storage_v1.html
@@ -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_v1.objects.html b/docs/dyn/storage_v1.objects.html
index 6cf71f2..0a2dc46 100644
--- a/docs/dyn/storage_v1.objects.html
+++ b/docs/dyn/storage_v1.objects.html
@@ -82,10 +82,10 @@
<p class="firstline">Concatenates a list of existing objects into a new object in the same bucket.</p>
<p class="toc_element">
<code><a href="#copy">copy(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
-<p class="firstline">Copies an object to a specified location. Optionally overrides metadata.</p>
+<p class="firstline">Copies a source object to a destination object. Optionally overrides metadata.</p>
<p class="toc_element">
<code><a href="#copy_media">copy_media(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
-<p class="firstline">Copies an object to a specified location. Optionally overrides metadata.</p>
+<p class="firstline">Copies a source object to a destination object. Optionally overrides metadata.</p>
<p class="toc_element">
<code><a href="#delete">delete(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.</p>
@@ -111,6 +111,9 @@
<code><a href="#patch">patch(bucket, object, body, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None)</a></code></p>
<p class="firstline">Updates an object's metadata. This method supports patch semantics.</p>
<p class="toc_element">
+ <code><a href="#rewrite">rewrite(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, maxBytesRewrittenPerCall=None, ifSourceGenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, rewriteToken=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
+<p class="firstline">Rewrites a source object to a destination object. Optionally overrides metadata.</p>
+<p class="toc_element">
<code><a href="#update">update(bucket, object, body, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None)</a></code></p>
<p class="firstline">Updates an object's metadata.</p>
<p class="toc_element">
@@ -176,7 +179,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -262,7 +265,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -337,7 +340,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -384,7 +387,7 @@
<div class="method">
<code class="details" id="copy">copy(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code>
- <pre>Copies an object to a specified location. Optionally overrides metadata.
+ <pre>Copies a source object to a destination object. Optionally overrides metadata.
Args:
sourceBucket: string, Name of the bucket in which to find the source object. (required)
@@ -438,7 +441,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -525,7 +528,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -546,7 +549,7 @@
<div class="method">
<code class="details" id="copy_media">copy_media(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code>
- <pre>Copies an object to a specified location. Optionally overrides metadata.
+ <pre>Copies a source object to a destination object. Optionally overrides metadata.
Args:
sourceBucket: string, Name of the bucket in which to find the source object. (required)
@@ -600,7 +603,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -725,7 +728,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -820,7 +823,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -905,7 +908,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -977,7 +980,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -1031,9 +1034,9 @@
Allowed values
full - Include all properties.
noAcl - Omit the acl property.
- versions: boolean, If true, lists all versions of a file as distinct results.
+ versions: boolean, If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
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.
- maxResults: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested.
+ maxResults: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. The default value of this parameter is 1,000 items.
pageToken: string, A previously-returned page token representing part of the larger set of results to view.
prefix: string, Filter results to objects whose names begin with this prefix.
@@ -1087,7 +1090,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -1180,7 +1183,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -1263,7 +1266,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -1283,6 +1286,177 @@
</div>
<div class="method">
+ <code class="details" id="rewrite">rewrite(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, maxBytesRewrittenPerCall=None, ifSourceGenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, rewriteToken=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code>
+ <pre>Rewrites a source object to a destination object. Optionally overrides metadata.
+
+Args:
+ sourceBucket: string, Name of the bucket in which to find the source object. (required)
+ sourceObject: string, Name of the source object. (required)
+ destinationBucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required)
+ destinationObject: string, Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An object.
+ "generation": "A String", # The content generation of this object. Used for object versioning.
+ "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
+ "mediaLink": "A String", # Media download link.
+ "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.
+ "generation": "A String", # The content generation of the object.
+ "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.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - project-team-projectId
+ # - 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.
+ "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "id": "A String", # The ID of the access-control entry.
+ "entityId": "A String", # The ID for the entity, if any.
+ "projectTeam": { # The project team associated with the entity, if any.
+ "projectNumber": "A String", # The project number.
+ "team": "A String", # The team. Can be owners, editors, or viewers.
+ },
+ "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.
+ "size": "A String", # Content-Length of the data in bytes.
+ "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
+ "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
+ "etag": "A String", # HTTP 1.1 Entity tag for the object.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property.
+ "contentType": "A String", # Content-Type of the object data.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
+ "bucket": "A String", # The name of the bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "storageClass": "A String", # Storage class of the object.
+ "selfLink": "A String", # The link to this object.
+ }
+
+ projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
+ Allowed values
+ full - Include all properties.
+ noAcl - Omit the acl property.
+ sourceGeneration: string, If present, selects a specific revision of the source object (as opposed to the latest version, the default).
+ maxBytesRewrittenPerCall: string, The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.
+ ifSourceGenerationNotMatch: string, Makes the operation conditional on whether the source object's generation does not match the given value.
+ ifGenerationMatch: string, Makes the operation conditional on whether the destination object's current generation matches the given value.
+ ifGenerationNotMatch: string, Makes the operation conditional on whether the destination object's current generation does not match the given value.
+ ifSourceMetagenerationNotMatch: string, Makes the operation conditional on whether the source object's current metageneration does not match the given value.
+ rewriteToken: string, Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.
+ ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value.
+ destinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
+ Allowed values
+ authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
+ bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
+ bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
+ private - Object owner gets OWNER access.
+ projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
+ publicRead - Object owner gets OWNER access, and allUsers get READER access.
+ ifSourceGenerationMatch: string, Makes the operation conditional on whether the source object's generation matches the given value.
+ ifSourceMetagenerationMatch: string, Makes the operation conditional on whether the source 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.
+
+Returns:
+ An object of the form:
+
+ { # A rewrite response.
+ "objectSize": "A String", # The total size of the object being copied in bytes. This property is always present in the response.
+ "kind": "storage#rewriteResponse", # The kind of item this is.
+ "resource": { # An object. # A resource containing the metadata for the copied-to object. This property is present in the response only when copying completes.
+ "generation": "A String", # The content generation of this object. Used for object versioning.
+ "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
+ "mediaLink": "A String", # Media download link.
+ "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.
+ "generation": "A String", # The content generation of the object.
+ "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.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - project-team-projectId
+ # - 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.
+ "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "id": "A String", # The ID of the access-control entry.
+ "entityId": "A String", # The ID for the entity, if any.
+ "projectTeam": { # The project team associated with the entity, if any.
+ "projectNumber": "A String", # The project number.
+ "team": "A String", # The team. Can be owners, editors, or viewers.
+ },
+ "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.
+ "size": "A String", # Content-Length of the data in bytes.
+ "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
+ "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
+ "etag": "A String", # HTTP 1.1 Entity tag for the object.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property.
+ "contentType": "A String", # Content-Type of the object data.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
+ "bucket": "A String", # The name of the bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "storageClass": "A String", # Storage class of the object.
+ "selfLink": "A String", # The link to this object.
+ },
+ "done": True or False, # true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response.
+ "totalBytesRewritten": "A String", # The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response.
+ "rewriteToken": "A String", # A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="update">update(bucket, object, body, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None)</code>
<pre>Updates an object's metadata.
@@ -1336,7 +1510,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -1419,7 +1593,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -1492,7 +1666,7 @@
"size": "A String", # Content-Length of the data in bytes.
"timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
+ "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
@@ -1562,9 +1736,9 @@
Allowed values
full - Include all properties.
noAcl - Omit the acl property.
- versions: boolean, If true, lists all versions of a file as distinct results.
+ versions: boolean, If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
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.
- maxResults: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested.
+ maxResults: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. The default value of this parameter is 1,000 items.
pageToken: string, A previously-returned page token representing part of the larger set of results to view.
prefix: string, Filter results to objects whose names begin with this prefix.
diff --git a/docs/dyn/tagmanager_v1.html b/docs/dyn/tagmanager_v1.html
index 53d3777..11b898f 100644
--- a/docs/dyn/tagmanager_v1.html
+++ b/docs/dyn/tagmanager_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the accounts 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/taskqueue_v1beta2.html b/docs/dyn/taskqueue_v1beta2.html
index 243bcdf..b9cf898 100644
--- a/docs/dyn/taskqueue_v1beta2.html
+++ b/docs/dyn/taskqueue_v1beta2.html
@@ -84,4 +84,25 @@
</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>
+<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/tasks_v1.html b/docs/dyn/tasks_v1.html
index 5acf5d4..1588d7e 100644
--- a/docs/dyn/tasks_v1.html
+++ b/docs/dyn/tasks_v1.html
@@ -84,4 +84,25 @@
</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>
+<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/translate_v2.html b/docs/dyn/translate_v2.html
index fbb90f7..1513e1c 100644
--- a/docs/dyn/translate_v2.html
+++ b/docs/dyn/translate_v2.html
@@ -89,4 +89,25 @@
</p>
<p class="firstline">Returns the translations 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/urlshortener_v1.html b/docs/dyn/urlshortener_v1.html
index 1ef8ccd..62eeefa 100644
--- a/docs/dyn/urlshortener_v1.html
+++ b/docs/dyn/urlshortener_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the url 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/webfonts_v1.html b/docs/dyn/webfonts_v1.html
index 2ae835b..4abd27c 100644
--- a/docs/dyn/webfonts_v1.html
+++ b/docs/dyn/webfonts_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the webfonts 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/webmasters_v3.html b/docs/dyn/webmasters_v3.html
index 5c2768a..62af147 100644
--- a/docs/dyn/webmasters_v3.html
+++ b/docs/dyn/webmasters_v3.html
@@ -94,4 +94,25 @@
</p>
<p class="firstline">Returns the urlcrawlerrorssamples 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/youtubeAnalytics_v1.html b/docs/dyn/youtubeAnalytics_v1.html
index 8ec35ee..5584c1a 100644
--- a/docs/dyn/youtubeAnalytics_v1.html
+++ b/docs/dyn/youtubeAnalytics_v1.html
@@ -99,4 +99,25 @@
</p>
<p class="firstline">Returns the reports 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/youtubeAnalytics_v1.reports.html b/docs/dyn/youtubeAnalytics_v1.reports.html
index d389b5b..c7f5a94 100644
--- a/docs/dyn/youtubeAnalytics_v1.reports.html
+++ b/docs/dyn/youtubeAnalytics_v1.reports.html
@@ -75,11 +75,11 @@
<h1><a href="youtubeAnalytics_v1.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v1.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, filters=None, max_results=None, start_index=None)</a></code></p>
+ <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, filters=None, max_results=None, start_index=None)</code>
+ <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:
@@ -91,6 +91,7 @@
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).
diff --git a/docs/dyn/youtube_v3.captions.html b/docs/dyn/youtube_v3.captions.html
new file mode 100644
index 0000000..a7ea63e
--- /dev/null
+++ b/docs/dyn/youtube_v3.captions.html
@@ -0,0 +1,331 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.captions.html">captions</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, onBehalfOf=None, debugProjectIdOverride=None)</a></code></p>
+<p class="firstline">Deletes a specified caption track.</p>
+<p class="toc_element">
+ <code><a href="#download">download(id, onBehalfOfContentOwner=None, onBehalfOf=None, debugProjectIdOverride=None, tfmt=None, tlang=None)</a></code></p>
+<p class="firstline">Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.</p>
+<p class="toc_element">
+ <code><a href="#download_media">download_media(id, onBehalfOfContentOwner=None, onBehalfOf=None, debugProjectIdOverride=None, tfmt=None, tlang=None)</a></code></p>
+<p class="firstline">Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(part, body=None, media_body=None, onBehalfOf=None, sync=None, debugProjectIdOverride=None, onBehalfOfContentOwner=None)</a></code></p>
+<p class="firstline">Uploads a caption track.</p>
+<p class="toc_element">
+ <code><a href="#list">list(part, videoId, onBehalfOfContentOwner=None, onBehalfOf=None, debugProjectIdOverride=None, id=None)</a></code></p>
+<p class="firstline">Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.</p>
+<p class="toc_element">
+ <code><a href="#update">update(part, body=None, media_body=None, onBehalfOf=None, sync=None, debugProjectIdOverride=None, onBehalfOfContentOwner=None)</a></code></p>
+<p class="firstline">Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOf=None, debugProjectIdOverride=None)</code>
+ <pre>Deletes a specified caption track.
+
+Args:
+ id: string, The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource. (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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
+ debugProjectIdOverride: string, The debugProjectIdOverride parameter should be used for mimicking a request for a certain project ID
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="download">download(id, onBehalfOfContentOwner=None, onBehalfOf=None, debugProjectIdOverride=None, tfmt=None, tlang=None)</code>
+ <pre>Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.
+
+Args:
+ id: string, The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource. (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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
+ debugProjectIdOverride: string, The debugProjectIdOverride parameter should be used for mimicking a request for a certain project ID
+ tfmt: string, The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.
+ Allowed values
+ sbv - SubViewer subtitle.
+ scc - Scenarist Closed Caption format.
+ srt - SubRip subtitle.
+ ttml - Timed Text Markup Language caption.
+ vtt - Web Video Text Tracks caption.
+ tlang: string, The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="download_media">download_media(id, onBehalfOfContentOwner=None, onBehalfOf=None, debugProjectIdOverride=None, tfmt=None, tlang=None)</code>
+ <pre>Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.
+
+Args:
+ id: string, The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource. (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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
+ debugProjectIdOverride: string, The debugProjectIdOverride parameter should be used for mimicking a request for a certain project ID
+ tfmt: string, The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.
+ Allowed values
+ sbv - SubViewer subtitle.
+ scc - Scenarist Closed Caption format.
+ srt - SubRip subtitle.
+ ttml - Timed Text Markup Language caption.
+ vtt - Web Video Text Tracks caption.
+ tlang: string, The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(part, body=None, media_body=None, onBehalfOf=None, sync=None, debugProjectIdOverride=None, onBehalfOfContentOwner=None)</code>
+ <pre>Uploads a caption track.
+
+Args:
+ part: string, The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "status": "A String", # The caption track's status.
+ "audioTrackType": "A String", # The type of audio track associated with the caption track.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track.
+ "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
+ "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
+ "trackKind": "A String", # The caption track's type.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
+ },
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ }
+
+ media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
+ sync: boolean, The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions.
+
+You should set the sync parameter to true if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.
+ debugProjectIdOverride: string, The debugProjectIdOverride parameter should be used for mimicking a request for a certain project ID.
+ 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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+
+Returns:
+ An object of the form:
+
+ { # A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "status": "A String", # The caption track's status.
+ "audioTrackType": "A String", # The type of audio track associated with the caption track.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track.
+ "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
+ "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
+ "trackKind": "A String", # The caption track's type.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
+ },
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(part, videoId, onBehalfOfContentOwner=None, onBehalfOf=None, debugProjectIdOverride=None, id=None)</code>
+ <pre>Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.
+
+Args:
+ part: string, The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet. (required)
+ videoId: string, The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks. (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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
+ debugProjectIdOverride: string, The debugProjectIdOverride parameter should be used for mimicking a request for a certain project ID.
+ id: string, The id parameter specifies a comma-separated list of IDs that identify the caption resources that should be retrieved. Each ID must identify a caption track associated with the specified video.
+
+Returns:
+ An object of the form:
+
+ {
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
+ "items": [ # A list of captions that match the request criteria.
+ { # A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "status": "A String", # The caption track's status.
+ "audioTrackType": "A String", # The type of audio track associated with the caption track.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track.
+ "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
+ "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
+ "trackKind": "A String", # The caption track's type.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
+ },
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ },
+ ],
+ "kind": "youtube#captionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#captionListResponse".
+ "etag": "A String", # Etag of this resource.
+ "visitorId": "A String", # The visitorId identifies the visitor.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(part, body=None, media_body=None, onBehalfOf=None, sync=None, debugProjectIdOverride=None, onBehalfOfContentOwner=None)</code>
+ <pre>Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.
+
+Args:
+ part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "status": "A String", # The caption track's status.
+ "audioTrackType": "A String", # The type of audio track associated with the caption track.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track.
+ "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
+ "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
+ "trackKind": "A String", # The caption track's type.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
+ },
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ }
+
+ media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
+ sync: boolean, Note: The API server only processes the parameter value if the request contains an updated caption file.
+
+The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will automatically synchronize the caption track with the audio track.
+ debugProjectIdOverride: string, The debugProjectIdOverride parameter should be used for mimicking a request for a certain project ID.
+ 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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+
+Returns:
+ An object of the form:
+
+ { # A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "status": "A String", # The caption track's status.
+ "audioTrackType": "A String", # The type of audio track associated with the caption track.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track.
+ "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
+ "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
+ "trackKind": "A String", # The caption track's type.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
+ },
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/youtube_v3.channelSections.html b/docs/dyn/youtube_v3.channelSections.html
index bcf573b..6be2954 100644
--- a/docs/dyn/youtube_v3.channelSections.html
+++ b/docs/dyn/youtube_v3.channelSections.html
@@ -81,7 +81,7 @@
<code><a href="#insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
<p class="firstline">Adds a channelSection for the authenticated user's channel.</p>
<p class="toc_element">
- <code><a href="#list">list(part=None, onBehalfOfContentOwner=None, channelId=None, mine=None, id=None)</a></code></p>
+ <code><a href="#list">list(part=None, onBehalfOfContentOwner=None, hl=None, channelId=None, mine=None, id=None)</a></code></p>
<p class="firstline">Returns channelSection resources that match the API request criteria.</p>
<p class="toc_element">
<code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None)</a></code></p>
@@ -112,6 +112,17 @@
{
"kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
+ "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
+ "languages": [ # The language the channel section is targeting.
+ "A String",
+ ],
+ "regions": [ # The region the channel section is targeting.
+ "A String",
+ ],
+ "countries": [ # The country the channel section is targeting.
+ "A String",
+ ],
+ },
"contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
"channels": [ # The channel ids for type multiple_channels.
"A String",
@@ -154,6 +165,17 @@
{
"kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
+ "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
+ "languages": [ # The language the channel section is targeting.
+ "A String",
+ ],
+ "regions": [ # The region the channel section is targeting.
+ "A String",
+ ],
+ "countries": [ # The country the channel section is targeting.
+ "A String",
+ ],
+ },
"contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
"channels": [ # The channel ids for type multiple_channels.
"A String",
@@ -184,7 +206,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(part=None, onBehalfOfContentOwner=None, channelId=None, mine=None, id=None)</code>
+ <code class="details" id="list">list(part=None, onBehalfOfContentOwner=None, hl=None, channelId=None, mine=None, id=None)</code>
<pre>Returns channelSection resources that match the API request criteria.
Args:
@@ -194,6 +216,7 @@
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.
+ hl: string, The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.
channelId: string, The channelId parameter specifies a YouTube channel ID. The API will only return that channel's channelSections.
mine: boolean, Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections.
id: string, The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved. In a channelSection resource, the id property specifies the YouTube channelSection ID.
@@ -206,6 +229,17 @@
"items": [ # A list of ChannelSections that match the request criteria.
{
"kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
+ "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
+ "languages": [ # The language the channel section is targeting.
+ "A String",
+ ],
+ "regions": [ # The region the channel section is targeting.
+ "A String",
+ ],
+ "countries": [ # The country the channel section is targeting.
+ "A String",
+ ],
+ },
"contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
"channels": [ # The channel ids for type multiple_channels.
"A String",
@@ -253,6 +287,17 @@
{
"kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
+ "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
+ "languages": [ # The language the channel section is targeting.
+ "A String",
+ ],
+ "regions": [ # The region the channel section is targeting.
+ "A String",
+ ],
+ "countries": [ # The country the channel section is targeting.
+ "A String",
+ ],
+ },
"contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
"channels": [ # The channel ids for type multiple_channels.
"A String",
@@ -290,6 +335,17 @@
{
"kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
+ "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
+ "languages": [ # The language the channel section is targeting.
+ "A String",
+ ],
+ "regions": [ # The region the channel section is targeting.
+ "A String",
+ ],
+ "countries": [ # The country the channel section is targeting.
+ "A String",
+ ],
+ },
"contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
"channels": [ # The channel ids for type multiple_channels.
"A String",
diff --git a/docs/dyn/youtube_v3.channels.html b/docs/dyn/youtube_v3.channels.html
index c90b919..29f5e3f 100644
--- a/docs/dyn/youtube_v3.channels.html
+++ b/docs/dyn/youtube_v3.channels.html
@@ -75,7 +75,7 @@
<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.channels.html">channels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(part=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)</a></code></p>
+ <code><a href="#list">list(part=None, hl=None, mine=None, mySubscribers=None, id=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, pageToken=None, categoryId=None, maxResults=None)</a></code></p>
<p class="firstline">Returns a collection of zero or more channel resources that match the request criteria.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -85,22 +85,23 @@
<p class="firstline">Updates a channel's metadata.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(part=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)</code>
+ <code class="details" id="list">list(part=None, hl=None, mine=None, mySubscribers=None, id=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, pageToken=None, categoryId=None, maxResults=None)</code>
<pre>Returns a collection of zero or more channel resources that match the request criteria.
Args:
part: string, The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, statistics, topicDetails, and invideoPromotion.
If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties. (required)
+ hl: string, The hl parameter should be used for filter out the properties that are not in the given language. Used for the brandingSettings part.
+ mine: boolean, Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.
+ mySubscribers: boolean, Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel.
+ id: string, The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID.
managedByMe: boolean, Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.
onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter indicates that the authenticated user 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 actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
forUsername: string, The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username.
pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
categoryId: string, The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category.
maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
- mine: boolean, Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.
- mySubscribers: boolean, Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel.
- id: string, The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID.
Returns:
An object of the form:
@@ -261,7 +262,7 @@
"channel": { # Branding properties for the channel view. # Branding properties for the channel view.
"description": "A String", # Specifies the channel description.
"title": "A String", # Specifies the channel title.
- "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
+ "country": "A String", # The country of the channel.
"showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
"featuredChannelsTitle": "A String", # Title for the featured channels tab.
"defaultLanguage": "A String",
@@ -269,6 +270,7 @@
"keywords": "A String", # Lists keywords associated with the channel, comma-separated.
"profileColor": "A String", # A prominent color that can be rendered on this channel page.
"defaultTab": "A String", # Which content tab users should see when viewing the channel.
+ "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
"featuredChannelsUrls": [ # The list of featured channels.
"A String",
],
@@ -319,11 +321,12 @@
},
},
"title": "A String", # The channel's title.
+ "country": "A String", # The country of the channel.
"defaultLanguage": "A String", # The language of the channel's default title and description.
"publishedAt": "A String", # The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"localized": { # Channel localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for channel's description.
- "title": "A String", # The localized strings for channel's title, read-only.
+ "title": "A String", # The localized strings for channel's title.
},
"description": "A String", # The description of the channel.
},
@@ -338,7 +341,7 @@
"localizations": { # Localizations for different languages
"a_key": { # Channel localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for channel's description.
- "title": "A String", # The localized strings for channel's title, read-only.
+ "title": "A String", # The localized strings for channel's title.
},
},
},
@@ -531,7 +534,7 @@
"channel": { # Branding properties for the channel view. # Branding properties for the channel view.
"description": "A String", # Specifies the channel description.
"title": "A String", # Specifies the channel title.
- "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
+ "country": "A String", # The country of the channel.
"showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
"featuredChannelsTitle": "A String", # Title for the featured channels tab.
"defaultLanguage": "A String",
@@ -539,6 +542,7 @@
"keywords": "A String", # Lists keywords associated with the channel, comma-separated.
"profileColor": "A String", # A prominent color that can be rendered on this channel page.
"defaultTab": "A String", # Which content tab users should see when viewing the channel.
+ "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
"featuredChannelsUrls": [ # The list of featured channels.
"A String",
],
@@ -589,11 +593,12 @@
},
},
"title": "A String", # The channel's title.
+ "country": "A String", # The country of the channel.
"defaultLanguage": "A String", # The language of the channel's default title and description.
"publishedAt": "A String", # The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"localized": { # Channel localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for channel's description.
- "title": "A String", # The localized strings for channel's title, read-only.
+ "title": "A String", # The localized strings for channel's title.
},
"description": "A String", # The description of the channel.
},
@@ -608,7 +613,7 @@
"localizations": { # Localizations for different languages
"a_key": { # Channel localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for channel's description.
- "title": "A String", # The localized strings for channel's title, read-only.
+ "title": "A String", # The localized strings for channel's title.
},
},
}
@@ -768,7 +773,7 @@
"channel": { # Branding properties for the channel view. # Branding properties for the channel view.
"description": "A String", # Specifies the channel description.
"title": "A String", # Specifies the channel title.
- "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
+ "country": "A String", # The country of the channel.
"showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
"featuredChannelsTitle": "A String", # Title for the featured channels tab.
"defaultLanguage": "A String",
@@ -776,6 +781,7 @@
"keywords": "A String", # Lists keywords associated with the channel, comma-separated.
"profileColor": "A String", # A prominent color that can be rendered on this channel page.
"defaultTab": "A String", # Which content tab users should see when viewing the channel.
+ "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
"featuredChannelsUrls": [ # The list of featured channels.
"A String",
],
@@ -826,11 +832,12 @@
},
},
"title": "A String", # The channel's title.
+ "country": "A String", # The country of the channel.
"defaultLanguage": "A String", # The language of the channel's default title and description.
"publishedAt": "A String", # The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"localized": { # Channel localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for channel's description.
- "title": "A String", # The localized strings for channel's title, read-only.
+ "title": "A String", # The localized strings for channel's title.
},
"description": "A String", # The description of the channel.
},
@@ -845,7 +852,7 @@
"localizations": { # Localizations for different languages
"a_key": { # Channel localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for channel's description.
- "title": "A String", # The localized strings for channel's title, read-only.
+ "title": "A String", # The localized strings for channel's title.
},
},
}</pre>
diff --git a/docs/dyn/youtube_v3.commentThreads.html b/docs/dyn/youtube_v3.commentThreads.html
new file mode 100644
index 0000000..67016d1
--- /dev/null
+++ b/docs/dyn/youtube_v3.commentThreads.html
@@ -0,0 +1,528 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.commentThreads.html">commentThreads</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#insert">insert(part=None, body, shareOnGooglePlus=None)</a></code></p>
+<p class="firstline">Creates a new comment thread and top level comment.</p>
+<p class="toc_element">
+ <code><a href="#list">list(part, channelId=None, id=None, pageToken=None, allThreadsRelatedToChannelId=None, moderationStatus=None, videoId=None, maxResults=None, searchTerms=None, textFormat=None, order=None)</a></code></p>
+<p class="firstline">Returns a list of comment threads that match the API request 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>
+<p class="toc_element">
+ <code><a href="#update">update(part=None, body)</a></code></p>
+<p class="firstline">Modifies an existing comment.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="insert">insert(part=None, body, shareOnGooglePlus=None)</code>
+ <pre>Creates a new comment thread and top level comment.
+
+Args:
+ part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
+
+The part names that you can include in the parameter value are id and snippet. However only snippet contains properties that can be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
+ "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
+ "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
+ "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
+ "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
+ "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
+ "totalReplyCount": 42, # The total number of replies (not including the top level comment).
+ "topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ },
+ "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
+ "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
+ "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
+ { # A comment represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ ],
+ },
+ }
+
+ shareOnGooglePlus: boolean, The shareOnGooglePlus determines whether this thread should also be posted on Google+.
+
+Returns:
+ An object of the form:
+
+ { # A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
+ "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
+ "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
+ "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
+ "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
+ "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
+ "totalReplyCount": 42, # The total number of replies (not including the top level comment).
+ "topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ },
+ "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
+ "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
+ "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
+ { # A comment represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(part, channelId=None, id=None, pageToken=None, allThreadsRelatedToChannelId=None, moderationStatus=None, videoId=None, maxResults=None, searchTerms=None, textFormat=None, order=None)</code>
+ <pre>Returns a list of comment threads that match the API request parameters.
+
+Args:
+ part: string, The part parameter specifies the commentThread resource parts that the API response will include. Supported values are id, snippet and replies. (required)
+ channelId: string, The channelId parameter instructs the API to return the comment threads for all the channel comments (not including comments left on videos).
+ id: string, The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.
+ 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 of the result that can be retrieved.
+
+Note: This parameter is not supported for use in conjunction with the id parameter.
+ allThreadsRelatedToChannelId: string, The allThreadsRelatedToChannelId parameter instructs the API to return the comment threads of all videos of the channel and the channel comments as well.
+ moderationStatus: string, Set this parameter to limit the returned comment threads to a particular moderation state.
+
+Note: This parameter is not supported for use in conjunction with the id parameter.
+ Allowed values
+ heldForReview - Returns only comment threads awaiting review by a moderator.
+ likelySpam - Returns only comment threads classified as likely being spam.
+ published - Returns only published comment threads.
+ videoId: string, The videoId parameter instructs the API to return the comment threads for the video specified by the video id.
+ maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
+
+Note: This parameter is not supported for use in conjunction with the id parameter.
+ searchTerms: string, The searchTerms parameter instructs the API to limit the returned comments to those which contain the specified search terms.
+
+Note: This parameter is not supported for use in conjunction with the id parameter.
+ textFormat: string, Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text.
+ Allowed values
+ html - Returns the comments in HTML format.
+ plainText - Returns the comments in plain text format.
+ order: string, The order parameter specifies the order in which the API response should list comment threads. Valid values are:
+- time - Comment threads are ordered by time. This is the default behavior.
+- relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.
+ Allowed values
+ relevance - Order by relevance.
+ time - Order by time.
+
+Returns:
+ An object of the form:
+
+ {
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
+ "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
+ "kind": "youtube#commentThreadListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse".
+ "visitorId": "A String", # The visitorId identifies the visitor.
+ "items": [ # A list of comment threads that match the request criteria.
+ { # A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
+ "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
+ "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
+ "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
+ "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
+ "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
+ "totalReplyCount": 42, # The total number of replies (not including the top level comment).
+ "topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ },
+ "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
+ "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
+ "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
+ { # A comment represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ ],
+ },
+ },
+ ],
+ "tokenPagination": { # Stub token pagination template to suppress results.
+ },
+ "etag": "A String", # Etag of this resource.
+ "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
+ "totalResults": 42, # The total number of results in the result set.
+ "resultsPerPage": 42, # The number of results included in the API response.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object 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(part=None, body)</code>
+ <pre>Modifies an existing comment.
+
+Args:
+ part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
+
+The part names that you can include in the parameter value are id, snippet and replies. However only snippet contains properties that can be updated. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
+ "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
+ "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
+ "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
+ "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
+ "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
+ "totalReplyCount": 42, # The total number of replies (not including the top level comment).
+ "topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ },
+ "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
+ "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
+ "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
+ { # A comment represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
+ "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
+ "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
+ "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
+ "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
+ "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
+ "totalReplyCount": 42, # The total number of replies (not including the top level comment).
+ "topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ },
+ "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
+ "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
+ "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
+ { # A comment represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/youtube_v3.comments.html b/docs/dyn/youtube_v3.comments.html
new file mode 100644
index 0000000..5d170c8
--- /dev/null
+++ b/docs/dyn/youtube_v3.comments.html
@@ -0,0 +1,356 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.comments.html">comments</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(id)</a></code></p>
+<p class="firstline">Deletes a comment.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(part=None, body)</a></code></p>
+<p class="firstline">Creates a new comment.</p>
+<p class="toc_element">
+ <code><a href="#list">list(part, pageToken=None, maxResults=None, id=None, parentId=None, textFormat=None)</a></code></p>
+<p class="firstline">Returns a list of comments that match the API request 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>
+<p class="toc_element">
+ <code><a href="#markAsSpam">markAsSpam(id)</a></code></p>
+<p class="firstline">Expresses the caller's opinion that a comment is spam.</p>
+<p class="toc_element">
+ <code><a href="#setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None)</a></code></p>
+<p class="firstline">Sets the moderation status of one or more comments.</p>
+<p class="toc_element">
+ <code><a href="#update">update(part=None, body)</a></code></p>
+<p class="firstline">Modifies an existing comment.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(id)</code>
+ <pre>Deletes a comment.
+
+Args:
+ id: string, The id parameter specifies the comment ID for the resource that should be deleted. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(part=None, body)</code>
+ <pre>Creates a new comment.
+
+Note: to create a top level comment it is also necessary to create a comment thread. Both are accomplished through the commentThreads resource.
+
+Args:
+ part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
+
+The part names that you can include in the parameter value are id and snippet. However only snippet contains properties that can be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A comment represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # A comment represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(part, pageToken=None, maxResults=None, id=None, parentId=None, textFormat=None)</code>
+ <pre>Returns a list of comments that match the API request parameters.
+
+Args:
+ part: string, The part parameter specifies the comment resource parts that the API response will include. Supported values are id and snippet. (required)
+ 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 of the result that can be retrieved.
+
+Note: This parameter is not supported for use in conjunction with the id parameter.
+ maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
+
+Note: This parameter is not supported for use in conjunction with the id parameter.
+ id: string, The id parameter specifies a comma-separated list of comment IDs for the resources that should be retrieved.
+ parentId: string, The parentId parameter specifies the ID of the comment for which replies should be retrieved.
+
+Note: Currently YouTube features only one level of replies (ie replies to top level comments). However replies to replies may be supported in the future.
+ textFormat: string, Set this parameter's value to html or plainText to instruct the API to return the comments left by users formatted as HTML or as plain text.
+ Allowed values
+ html - Returns the comments in HTML format.
+ plainText - Returns the comments in plain text format.
+
+Returns:
+ An object of the form:
+
+ {
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
+ "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
+ "kind": "youtube#commentListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse".
+ "visitorId": "A String", # The visitorId identifies the visitor.
+ "items": [ # A list of comments that match the request criteria.
+ { # A comment represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ },
+ ],
+ "tokenPagination": { # Stub token pagination template to suppress results.
+ },
+ "etag": "A String", # Etag of this resource.
+ "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
+ "totalResults": 42, # The total number of results in the result set.
+ "resultsPerPage": 42, # The number of results included in the API response.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object 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="markAsSpam">markAsSpam(id)</code>
+ <pre>Expresses the caller's opinion that a comment is spam.
+
+Args:
+ id: string, The id parameter specifies a comma-separated list of IDs of comments which should get flagged as spam. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None)</code>
+ <pre>Sets the moderation status of one or more comments.
+
+Args:
+ id: string, The id parameter specifies a comma-separated list of IDs of comments whose moderation status should be updated. (required)
+ moderationStatus: string, Determines the new moderation status of the specified comments. (required)
+ Allowed values
+ heldForReview - Marks a comment as awaiting review by a moderator.
+ published - Clears a comment for public display.
+ rejected - Rejects a comment as not fit for display.
+
+Note: currently there is no way to list or otherwise discover a rejected comment. However it is possible to change its moderation status as long as its ID is still known.
+
+Note: Currently, if you reject a comment you effectively also hide all its replies as there is no longer any way to discover them. This may change in the future.
+ banAuthor: boolean, The banAuthor paramter, if set to true, adds the author of the comment to the ban list. This means all future comments of the author will autmomatically be rejected.
+
+Note: This parameter is only valid in combination with moderationStatus 'rejected'.
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(part=None, body)</code>
+ <pre>Modifies an existing comment.
+
+Args:
+ part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
+
+The part names that you can include in the parameter value are id and snippet. However only snippet contains properties that can be updated. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A comment represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # A comment represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ },
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/youtube_v3.html b/docs/dyn/youtube_v3.html
index b69a986..333375a 100644
--- a/docs/dyn/youtube_v3.html
+++ b/docs/dyn/youtube_v3.html
@@ -80,6 +80,11 @@
<p class="firstline">Returns the activities Resource.</p>
<p class="toc_element">
+ <code><a href="youtube_v3.captions.html">captions()</a></code>
+</p>
+<p class="firstline">Returns the captions Resource.</p>
+
+<p class="toc_element">
<code><a href="youtube_v3.channelBanners.html">channelBanners()</a></code>
</p>
<p class="firstline">Returns the channelBanners Resource.</p>
@@ -95,6 +100,16 @@
<p class="firstline">Returns the channels Resource.</p>
<p class="toc_element">
+ <code><a href="youtube_v3.commentThreads.html">commentThreads()</a></code>
+</p>
+<p class="firstline">Returns the commentThreads Resource.</p>
+
+<p class="toc_element">
+ <code><a href="youtube_v3.comments.html">comments()</a></code>
+</p>
+<p class="firstline">Returns the comments Resource.</p>
+
+<p class="toc_element">
<code><a href="youtube_v3.guideCategories.html">guideCategories()</a></code>
</p>
<p class="firstline">Returns the guideCategories Resource.</p>
@@ -145,6 +160,11 @@
<p class="firstline">Returns the thumbnails Resource.</p>
<p class="toc_element">
+ <code><a href="youtube_v3.videoAbuseReportReasons.html">videoAbuseReportReasons()</a></code>
+</p>
+<p class="firstline">Returns the videoAbuseReportReasons Resource.</p>
+
+<p class="toc_element">
<code><a href="youtube_v3.videoCategories.html">videoCategories()</a></code>
</p>
<p class="firstline">Returns the videoCategories Resource.</p>
@@ -159,4 +179,25 @@
</p>
<p class="firstline">Returns the watermarks 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/youtube_v3.liveBroadcasts.html b/docs/dyn/youtube_v3.liveBroadcasts.html
index 1c25a12..d368b0f 100644
--- a/docs/dyn/youtube_v3.liveBroadcasts.html
+++ b/docs/dyn/youtube_v3.liveBroadcasts.html
@@ -126,12 +126,29 @@
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
},
+ "topicDetails": {
+ "topics": [
+ {
+ "snippet": { # Information about the topic matched.
+ "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
+ "name": "A String", # The name of the topic.
+ },
+ "type": "A String", # The type of the topic.
+ "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
+ },
+ ],
+ },
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
+ "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
+ "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
+ "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
+ },
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
+ "enableLowLatency": True or False,
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
+ "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
#
@@ -162,6 +179,7 @@
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isDefaultBroadcast": True or False,
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
@@ -228,12 +246,29 @@
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
},
+ "topicDetails": {
+ "topics": [
+ {
+ "snippet": { # Information about the topic matched.
+ "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
+ "name": "A String", # The name of the topic.
+ },
+ "type": "A String", # The type of the topic.
+ "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
+ },
+ ],
+ },
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
+ "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
+ "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
+ "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
+ },
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
+ "enableLowLatency": True or False,
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
+ "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
#
@@ -264,6 +299,7 @@
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isDefaultBroadcast": True or False,
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
@@ -332,12 +368,29 @@
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
},
+ "topicDetails": {
+ "topics": [
+ {
+ "snippet": { # Information about the topic matched.
+ "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
+ "name": "A String", # The name of the topic.
+ },
+ "type": "A String", # The type of the topic.
+ "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
+ },
+ ],
+ },
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
+ "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
+ "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
+ "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
+ },
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
+ "enableLowLatency": True or False,
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
+ "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
#
@@ -368,6 +421,7 @@
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isDefaultBroadcast": True or False,
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
@@ -419,12 +473,29 @@
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
},
+ "topicDetails": {
+ "topics": [
+ {
+ "snippet": { # Information about the topic matched.
+ "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
+ "name": "A String", # The name of the topic.
+ },
+ "type": "A String", # The type of the topic.
+ "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
+ },
+ ],
+ },
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
+ "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
+ "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
+ "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
+ },
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
+ "enableLowLatency": True or False,
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
+ "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
#
@@ -455,6 +526,7 @@
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isDefaultBroadcast": True or False,
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
@@ -529,12 +601,29 @@
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
},
+ "topicDetails": {
+ "topics": [
+ {
+ "snippet": { # Information about the topic matched.
+ "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
+ "name": "A String", # The name of the topic.
+ },
+ "type": "A String", # The type of the topic.
+ "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
+ },
+ ],
+ },
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
+ "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
+ "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
+ "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
+ },
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
+ "enableLowLatency": True or False,
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
+ "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
#
@@ -565,6 +654,7 @@
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isDefaultBroadcast": True or False,
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
@@ -653,12 +743,29 @@
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
},
+ "topicDetails": {
+ "topics": [
+ {
+ "snippet": { # Information about the topic matched.
+ "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
+ "name": "A String", # The name of the topic.
+ },
+ "type": "A String", # The type of the topic.
+ "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
+ },
+ ],
+ },
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
+ "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
+ "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
+ "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
+ },
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
+ "enableLowLatency": True or False,
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
+ "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
#
@@ -689,6 +796,7 @@
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isDefaultBroadcast": True or False,
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
@@ -742,12 +850,29 @@
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
},
+ "topicDetails": {
+ "topics": [
+ {
+ "snippet": { # Information about the topic matched.
+ "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
+ "name": "A String", # The name of the topic.
+ },
+ "type": "A String", # The type of the topic.
+ "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
+ },
+ ],
+ },
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
+ "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
+ "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
+ "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
+ },
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
+ "enableLowLatency": True or False,
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
+ "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
#
@@ -778,6 +903,7 @@
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isDefaultBroadcast": True or False,
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
@@ -829,12 +955,29 @@
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
},
+ "topicDetails": {
+ "topics": [
+ {
+ "snippet": { # Information about the topic matched.
+ "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
+ "name": "A String", # The name of the topic.
+ },
+ "type": "A String", # The type of the topic.
+ "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
+ },
+ ],
+ },
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
+ "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
+ "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
+ "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
+ },
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
+ "enableLowLatency": True or False,
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
+ "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
#
@@ -865,6 +1008,7 @@
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+ "isDefaultBroadcast": True or False,
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
diff --git a/docs/dyn/youtube_v3.liveStreams.html b/docs/dyn/youtube_v3.liveStreams.html
index 23b9597..5bdd401 100644
--- a/docs/dyn/youtube_v3.liveStreams.html
+++ b/docs/dyn/youtube_v3.liveStreams.html
@@ -121,6 +121,18 @@
{ # A live stream describes a live ingestion point.
"status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
"streamStatus": "A String",
+ "healthStatus": { # The health status of the stream.
+ "status": "A String", # The status code of this stream
+ "configurationIssues": [ # The configurations issues on this stream
+ {
+ "reason": "A String", # The short-form reason for this issue.
+ "type": "A String", # The kind of error happening.
+ "description": "A String", # The long-form description of the issue and how to resolve it.
+ "severity": "A String", # How severe this issue is to the stream.
+ },
+ ],
+ "lastUpdateTimeS": "A String", # The last time this status was updated (in seconds)
+ },
},
"kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
"contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
@@ -146,6 +158,7 @@
"format": "A String", # The format of the video stream that you are sending to Youtube.
},
"snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "isDefaultStream": True or False,
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
"description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
"publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
@@ -170,6 +183,18 @@
{ # A live stream describes a live ingestion point.
"status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
"streamStatus": "A String",
+ "healthStatus": { # The health status of the stream.
+ "status": "A String", # The status code of this stream
+ "configurationIssues": [ # The configurations issues on this stream
+ {
+ "reason": "A String", # The short-form reason for this issue.
+ "type": "A String", # The kind of error happening.
+ "description": "A String", # The long-form description of the issue and how to resolve it.
+ "severity": "A String", # How severe this issue is to the stream.
+ },
+ ],
+ "lastUpdateTimeS": "A String", # The last time this status was updated (in seconds)
+ },
},
"kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
"contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
@@ -195,6 +220,7 @@
"format": "A String", # The format of the video stream that you are sending to Youtube.
},
"snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "isDefaultStream": True or False,
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
"description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
"publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
@@ -236,6 +262,18 @@
{ # A live stream describes a live ingestion point.
"status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
"streamStatus": "A String",
+ "healthStatus": { # The health status of the stream.
+ "status": "A String", # The status code of this stream
+ "configurationIssues": [ # The configurations issues on this stream
+ {
+ "reason": "A String", # The short-form reason for this issue.
+ "type": "A String", # The kind of error happening.
+ "description": "A String", # The long-form description of the issue and how to resolve it.
+ "severity": "A String", # How severe this issue is to the stream.
+ },
+ ],
+ "lastUpdateTimeS": "A String", # The last time this status was updated (in seconds)
+ },
},
"kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
"contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
@@ -261,6 +299,7 @@
"format": "A String", # The format of the video stream that you are sending to Youtube.
},
"snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "isDefaultStream": True or False,
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
"description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
"publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
@@ -311,6 +350,18 @@
{ # A live stream describes a live ingestion point.
"status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
"streamStatus": "A String",
+ "healthStatus": { # The health status of the stream.
+ "status": "A String", # The status code of this stream
+ "configurationIssues": [ # The configurations issues on this stream
+ {
+ "reason": "A String", # The short-form reason for this issue.
+ "type": "A String", # The kind of error happening.
+ "description": "A String", # The long-form description of the issue and how to resolve it.
+ "severity": "A String", # How severe this issue is to the stream.
+ },
+ ],
+ "lastUpdateTimeS": "A String", # The last time this status was updated (in seconds)
+ },
},
"kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
"contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
@@ -336,6 +387,7 @@
"format": "A String", # The format of the video stream that you are sending to Youtube.
},
"snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "isDefaultStream": True or False,
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
"description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
"publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
@@ -360,6 +412,18 @@
{ # A live stream describes a live ingestion point.
"status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
"streamStatus": "A String",
+ "healthStatus": { # The health status of the stream.
+ "status": "A String", # The status code of this stream
+ "configurationIssues": [ # The configurations issues on this stream
+ {
+ "reason": "A String", # The short-form reason for this issue.
+ "type": "A String", # The kind of error happening.
+ "description": "A String", # The long-form description of the issue and how to resolve it.
+ "severity": "A String", # How severe this issue is to the stream.
+ },
+ ],
+ "lastUpdateTimeS": "A String", # The last time this status was updated (in seconds)
+ },
},
"kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
"contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
@@ -385,6 +449,7 @@
"format": "A String", # The format of the video stream that you are sending to Youtube.
},
"snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "isDefaultStream": True or False,
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
"description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
"publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
diff --git a/docs/dyn/youtube_v3.playlists.html b/docs/dyn/youtube_v3.playlists.html
index 207be39..a1ae3db 100644
--- a/docs/dyn/youtube_v3.playlists.html
+++ b/docs/dyn/youtube_v3.playlists.html
@@ -81,7 +81,7 @@
<code><a href="#insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
<p class="firstline">Creates a playlist.</p>
<p class="toc_element">
- <code><a href="#list">list(part=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, channelId=None, mine=None, maxResults=None, id=None)</a></code></p>
+ <code><a href="#list">list(part=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, hl=None, channelId=None, mine=None, maxResults=None, id=None)</a></code></p>
<p class="firstline">Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -271,7 +271,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(part=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, channelId=None, mine=None, maxResults=None, id=None)</code>
+ <code class="details" id="list">list(part=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, hl=None, channelId=None, mine=None, maxResults=None, id=None)</code>
<pre>Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.
Args:
@@ -287,6 +287,7 @@
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
+ hl: string, The hl parameter should be used for filter out the properties that are not in the given language. Used for the snippet part.
channelId: string, This value indicates that the API should only return the specified channel's playlists.
mine: boolean, Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user.
maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
diff --git a/docs/dyn/youtube_v3.search.html b/docs/dyn/youtube_v3.search.html
index f00d72b..d535d91 100644
--- a/docs/dyn/youtube_v3.search.html
+++ b/docs/dyn/youtube_v3.search.html
@@ -75,14 +75,14 @@
<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.search.html">search</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(part=None, eventType=None, channelId=None, videoSyndicated=None, channelType=None, videoCaption=None, publishedAfter=None, onBehalfOfContentOwner=None, forContentOwner=None, regionCode=None, location=None, locationRadius=None, type=None, topicId=None, publishedBefore=None, videoDimension=None, videoLicense=None, maxResults=None, videoType=None, videoDefinition=None, pageToken=None, relatedToVideoId=None, relevanceLanguage=None, videoDuration=None, forMine=None, q=None, safeSearch=None, videoEmbeddable=None, videoCategoryId=None, order=None)</a></code></p>
+ <code><a href="#list">list(part=None, eventType=None, channelId=None, forDeveloper=None, videoSyndicated=None, channelType=None, videoCaption=None, publishedAfter=None, onBehalfOfContentOwner=None, forContentOwner=None, regionCode=None, location=None, locationRadius=None, type=None, topicId=None, publishedBefore=None, videoDimension=None, videoLicense=None, maxResults=None, videoType=None, videoDefinition=None, pageToken=None, relatedToVideoId=None, relevanceLanguage=None, videoDuration=None, forMine=None, q=None, safeSearch=None, videoEmbeddable=None, videoCategoryId=None, order=None)</a></code></p>
<p class="firstline">Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource.</p>
<p class="toc_element">
<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(part=None, eventType=None, channelId=None, videoSyndicated=None, channelType=None, videoCaption=None, publishedAfter=None, onBehalfOfContentOwner=None, forContentOwner=None, regionCode=None, location=None, locationRadius=None, type=None, topicId=None, publishedBefore=None, videoDimension=None, videoLicense=None, maxResults=None, videoType=None, videoDefinition=None, pageToken=None, relatedToVideoId=None, relevanceLanguage=None, videoDuration=None, forMine=None, q=None, safeSearch=None, videoEmbeddable=None, videoCategoryId=None, order=None)</code>
+ <code class="details" id="list">list(part=None, eventType=None, channelId=None, forDeveloper=None, videoSyndicated=None, channelType=None, videoCaption=None, publishedAfter=None, onBehalfOfContentOwner=None, forContentOwner=None, regionCode=None, location=None, locationRadius=None, type=None, topicId=None, publishedBefore=None, videoDimension=None, videoLicense=None, maxResults=None, videoType=None, videoDefinition=None, pageToken=None, relatedToVideoId=None, relevanceLanguage=None, videoDuration=None, forMine=None, q=None, safeSearch=None, videoEmbeddable=None, videoCategoryId=None, order=None)</code>
<pre>Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource.
Args:
@@ -95,6 +95,7 @@
live - Only include active broadcasts.
upcoming - Only include upcoming broadcasts.
channelId: string, The channelId parameter indicates that the API response should only contain resources created by the channel
+ forDeveloper: boolean, The forDeveloper parameter restricts the search to only retrieve videos uploaded via the developer's application or website. The API server uses the request's authorization credentials to identify the developer. Therefore, a developer can restrict results to videos uploaded through the developer's own app or website but not to videos uploaded through other apps or sites.
videoSyndicated: string, The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com.
Allowed values
any - Return all videos, syndicated or not.
diff --git a/docs/dyn/youtube_v3.videoAbuseReportReasons.html b/docs/dyn/youtube_v3.videoAbuseReportReasons.html
new file mode 100644
index 0000000..b232a33
--- /dev/null
+++ b/docs/dyn/youtube_v3.videoAbuseReportReasons.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="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.videoAbuseReportReasons.html">videoAbuseReportReasons</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(part, hl=None)</a></code></p>
+<p class="firstline">Returns a list of abuse reasons that can be used for reporting abusive videos.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(part, hl=None)</code>
+ <pre>Returns a list of abuse reasons that can be used for reporting abusive videos.
+
+Args:
+ part: string, The part parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet. (required)
+ hl: string, The hl parameter specifies the language that should be used for text values in the API response.
+
+Returns:
+ An object of the form:
+
+ {
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
+ "items": [ # A list of valid abuse reasons that are used with video.ReportAbuse.
+ { # A videoAbuseReportReason resource identifies a reason that a video could be reported as abusive. Video abuse report reasons are used with video.ReportAbuse.
+ "snippet": { # Basic details about a video category, such as its localized title. # The snippet object contains basic details about the abuse report reason.
+ "secondaryReasons": [ # The secondary reasons associated with this reason, if any are available. (There might be 0 or more.)
+ {
+ "id": "A String", # The ID of this abuse report secondary reason.
+ "label": "A String", # The localized label for this abuse report secondary reason.
+ },
+ ],
+ "label": "A String", # The localized label belonging to this abuse report reason.
+ },
+ "kind": "youtube#videoAbuseReportReason", # Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReason".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID of this abuse report reason.
+ },
+ ],
+ "kind": "youtube#videoAbuseReportReasonListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReasonListResponse".
+ "etag": "A String", # Etag of this resource.
+ "visitorId": "A String", # The visitorId identifies the visitor.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/youtube_v3.videos.html b/docs/dyn/youtube_v3.videos.html
index d3b5de3..d073e42 100644
--- a/docs/dyn/youtube_v3.videos.html
+++ b/docs/dyn/youtube_v3.videos.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(part=None, body=None, media_body=None, onBehalfOfContentOwner=None, stabilize=None, onBehalfOfContentOwnerChannel=None, notifySubscribers=None, autoLevels=None)</a></code></p>
<p class="firstline">Uploads a video to YouTube and optionally sets the video's metadata.</p>
<p class="toc_element">
- <code><a href="#list">list(part=None, hl=None, locale=None, id=None, onBehalfOfContentOwner=None, regionCode=None, pageToken=None, maxResults=None, chart=None, myRating=None, videoCategoryId=None)</a></code></p>
+ <code><a href="#list">list(part=None, hl=None, locale=None, id=None, onBehalfOfContentOwner=None, regionCode=None, pageToken=None, maxResults=None, chart=None, myRating=None, debugProjectIdOverride=None, videoCategoryId=None)</a></code></p>
<p class="firstline">Returns a list of videos that match the API request parameters.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -93,6 +93,9 @@
<code><a href="#rate">rate(id, rating, onBehalfOfContentOwner=None)</a></code></p>
<p class="firstline">Add a like or dislike rating to a video or remove a rating from a video.</p>
<p class="toc_element">
+ <code><a href="#reportAbuse">reportAbuse(body, onBehalfOfContentOwner=None)</a></code></p>
+<p class="firstline">Report abuse for a video.</p>
+<p class="toc_element">
<code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None)</a></code></p>
<p class="firstline">Updates a video's metadata.</p>
<h3>Method Details</h3>
@@ -160,6 +163,7 @@
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
"A String",
],
+ "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
"defaultLanguage": "A String", # The language of the videos's default snippet.
"liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
@@ -469,6 +473,7 @@
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
"A String",
],
+ "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
"defaultLanguage": "A String", # The language of the videos's default snippet.
"liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
@@ -750,7 +755,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(part=None, hl=None, locale=None, id=None, onBehalfOfContentOwner=None, regionCode=None, pageToken=None, maxResults=None, chart=None, myRating=None, videoCategoryId=None)</code>
+ <code class="details" id="list">list(part=None, hl=None, locale=None, id=None, onBehalfOfContentOwner=None, regionCode=None, pageToken=None, maxResults=None, chart=None, myRating=None, debugProjectIdOverride=None, videoCategoryId=None)</code>
<pre>Returns a list of videos that match the API request parameters.
Args:
@@ -777,6 +782,7 @@
Allowed values
dislike - Returns only videos disliked by the authenticated user.
like - Returns only video liked by the authenticated user.
+ debugProjectIdOverride: string, The debugProjectIdOverride parameter should be used for mimicking a request for a certain project ID
videoCategoryId: string, The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category.
Returns:
@@ -802,6 +808,7 @@
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
"A String",
],
+ "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
"defaultLanguage": "A String", # The language of the videos's default snippet.
"liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
@@ -1124,6 +1131,28 @@
</div>
<div class="method">
+ <code class="details" id="reportAbuse">reportAbuse(body, onBehalfOfContentOwner=None)</code>
+ <pre>Report abuse for a video.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "secondaryReasonId": "A String", # The specific, or secondary, reason that this content is abusive (if available). The value is an abuse report reason ID that is a valid secondary reason for the primary reason.
+ "reasonId": "A String", # The high-level, or primary, reason that the content is abusive. The value is an abuse report reason ID.
+ "language": "A String", # The language that the content was viewed in.
+ "comments": "A String", # Additional comments regarding the abuse report.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video.
+ }
+
+ 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="update">update(part=None, body, onBehalfOfContentOwner=None)</code>
<pre>Updates a video's metadata.
@@ -1152,6 +1181,7 @@
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
"A String",
],
+ "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
"defaultLanguage": "A String", # The language of the videos's default snippet.
"liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
@@ -1452,6 +1482,7 @@
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
"A String",
],
+ "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
"defaultLanguage": "A String", # The language of the videos's default snippet.
"liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
diff --git a/docs/epy/class-tree.html b/docs/epy/class-tree.html
index 2f2bebf..8445ae0 100644
--- a/docs/epy/class-tree.html
+++ b/docs/epy/class-tree.html
@@ -154,7 +154,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 8ef55e4..1d53a20 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.4.0
+ 1.4.1
</p>
</div><!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 0fcf4cd..04344bb 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.4.0"</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.4.1"</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
@@ -103,7 +103,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 9557192..0a37059 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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 50d27e3..ebbaf66 100644
--- a/docs/epy/googleapiclient.channel-pysrc.html
+++ b/docs/epy/googleapiclient.channel-pysrc.html
@@ -375,7 +375,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 b2bd562..6ef3289 100644
--- a/docs/epy/googleapiclient.channel.Channel-class.html
+++ b/docs/epy/googleapiclient.channel.Channel-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 cf0cda7..d01e9e6 100644
--- a/docs/epy/googleapiclient.channel.Notification-class.html
+++ b/docs/epy/googleapiclient.channel.Notification-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 5c89274..b9b6503 100644
--- a/docs/epy/googleapiclient.discovery-module.html
+++ b/docs/epy/googleapiclient.discovery-module.html
@@ -1099,7 +1099,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 6e8a3db..5c112e8 100644
--- a/docs/epy/googleapiclient.discovery-pysrc.html
+++ b/docs/epy/googleapiclient.discovery-pysrc.html
@@ -114,1022 +114,1044 @@
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-11" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-11', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-12" class="py-name"><a title="googleapiclient.errors" class="py-name" href="#" onclick="return doclink('link-12', 'errors', 'link-3');">errors</a></tt> <tt class="py-keyword">import</tt> <tt id="link-13" class="py-name" targets="Class googleapiclient.errors.UnacceptableMimeTypeError=googleapiclient.errors.UnacceptableMimeTypeError-class.html"><a title="googleapiclient.errors.UnacceptableMimeTypeError" class="py-name" href="#" onclick="return doclink('link-13', 'UnacceptableMimeTypeError', 'link-13');">UnacceptableMimeTypeError</a></tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</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="L58"></a><tt class="py-lineno"> 58</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="L59"></a><tt class="py-lineno"> 59</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.HttpRequest=googleapiclient.http.HttpRequest-class.html"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-22', 'HttpRequest', 'link-22');">HttpRequest</a></tt> </tt>
-<a name="L60"></a><tt class="py-lineno"> 60</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.MediaFileUpload=googleapiclient.http.MediaFileUpload-class.html"><a title="googleapiclient.http.MediaFileUpload" class="py-name" href="#" onclick="return doclink('link-25', 'MediaFileUpload', 'link-25');">MediaFileUpload</a></tt> </tt>
-<a name="L61"></a><tt class="py-lineno"> 61</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.MediaUpload=googleapiclient.http.MediaUpload-class.html"><a title="googleapiclient.http.MediaUpload" class="py-name" href="#" onclick="return doclink('link-28', 'MediaUpload', 'link-28');">MediaUpload</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-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" targets="Module googleapiclient.model=googleapiclient.model-module.html"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-30', 'model', 'link-30');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-31" 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-31', 'JsonModel', 'link-31');">JsonModel</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-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.model" class="py-name" href="#" onclick="return doclink('link-33', 'model', 'link-30');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-34" 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-34', 'MediaModel', 'link-34');">MediaModel</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-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-30');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-37" 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-37', 'RawModel', 'link-37');">RawModel</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-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.schema=googleapiclient.schema-module.html"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-39', 'schema', 'link-39');">schema</a></tt> <tt class="py-keyword">import</tt> <tt id="link-40" 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-40', 'Schemas', 'link-40');">Schemas</a></tt> </tt>
-<a name="L66"></a><tt class="py-lineno"> 66</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="L67"></a><tt class="py-lineno"> 67</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="L68"></a><tt class="py-lineno"> 68</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="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> </tt>
+<a name="L59"></a><tt class="py-lineno"> 59</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="L60"></a><tt class="py-lineno"> 60</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="L61"></a><tt class="py-lineno"> 61</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="L62"></a><tt class="py-lineno"> 62</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="L63"></a><tt class="py-lineno"> 63</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="L64"></a><tt class="py-lineno"> 64</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="L65"></a><tt class="py-lineno"> 65</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="L66"></a><tt class="py-lineno"> 66</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="L67"></a><tt class="py-lineno"> 67</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="L68"></a><tt class="py-lineno"> 68</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="L69"></a><tt class="py-lineno"> 69</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="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 class="py-comment"># The client library requires a version of httplib2 that supports RETRIES.</tt> </tt>
-<a name="L72"></a><tt class="py-lineno"> 72</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="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> </tt>
-<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt id="link-41" 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-41', 'logger', 'link-41');">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="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 id="link-42" 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-42', 'URITEMPLATE', 'link-42');">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="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt id="link-43" 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-43', 'VARNAME', 'link-43');">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="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt id="link-44" 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-44', 'DISCOVERY_URI', 'link-44');">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="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-string">'{api}/{apiVersion}/rest'</tt><tt class="py-op">)</tt> </tt>
-<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt id="link-45" 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-45', 'DEFAULT_METHOD_DOC', 'link-45');">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="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt id="link-46" 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-46', 'HTTP_PAYLOAD_METHODS', 'link-46');">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="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt id="link-47" 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-47', '_MEDIA_SIZE_BIT_SHIFTS', 'link-47');">_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="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt id="link-48" 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-48', 'BODY_PARAMETER_DEFAULT_VALUE', 'link-48');">BODY_PARAMETER_DEFAULT_VALUE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
-<a name="L84"></a><tt class="py-lineno"> 84</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="L85"></a><tt class="py-lineno"> 85</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="L86"></a><tt class="py-lineno"> 86</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="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
-<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt id="link-49" 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-49', 'MEDIA_BODY_PARAMETER_DEFAULT_VALUE', 'link-49');">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
-<a name="L89"></a><tt class="py-lineno"> 89</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="L90"></a><tt class="py-lineno"> 90</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="L91"></a><tt class="py-lineno"> 91</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="L92"></a><tt class="py-lineno"> 92</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="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
-<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> </tt>
-<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-comment"># Parameters accepted by the stack, but not visible via discovery.</tt> </tt>
-<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-comment"># TODO(dhermes): Remove 'userip' in 'v2'.</tt> </tt>
-<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt id="link-50" 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-50', 'STACK_QUERY_PARAMETERS', 'link-50');">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="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt id="link-51" 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-51', 'STACK_QUERY_PARAMETER_DEFAULT_VALUE', 'link-51');">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="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> </tt>
-<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"><tt class="py-comment"># Library-specific reserved words beyond Python keywords.</tt> </tt>
-<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"><tt id="link-52" 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-52', 'RESERVED_WORDS', 'link-52');">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="fix_method_name"></a><div id="fix_method_name-def"><a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"> </tt>
-<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"> </tt>
-<a name="L104"></a><tt class="py-lineno"> 104</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="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"> <tt class="py-docstring">"""Fix method names to avoid reserved word conflicts.</tt> </tt>
-<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"><tt class="py-docstring"> name: string, method name.</tt> </tt>
-<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L111"></a><tt class="py-lineno"> 111</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="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L113"></a><tt class="py-lineno"> 113</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-53" class="py-name"><a title="googleapiclient.discovery.RESERVED_WORDS" class="py-name" href="#" onclick="return doclink('link-53', 'RESERVED_WORDS', 'link-52');">RESERVED_WORDS</a></tt><tt class="py-op">:</tt> </tt>
-<a name="L114"></a><tt class="py-lineno"> 114</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="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"> <tt class="py-keyword">else</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">return</tt> <tt class="py-name">name</tt> </tt>
-</div><a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"> </tt>
-<a name="key2param"></a><div id="key2param-def"><a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"> </tt>
-<a name="L119"></a><tt class="py-lineno"> 119</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="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"> <tt class="py-docstring">"""Converts key names into parameter names.</tt> </tt>
-<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"><tt class="py-docstring"> For example, converting "max-results" -> "max_results"</tt> </tt>
-<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"><tt class="py-docstring"> key: string, the method key name.</tt> </tt>
-<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"><tt class="py-docstring"> A safe method name based on the key name.</tt> </tt>
-<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L130"></a><tt class="py-lineno"> 130</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="L131"></a><tt class="py-lineno"> 131</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="L132"></a><tt class="py-lineno"> 132</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="L133"></a><tt class="py-lineno"> 133</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="L134"></a><tt class="py-lineno"> 134</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="L135"></a><tt class="py-lineno"> 135</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="L136"></a><tt class="py-lineno"> 136</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="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"> <tt class="py-keyword">else</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">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="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 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="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"> </tt>
-<a name="build"></a><div id="build-def"><a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"> </tt>
-<a name="L143"></a><tt class="py-lineno"> 143</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="L144"></a><tt class="py-lineno"> 144</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="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"> <tt class="py-param">version</tt><tt class="py-op">,</tt> </tt>
-<a name="L146"></a><tt class="py-lineno"> 146</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="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"> <tt class="py-param">discoveryServiceUrl</tt><tt class="py-op">=</tt><tt id="link-54" class="py-name"><a title="googleapiclient.discovery.DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-54', 'DISCOVERY_URI', 'link-44');">DISCOVERY_URI</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L148"></a><tt class="py-lineno"> 148</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="L149"></a><tt class="py-lineno"> 149</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="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"> <tt class="py-param">requestBuilder</tt><tt class="py-op">=</tt><tt id="link-55" class="py-name"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-55', 'HttpRequest', 'link-22');">HttpRequest</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L151"></a><tt class="py-lineno"> 151</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-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="build-expanded"><a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"> <tt class="py-docstring">"""Construct a Resource for interacting with an API.</tt> </tt>
-<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L154"></a><tt class="py-lineno"> 154</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="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"><tt class="py-docstring"> version are the names from the Discovery service.</tt> </tt>
-<a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"><tt class="py-docstring"> serviceName: string, name of the service.</tt> </tt>
-<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"><tt class="py-docstring"> version: string, the version of the service.</tt> </tt>
-<a name="L160"></a><tt class="py-lineno"> 160</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="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"><tt class="py-docstring"> like it that HTTP requests will be made through.</tt> </tt>
-<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"><tt class="py-docstring"> discoveryServiceUrl: string, a URI Template that points to the location of</tt> </tt>
-<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"><tt class="py-docstring"> the discovery service. It should have two parameters {api} and</tt> </tt>
-<a name="L164"></a><tt class="py-lineno"> 164</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="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"><tt class="py-docstring"> document for that service.</tt> </tt>
-<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, key obtained from</tt> </tt>
-<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-docstring"> https://code.google.com/apis/console.</tt> </tt>
-<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-docstring"> model: googleapiclient.Model, converts to and from the wire format.</tt> </tt>
-<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP</tt> </tt>
-<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"><tt class="py-docstring"> request.</tt> </tt>
-<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"><tt class="py-docstring"> credentials: oauth2client.Credentials, credentials to be used for</tt> </tt>
-<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"><tt class="py-docstring"> authentication.</tt> </tt>
-<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"><tt class="py-docstring"> A Resource object with methods for interacting with the service.</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-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
-<a name="L178"></a><tt class="py-lineno"> 178</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="L179"></a><tt class="py-lineno"> 179</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="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
-<a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"> </tt>
-<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-56" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-56', '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="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"> <tt id="link-57" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-57', '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="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"> </tt>
-<a name="L185"></a><tt class="py-lineno"> 185</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">discoveryServiceUrl</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
-<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"> </tt>
-<a name="L187"></a><tt class="py-lineno"> 187</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="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"> <tt class="py-comment"># variable that contains the network address of the client sending the</tt> </tt>
-<a name="L189"></a><tt class="py-lineno"> 189</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="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"> <tt class="py-comment"># document to avoid exceeding the quota on discovery requests.</tt> </tt>
-<a name="L191"></a><tt class="py-lineno"> 191</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="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"> <tt class="py-name">requested_url</tt> <tt class="py-op">=</tt> <tt class="py-name">_add_query_parameter</tt><tt class="py-op">(</tt><tt class="py-name">requested_url</tt><tt class="py-op">,</tt> <tt class="py-string">'userIp'</tt><tt class="py-op">,</tt> </tt>
-<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"> <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="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"> <tt id="link-58" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-58', 'logger', 'link-41');">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">requested_url</tt><tt class="py-op">)</tt> </tt>
-<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"> </tt>
-<a name="L196"></a><tt class="py-lineno"> 196</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-59" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-59', 'http', 'link-21');">http</a></tt><tt class="py-op">.</tt><tt id="link-60" 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
+<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> </tt>
+<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-comment"># The client library requires a version of httplib2 that supports RETRIES.</tt> </tt>
+<a name="L73"></a><tt class="py-lineno"> 73</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="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 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="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> </tt>
+<a name="L77"></a><tt class="py-lineno"> 77</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="L78"></a><tt class="py-lineno"> 78</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="L79"></a><tt class="py-lineno"> 79</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="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-string">'{api}/{apiVersion}/rest'</tt><tt class="py-op">)</tt> </tt>
+<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt id="link-48" 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-48', 'DEFAULT_METHOD_DOC', 'link-48');">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="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt id="link-49" 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-49', 'HTTP_PAYLOAD_METHODS', 'link-49');">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="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt id="link-50" 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-50', '_MEDIA_SIZE_BIT_SHIFTS', 'link-50');">_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="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt id="link-51" 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-51', 'BODY_PARAMETER_DEFAULT_VALUE', 'link-51');">BODY_PARAMETER_DEFAULT_VALUE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
+<a name="L85"></a><tt class="py-lineno"> 85</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="L86"></a><tt class="py-lineno"> 86</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="L87"></a><tt class="py-lineno"> 87</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="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
+<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt id="link-52" 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-52', 'MEDIA_BODY_PARAMETER_DEFAULT_VALUE', 'link-52');">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
+<a name="L90"></a><tt class="py-lineno"> 90</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="L91"></a><tt class="py-lineno"> 91</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="L92"></a><tt class="py-lineno"> 92</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="L93"></a><tt class="py-lineno"> 93</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="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
+<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> </tt>
+<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-comment"># Parameters accepted by the stack, but not visible via discovery.</tt> </tt>
+<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-comment"># TODO(dhermes): Remove 'userip' in 'v2'.</tt> </tt>
+<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt id="link-53" 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-53', 'STACK_QUERY_PARAMETERS', 'link-53');">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="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt id="link-54" 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-54', 'STACK_QUERY_PARAMETER_DEFAULT_VALUE', 'link-54');">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="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"> </tt>
+<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"><tt class="py-comment"># Library-specific reserved words beyond Python keywords.</tt> </tt>
+<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"><tt id="link-55" 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-55', 'RESERVED_WORDS', 'link-55');">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="fix_method_name"></a><div id="fix_method_name-def"><a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"> </tt>
+<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"> </tt>
+<a name="L105"></a><tt class="py-lineno"> 105</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="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"> <tt class="py-docstring">"""Fix method names to avoid reserved word conflicts.</tt> </tt>
+<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"><tt class="py-docstring"> name: string, method name.</tt> </tt>
+<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L112"></a><tt class="py-lineno"> 112</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="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L114"></a><tt class="py-lineno"> 114</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-56" class="py-name"><a title="googleapiclient.discovery.RESERVED_WORDS" class="py-name" href="#" onclick="return doclink('link-56', 'RESERVED_WORDS', 'link-55');">RESERVED_WORDS</a></tt><tt class="py-op">:</tt> </tt>
+<a name="L115"></a><tt class="py-lineno"> 115</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="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">name</tt> </tt>
+</div><a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"> </tt>
+<a name="key2param"></a><div id="key2param-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> <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="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"> <tt class="py-docstring">"""Converts key names into parameter names.</tt> </tt>
+<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"><tt class="py-docstring"> For example, converting "max-results" -> "max_results"</tt> </tt>
+<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"><tt class="py-docstring"> key: string, the method key name.</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"> Returns:</tt> </tt>
+<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-docstring"> A safe method name based on the key 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-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</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">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="L133"></a><tt class="py-lineno"> 133</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="L134"></a><tt class="py-lineno"> 134</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="L135"></a><tt class="py-lineno"> 135</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="L136"></a><tt class="py-lineno"> 136</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="L137"></a><tt class="py-lineno"> 137</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="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L139"></a><tt class="py-lineno"> 139</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="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 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="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"> </tt>
+<a name="build"></a><div id="build-def"><a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"> </tt>
+<a name="L144"></a><tt class="py-lineno"> 144</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="L145"></a><tt class="py-lineno"> 145</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="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"> <tt class="py-param">version</tt><tt class="py-op">,</tt> </tt>
+<a name="L147"></a><tt class="py-lineno"> 147</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="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"> <tt class="py-param">discoveryServiceUrl</tt><tt class="py-op">=</tt><tt id="link-57" class="py-name"><a title="googleapiclient.discovery.DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-57', 'DISCOVERY_URI', 'link-47');">DISCOVERY_URI</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L149"></a><tt class="py-lineno"> 149</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="L150"></a><tt class="py-lineno"> 150</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="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"> <tt class="py-param">requestBuilder</tt><tt class="py-op">=</tt><tt id="link-58" class="py-name"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-58', 'HttpRequest', 'link-25');">HttpRequest</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L152"></a><tt class="py-lineno"> 152</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-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="build-expanded"><a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"> <tt class="py-docstring">"""Construct a Resource for interacting with an API.</tt> </tt>
+<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L155"></a><tt class="py-lineno"> 155</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="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"><tt class="py-docstring"> version are the names from the Discovery service.</tt> </tt>
+<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"><tt class="py-docstring"> serviceName: string, name of the service.</tt> </tt>
+<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"><tt class="py-docstring"> version: string, the version of the service.</tt> </tt>
+<a name="L161"></a><tt class="py-lineno"> 161</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="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"><tt class="py-docstring"> like it that HTTP requests will be made through.</tt> </tt>
+<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"><tt class="py-docstring"> discoveryServiceUrl: string, a URI Template that points to the location of</tt> </tt>
+<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"><tt class="py-docstring"> the discovery service. It should have two parameters {api} and</tt> </tt>
+<a name="L165"></a><tt class="py-lineno"> 165</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="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"><tt class="py-docstring"> document for that service.</tt> </tt>
+<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, key obtained from</tt> </tt>
+<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-docstring"> https://code.google.com/apis/console.</tt> </tt>
+<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"><tt class="py-docstring"> model: googleapiclient.Model, converts to and from the wire format.</tt> </tt>
+<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP</tt> </tt>
+<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"><tt class="py-docstring"> request.</tt> </tt>
+<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"><tt class="py-docstring"> credentials: oauth2client.Credentials, credentials to be used for</tt> </tt>
+<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"><tt class="py-docstring"> authentication.</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"> Returns:</tt> </tt>
+<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"><tt class="py-docstring"> A Resource object with methods for interacting with the 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-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
+<a name="L179"></a><tt class="py-lineno"> 179</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="L180"></a><tt class="py-lineno"> 180</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="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
+<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"> </tt>
+<a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-59" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-59', '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="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"> <tt id="link-60" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-60', '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="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"> </tt>
+<a name="L186"></a><tt class="py-lineno"> 186</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">discoveryServiceUrl</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
+<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"> </tt>
+<a name="L188"></a><tt class="py-lineno"> 188</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="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"> <tt class="py-comment"># variable that contains the network address of the client sending the</tt> </tt>
+<a name="L190"></a><tt class="py-lineno"> 190</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="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"> <tt class="py-comment"># document to avoid exceeding the quota on discovery requests.</tt> </tt>
+<a name="L192"></a><tt class="py-lineno"> 192</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="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"> <tt class="py-name">requested_url</tt> <tt class="py-op">=</tt> <tt class="py-name">_add_query_parameter</tt><tt class="py-op">(</tt><tt class="py-name">requested_url</tt><tt class="py-op">,</tt> <tt class="py-string">'userIp'</tt><tt class="py-op">,</tt> </tt>
+<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"> <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="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"> <tt id="link-61" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-61', '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">requested_url</tt><tt class="py-op">)</tt> </tt>
+<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"> </tt>
+<a name="L197"></a><tt class="py-lineno"> 197</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-62" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-62', 'http', 'link-21');">http</a></tt><tt class="py-op">.</tt><tt id="link-63" 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-60', 'request', 'link-60');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">requested_url</tt><tt class="py-op">)</tt> </tt>
-<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"> </tt>
-<a name="L198"></a><tt class="py-lineno"> 198</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">404</tt><tt class="py-op">:</tt> </tt>
-<a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-61" class="py-name"><a title="googleapiclient.errors.UnknownApiNameOrVersion" class="py-name" href="#" onclick="return doclink('link-61', 'UnknownApiNameOrVersion', 'link-16');">UnknownApiNameOrVersion</a></tt><tt class="py-op">(</tt><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>
-<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"> <tt class="py-name">version</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L201"></a><tt class="py-lineno"> 201</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="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-62" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-62', '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">requested_url</tt><tt class="py-op">)</tt> </tt>
-<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"> </tt>
-<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L205"></a><tt class="py-lineno"> 205</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="L206"></a><tt class="py-lineno"> 206</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="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> <tt class="py-keyword">pass</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">try</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">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="L211"></a><tt class="py-lineno"> 211</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="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"> <tt id="link-63" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-63', 'logger', 'link-41');">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="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-64" class="py-name"><a title="googleapiclient.errors.InvalidJsonError" class="py-name" href="#" onclick="return doclink('link-64', 'InvalidJsonError', 'link-7');">InvalidJsonError</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"> </tt>
-<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-65" 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-65', 'build_from_document', 'link-65');">build_from_document</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">base</tt><tt class="py-op">=</tt><tt class="py-name">discoveryServiceUrl</tt><tt class="py-op">,</tt> <tt id="link-66" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-66', 'http', 'link-21');">http</a></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>
-<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-68" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-68', 'model', 'link-30');">model</a></tt><tt class="py-op">=</tt><tt id="link-69" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-69', 'model', 'link-30');">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>
-</div><a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"> </tt>
-<a name="build_from_document"></a><div id="build_from_document-def"><a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"> </tt>
-<a name="L220"></a><tt class="py-lineno"> 220</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="L221"></a><tt class="py-lineno"> 221</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="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"> <tt class="py-param">service</tt><tt class="py-op">,</tt> </tt>
-<a name="L223"></a><tt class="py-lineno"> 223</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="L224"></a><tt class="py-lineno"> 224</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="L225"></a><tt class="py-lineno"> 225</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="L226"></a><tt class="py-lineno"> 226</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="L227"></a><tt class="py-lineno"> 227</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="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"> <tt class="py-param">requestBuilder</tt><tt class="py-op">=</tt><tt id="link-70" class="py-name"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-70', 'HttpRequest', 'link-22');">HttpRequest</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L229"></a><tt class="py-lineno"> 229</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="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a Resource for interacting with an API.</tt> </tt>
-<a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"><tt class="py-docstring"> Same as `build()`, but constructs the Resource object from a discovery</tt> </tt>
-<a name="L233"></a><tt class="py-lineno"> 233</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="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"><tt class="py-docstring"> service: string or object, the JSON discovery document describing the API.</tt> </tt>
-<a name="L237"></a><tt class="py-lineno"> 237</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="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"><tt class="py-docstring"> JSON.</tt> </tt>
-<a name="L239"></a><tt class="py-lineno"> 239</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="L240"></a><tt class="py-lineno"> 240</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="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"><tt class="py-docstring"> within the discovery document. (deprecated)</tt> </tt>
-<a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"><tt class="py-docstring"> future: string, discovery document with future capabilities (deprecated).</tt> </tt>
-<a name="L243"></a><tt class="py-lineno"> 243</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="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"><tt class="py-docstring"> like it that HTTP requests will be made through.</tt> </tt>
-<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, Key for controlling API usage, generated</tt> </tt>
-<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"><tt class="py-docstring"> from the API Console.</tt> </tt>
-<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"><tt class="py-docstring"> model: Model class instance that serializes and de-serializes requests and</tt> </tt>
-<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"><tt class="py-docstring"> responses.</tt> </tt>
-<a name="L249"></a><tt class="py-lineno"> 249</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="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"><tt class="py-docstring"> credentials: object, credentials to be used for authentication.</tt> </tt>
-<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"><tt class="py-docstring"> A Resource object with methods for interacting with the service.</tt> </tt>
-<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"> </tt>
-<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"> <tt class="py-comment"># future is no longer used.</tt> </tt>
-<a name="L257"></a><tt class="py-lineno"> 257</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="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> </tt>
-<a name="L259"></a><tt class="py-lineno"> 259</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="L260"></a><tt class="py-lineno"> 260</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="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"> <tt class="py-name">base</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="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"> <tt id="link-71" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-71', 'schema', 'link-39');">schema</a></tt> <tt class="py-op">=</tt> <tt id="link-72" class="py-name"><a title="googleapiclient.schema.Schemas" class="py-name" href="#" onclick="return doclink('link-72', 'Schemas', 'link-40');">Schemas</a></tt><tt class="py-op">(</tt><tt class="py-name">service</tt><tt class="py-op">)</tt> </tt>
-<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> </tt>
-<a name="L264"></a><tt class="py-lineno"> 264</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="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> <tt class="py-comment"># If credentials were passed in, we could have two cases:</tt> </tt>
-<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"> <tt class="py-comment"># 1. the scopes were specified, in which case the given credentials</tt> </tt>
-<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"> <tt class="py-comment"># are used for authorizing the http;</tt> </tt>
-<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"> <tt class="py-comment"># 2. the scopes were not provided (meaning the Application Default</tt> </tt>
-<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"> <tt class="py-comment"># Credentials are to be used). In this case, the Application Default</tt> </tt>
-<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"> <tt class="py-comment"># Credentials are built and used instead of the original credentials.</tt> </tt>
-<a name="L271"></a><tt class="py-lineno"> 271</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="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"> <tt class="py-comment"># authentication), there is no authorization of the http.</tt> </tt>
-<a name="L273"></a><tt class="py-lineno"> 273</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="L274"></a><tt class="py-lineno"> 274</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="L275"></a><tt class="py-lineno"> 275</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-73" class="py-name" targets="Method googleapiclient.schema.Schemas.get()=googleapiclient.schema.Schemas-class.html#get"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-73', 'get', 'link-73');">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-74" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-74', 'get', 'link-73');">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-75" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-75', 'get', 'link-73');">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="L276"></a><tt class="py-lineno"> 276</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="L277"></a><tt class="py-lineno"> 277</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="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> <tt class="py-comment"># No need to authorize the http object</tt> </tt>
-<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"> <tt class="py-comment"># if the service does not require authentication.</tt> </tt>
-<a name="L281"></a><tt class="py-lineno"> 281</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="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-keyword">if</tt> <tt class="py-name">credentials</tt><tt class="py-op">:</tt> </tt>
-<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"> <tt id="link-76" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-76', '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-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>
-<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> </tt>
-<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-78" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-78', 'model', 'link-30');">model</a></tt> <tt class="py-keyword">is</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-name">features</tt> <tt class="py-op">=</tt> <tt class="py-name">service</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-79', 'get', 'link-73');">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="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"> <tt id="link-80" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-80', 'model', 'link-30');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-81" class="py-name"><a title="googleapiclient.model.JsonModel" class="py-name" href="#" onclick="return doclink('link-81', 'JsonModel', 'link-31');">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="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-82" 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-82', 'Resource', 'link-82');">Resource</a></tt><tt class="py-op">(</tt><tt id="link-83" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-83', 'http', 'link-21');">http</a></tt><tt class="py-op">=</tt><tt id="link-84" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-84', 'http', 'link-21');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">baseUrl</tt><tt class="py-op">=</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-85" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-85', 'model', 'link-30');">model</a></tt><tt class="py-op">=</tt><tt id="link-86" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-86', 'model', 'link-30');">model</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-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="L291"></a><tt class="py-lineno"> 291</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-87" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-87', 'schema', 'link-39');">schema</a></tt><tt class="py-op">=</tt><tt id="link-88" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-88', 'schema', 'link-39');">schema</a></tt><tt class="py-op">)</tt> </tt>
-</div><a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"> </tt>
-<a name="_cast"></a><div id="_cast-def"><a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"> </tt>
-<a name="L294"></a><tt class="py-lineno"> 294</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="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert value to a string based on JSON Schema type.</tt> </tt>
-<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L297"></a><tt class="py-lineno"> 297</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="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"><tt class="py-docstring"> JSON Schema.</tt> </tt>
-<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"><tt class="py-docstring"> value: any, the value to convert</tt> </tt>
-<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"><tt class="py-docstring"> schema_type: string, the type that value should be interpreted as</tt> </tt>
-<a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"><tt class="py-docstring"> A string representation of 'value' based on the schema_type.</tt> </tt>
-<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L307"></a><tt class="py-lineno"> 307</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="L308"></a><tt class="py-lineno"> 308</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="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt> </tt>
-<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L311"></a><tt class="py-lineno"> 311</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="L312"></a><tt class="py-lineno"> 312</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="L313"></a><tt class="py-lineno"> 313</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="L314"></a><tt class="py-lineno"> 314</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="L315"></a><tt class="py-lineno"> 315</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="L316"></a><tt class="py-lineno"> 316</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="L317"></a><tt class="py-lineno"> 317</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="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L319"></a><tt class="py-lineno"> 319</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="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt> </tt>
-<a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L322"></a><tt class="py-lineno"> 322</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="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"> </tt>
-<a name="_media_size_to_long"></a><div id="_media_size_to_long-def"><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> <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="L326"></a><tt class="py-lineno"> 326</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="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"><tt class="py-docstring"> maxSize: string, size as a string, such as 2MB or 7GB.</tt> </tt>
-<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"><tt class="py-docstring"> The size as an integer value.</tt> </tt>
-<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L334"></a><tt class="py-lineno"> 334</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="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-number">0</tt> </tt>
-<a name="L336"></a><tt class="py-lineno"> 336</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="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"> <tt class="py-name">bit_shift</tt> <tt class="py-op">=</tt> <tt id="link-89" class="py-name"><a title="googleapiclient.discovery._MEDIA_SIZE_BIT_SHIFTS" class="py-name" href="#" onclick="return doclink('link-89', '_MEDIA_SIZE_BIT_SHIFTS', 'link-47');">_MEDIA_SIZE_BIT_SHIFTS</a></tt><tt class="py-op">.</tt><tt id="link-90" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-90', 'get', 'link-73');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">units</tt><tt class="py-op">)</tt> </tt>
-<a name="L338"></a><tt class="py-lineno"> 338</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="L339"></a><tt class="py-lineno"> 339</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="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L341"></a><tt class="py-lineno"> 341</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="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> </tt>
-<a name="_media_path_url_from_info"></a><div id="_media_path_url_from_info-def"><a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> </tt>
-<a name="L344"></a><tt class="py-lineno"> 344</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="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates an absolute media path URL.</tt> </tt>
-<a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L347"></a><tt class="py-lineno"> 347</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="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"><tt class="py-docstring"> document and the relative path for the API method.</tt> </tt>
-<a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
-<a name="L352"></a><tt class="py-lineno"> 352</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="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"><tt class="py-docstring"> root, which is specified in the discovery document.</tt> </tt>
-<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"><tt class="py-docstring"> String; the absolute URI for media upload for the API method.</tt> </tt>
-<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L358"></a><tt class="py-lineno"> 358</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="L359"></a><tt class="py-lineno"> 359</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="L360"></a><tt class="py-lineno"> 360</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="L361"></a><tt class="py-lineno"> 361</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="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
-</div><a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> </tt>
-<a name="_fix_up_parameters"></a><div id="_fix_up_parameters-def"><a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> </tt>
-<a name="L365"></a><tt class="py-lineno"> 365</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="L366"></a><tt class="py-lineno"> 366</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="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L368"></a><tt class="py-lineno"> 368</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="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"><tt class="py-docstring"> parameters for the individual method. Also adds parameters which don't</tt> </tt>
-<a name="L370"></a><tt class="py-lineno"> 370</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="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"><tt class="py-docstring"> APIs (these are listed in STACK_QUERY_PARAMETERS).</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"> SIDE EFFECTS: This updates the parameters dictionary object in the method</tt> </tt>
-<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"><tt class="py-docstring"> description.</tt> </tt>
-<a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
-<a name="L378"></a><tt class="py-lineno"> 378</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="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
-<a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
-<a name="L381"></a><tt class="py-lineno"> 381</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="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"><tt class="py-docstring"> in method_desc.</tt> </tt>
-<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"><tt class="py-docstring"> The updated Dictionary stored in the 'parameters' key of the method</tt> </tt>
-<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"><tt class="py-docstring"> description dictionary.</tt> </tt>
-<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L388"></a><tt class="py-lineno"> 388</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="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"> </tt>
-<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"> <tt class="py-comment"># Add in the parameters common to all methods.</tt> </tt>
-<a name="L391"></a><tt class="py-lineno"> 391</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-91" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-91', 'get', 'link-73');">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="L392"></a><tt class="py-lineno"> 392</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="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"> </tt>
-<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> <tt class="py-comment"># Add in undocumented query parameters.</tt> </tt>
-<a name="L395"></a><tt class="py-lineno"> 395</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-92" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETERS" class="py-name" href="#" onclick="return doclink('link-92', 'STACK_QUERY_PARAMETERS', 'link-50');">STACK_QUERY_PARAMETERS</a></tt><tt class="py-op">:</tt> </tt>
-<a name="L396"></a><tt class="py-lineno"> 396</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-93" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-93', 'STACK_QUERY_PARAMETER_DEFAULT_VALUE', 'link-51');">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="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"> </tt>
-<a name="L398"></a><tt class="py-lineno"> 398</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="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"> <tt class="py-comment"># a request payload.</tt> </tt>
-<a name="L400"></a><tt class="py-lineno"> 400</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-94" class="py-name"><a title="googleapiclient.discovery.HTTP_PAYLOAD_METHODS" class="py-name" href="#" onclick="return doclink('link-94', 'HTTP_PAYLOAD_METHODS', 'link-46');">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="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> <tt id="link-95" 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-95', 'body', 'link-95');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-96" class="py-name"><a title="googleapiclient.discovery.BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-96', 'BODY_PARAMETER_DEFAULT_VALUE', 'link-48');">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="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"> <tt id="link-97" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-97', 'body', 'link-95');">body</a></tt><tt class="py-op">.</tt><tt id="link-98" 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-98', 'update', 'link-98');">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="L403"></a><tt class="py-lineno"> 403</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-99" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-99', 'body', 'link-95');">body</a></tt> </tt>
-<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"> </tt>
-<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parameters</tt> </tt>
-</div><a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"> </tt>
-<a name="_fix_up_media_upload"></a><div id="_fix_up_media_upload-def"><a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> </tt>
-<a name="L408"></a><tt class="py-lineno"> 408</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="L409"></a><tt class="py-lineno"> 409</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="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L411"></a><tt class="py-lineno"> 411</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="L412"></a><tt class="py-lineno"> 412</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="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"><tt class="py-docstring"> 'mediaUpload' in the method description, adds 'media_upload' key to</tt> </tt>
-<a name="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"><tt class="py-docstring"> parameters.</tt> </tt>
-<a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
-<a name="L418"></a><tt class="py-lineno"> 418</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="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
-<a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
-<a name="L421"></a><tt class="py-lineno"> 421</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="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"><tt class="py-docstring"> root, which is specified in the discovery document.</tt> </tt>
-<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"><tt class="py-docstring"> parameters: A dictionary describing method parameters for method described</tt> </tt>
-<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"><tt class="py-docstring"> in method_desc.</tt> </tt>
-<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"><tt class="py-docstring"> Triple (accept, max_size, media_path_url) where:</tt> </tt>
-<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"><tt class="py-docstring"> - accept is a list of strings representing what content types are</tt> </tt>
-<a name="L429"></a><tt class="py-lineno"> 429</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="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"><tt class="py-docstring"> discovery document.</tt> </tt>
-<a name="L431"></a><tt class="py-lineno"> 431</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="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"><tt class="py-docstring"> media upload. Defaults to 0L if not in the discovery document.</tt> </tt>
-<a name="L433"></a><tt class="py-lineno"> 433</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="L434"></a><tt class="py-lineno"> 434</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="L435"></a><tt class="py-lineno"> 435</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="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"><tt class="py-docstring"> media upload is not supported, this is None.</tt> </tt>
-<a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L438"></a><tt class="py-lineno"> 438</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-100" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-100', 'get', 'link-73');">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="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"> <tt id="link-101" 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.Model.request" class="py-name" href="#" onclick="return doclink('link-63', 'request', 'link-63');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">requested_url</tt><tt class="py-op">)</tt> </tt>
+<a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"> </tt>
+<a name="L199"></a><tt class="py-lineno"> 199</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">404</tt><tt class="py-op">:</tt> </tt>
+<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-64" class="py-name"><a title="googleapiclient.errors.UnknownApiNameOrVersion" class="py-name" href="#" onclick="return doclink('link-64', 'UnknownApiNameOrVersion', 'link-16');">UnknownApiNameOrVersion</a></tt><tt class="py-op">(</tt><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>
+<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"> <tt class="py-name">version</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-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="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-65" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-65', '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">requested_url</tt><tt class="py-op">)</tt> </tt>
+<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"> </tt>
+<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L206"></a><tt class="py-lineno"> 206</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="L207"></a><tt class="py-lineno"> 207</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="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"> </tt>
+<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L211"></a><tt class="py-lineno"> 211</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="L212"></a><tt class="py-lineno"> 212</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="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"> <tt id="link-66" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-66', '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="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-67" class="py-name"><a title="googleapiclient.errors.InvalidJsonError" class="py-name" href="#" onclick="return doclink('link-67', 'InvalidJsonError', 'link-7');">InvalidJsonError</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"> </tt>
+<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-68" 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-68', 'build_from_document', 'link-68');">build_from_document</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">base</tt><tt class="py-op">=</tt><tt class="py-name">discoveryServiceUrl</tt><tt class="py-op">,</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-op">=</tt><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>
+<a name="L217"></a><tt class="py-lineno"> 217</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-71" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-71', 'model', 'link-33');">model</a></tt><tt class="py-op">=</tt><tt id="link-72" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-72', '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="L218"></a><tt class="py-lineno"> 218</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>
+</div><a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"> </tt>
+<a name="build_from_document"></a><div id="build_from_document-def"><a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> </tt>
+<a name="L221"></a><tt class="py-lineno"> 221</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="L222"></a><tt class="py-lineno"> 222</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="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> <tt class="py-param">service</tt><tt class="py-op">,</tt> </tt>
+<a name="L224"></a><tt class="py-lineno"> 224</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="L225"></a><tt class="py-lineno"> 225</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="L226"></a><tt class="py-lineno"> 226</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="L227"></a><tt class="py-lineno"> 227</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="L228"></a><tt class="py-lineno"> 228</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="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> <tt class="py-param">requestBuilder</tt><tt class="py-op">=</tt><tt id="link-73" class="py-name"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-73', 'HttpRequest', 'link-25');">HttpRequest</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L230"></a><tt class="py-lineno"> 230</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="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a Resource for interacting with an API.</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"> Same as `build()`, but constructs the Resource object from a discovery</tt> </tt>
+<a name="L234"></a><tt class="py-lineno"> 234</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="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"><tt class="py-docstring"> service: string or object, the JSON discovery document describing the API.</tt> </tt>
+<a name="L238"></a><tt class="py-lineno"> 238</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="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"><tt class="py-docstring"> JSON.</tt> </tt>
+<a name="L240"></a><tt class="py-lineno"> 240</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="L241"></a><tt class="py-lineno"> 241</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="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"><tt class="py-docstring"> within the discovery document. (deprecated)</tt> </tt>
+<a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"><tt class="py-docstring"> future: string, discovery document with future capabilities (deprecated).</tt> </tt>
+<a name="L244"></a><tt class="py-lineno"> 244</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="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"><tt class="py-docstring"> like it that HTTP requests will be made through.</tt> </tt>
+<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, Key for controlling API usage, generated</tt> </tt>
+<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"><tt class="py-docstring"> from the API Console.</tt> </tt>
+<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"><tt class="py-docstring"> model: Model class instance that serializes and de-serializes requests and</tt> </tt>
+<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"><tt class="py-docstring"> responses.</tt> </tt>
+<a name="L250"></a><tt class="py-lineno"> 250</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="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"><tt class="py-docstring"> credentials: object, credentials to be used for authentication.</tt> </tt>
+<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"><tt class="py-docstring"> A Resource object with methods for interacting with the service.</tt> </tt>
+<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"> </tt>
+<a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"> <tt class="py-comment"># future is no longer used.</tt> </tt>
+<a name="L258"></a><tt class="py-lineno"> 258</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="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"> </tt>
+<a name="L260"></a><tt class="py-lineno"> 260</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="L261"></a><tt class="py-lineno"> 261</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="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"> <tt class="py-name">base</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="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> <tt id="link-74" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-74', 'schema', 'link-42');">schema</a></tt> <tt class="py-op">=</tt> <tt id="link-75" class="py-name"><a title="googleapiclient.schema.Schemas" class="py-name" href="#" onclick="return doclink('link-75', '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="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">credentials</tt><tt class="py-op">:</tt> </tt>
+<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"> <tt class="py-comment"># If credentials were passed in, we could have two cases:</tt> </tt>
+<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"> <tt class="py-comment"># 1. the scopes were specified, in which case the given credentials</tt> </tt>
+<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"> <tt class="py-comment"># are used for authorizing the http;</tt> </tt>
+<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"> <tt class="py-comment"># 2. the scopes were not provided (meaning the Application Default</tt> </tt>
+<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"> <tt class="py-comment"># Credentials are to be used). In this case, the Application Default</tt> </tt>
+<a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"> <tt class="py-comment"># Credentials are built and used instead of the original credentials.</tt> </tt>
+<a name="L272"></a><tt class="py-lineno"> 272</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="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"> <tt class="py-comment"># authentication), there is no authorization of the http.</tt> </tt>
+<a name="L274"></a><tt class="py-lineno"> 274</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="L275"></a><tt class="py-lineno"> 275</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="L276"></a><tt class="py-lineno"> 276</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-76" class="py-name" targets="Method googleapiclient.schema.Schemas.get()=googleapiclient.schema.Schemas-class.html#get"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-76', 'get', 'link-76');">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-77" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-77', 'get', 'link-76');">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-78" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-78', 'get', 'link-76');">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="L277"></a><tt class="py-lineno"> 277</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="L278"></a><tt class="py-lineno"> 278</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="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"> <tt class="py-comment"># No need to authorize the http object</tt> </tt>
+<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"> <tt class="py-comment"># if the service does not require authentication.</tt> </tt>
+<a name="L282"></a><tt class="py-lineno"> 282</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="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"> </tt>
+<a name="L284"></a><tt class="py-lineno"> 284</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="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> <tt id="link-79" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-79', '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-80" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-80', 'http', 'link-21');">http</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> </tt>
+<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-81" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-81', '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="L288"></a><tt class="py-lineno"> 288</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-82" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-82', 'get', 'link-76');">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="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt id="link-83" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-83', 'model', 'link-33');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-84" class="py-name"><a title="googleapiclient.model.JsonModel" class="py-name" href="#" onclick="return doclink('link-84', '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="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-85" 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-85', 'Resource', 'link-85');">Resource</a></tt><tt class="py-op">(</tt><tt id="link-86" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-86', 'http', 'link-21');">http</a></tt><tt class="py-op">=</tt><tt id="link-87" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-87', 'http', 'link-21');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">baseUrl</tt><tt class="py-op">=</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-88" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-88', 'model', 'link-33');">model</a></tt><tt class="py-op">=</tt><tt id="link-89" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-89', 'model', 'link-33');">model</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L291"></a><tt class="py-lineno"> 291</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="L292"></a><tt class="py-lineno"> 292</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-90" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-90', 'schema', 'link-42');">schema</a></tt><tt class="py-op">=</tt><tt id="link-91" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-91', 'schema', 'link-42');">schema</a></tt><tt class="py-op">)</tt> </tt>
+</div><a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"> </tt>
+<a name="_cast"></a><div id="_cast-def"><a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"> </tt>
+<a name="L295"></a><tt class="py-lineno"> 295</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="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert value to a string based on JSON Schema type.</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"> See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on</tt> </tt>
+<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"><tt class="py-docstring"> JSON Schema.</tt> </tt>
+<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"><tt class="py-docstring"> value: any, the value to convert</tt> </tt>
+<a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"><tt class="py-docstring"> schema_type: string, the type that value should be interpreted as</tt> </tt>
+<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"><tt class="py-docstring"> A string representation of 'value' based on the schema_type.</tt> </tt>
+<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L308"></a><tt class="py-lineno"> 308</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="L309"></a><tt class="py-lineno"> 309</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="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt> </tt>
+<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L312"></a><tt class="py-lineno"> 312</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="L313"></a><tt class="py-lineno"> 313</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="L314"></a><tt class="py-lineno"> 314</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="L315"></a><tt class="py-lineno"> 315</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="L316"></a><tt class="py-lineno"> 316</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="L317"></a><tt class="py-lineno"> 317</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="L318"></a><tt class="py-lineno"> 318</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="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L320"></a><tt class="py-lineno"> 320</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="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt> </tt>
+<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L323"></a><tt class="py-lineno"> 323</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="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"> </tt>
+<a name="_media_size_to_long"></a><div id="_media_size_to_long-def"><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> <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="L327"></a><tt class="py-lineno"> 327</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="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"><tt class="py-docstring"> maxSize: string, size as a string, such as 2MB or 7GB.</tt> </tt>
+<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"><tt class="py-docstring"> The size as an integer value.</tt> </tt>
+<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L335"></a><tt class="py-lineno"> 335</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="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-number">0</tt> </tt>
+<a name="L337"></a><tt class="py-lineno"> 337</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="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"> <tt class="py-name">bit_shift</tt> <tt class="py-op">=</tt> <tt id="link-92" class="py-name"><a title="googleapiclient.discovery._MEDIA_SIZE_BIT_SHIFTS" class="py-name" href="#" onclick="return doclink('link-92', '_MEDIA_SIZE_BIT_SHIFTS', 'link-50');">_MEDIA_SIZE_BIT_SHIFTS</a></tt><tt class="py-op">.</tt><tt id="link-93" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-93', 'get', 'link-76');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">units</tt><tt class="py-op">)</tt> </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">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="L340"></a><tt class="py-lineno"> 340</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="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L342"></a><tt class="py-lineno"> 342</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="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> </tt>
+<a name="_media_path_url_from_info"></a><div id="_media_path_url_from_info-def"><a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"> </tt>
+<a name="L345"></a><tt class="py-lineno"> 345</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="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates an absolute media path URL.</tt> </tt>
+<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L348"></a><tt class="py-lineno"> 348</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="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"><tt class="py-docstring"> document and the relative path for the API method.</tt> </tt>
+<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
+<a name="L353"></a><tt class="py-lineno"> 353</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="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"><tt class="py-docstring"> root, which is specified in the discovery document.</tt> </tt>
+<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"><tt class="py-docstring"> String; the absolute URI for media upload for the API method.</tt> </tt>
+<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L359"></a><tt class="py-lineno"> 359</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="L360"></a><tt class="py-lineno"> 360</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="L361"></a><tt class="py-lineno"> 361</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="L362"></a><tt class="py-lineno"> 362</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="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
+</div><a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> </tt>
+<a name="_fix_up_parameters"></a><div id="_fix_up_parameters-def"><a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"> </tt>
+<a name="L366"></a><tt class="py-lineno"> 366</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="L367"></a><tt class="py-lineno"> 367</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="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L369"></a><tt class="py-lineno"> 369</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="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"><tt class="py-docstring"> parameters for the individual method. Also adds parameters which don't</tt> </tt>
+<a name="L371"></a><tt class="py-lineno"> 371</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="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"><tt class="py-docstring"> APIs (these are listed in STACK_QUERY_PARAMETERS).</tt> </tt>
+<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"><tt class="py-docstring"> SIDE EFFECTS: This updates the parameters dictionary object in the method</tt> </tt>
+<a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"><tt class="py-docstring"> description.</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"> Args:</tt> </tt>
+<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
+<a name="L379"></a><tt class="py-lineno"> 379</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="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
+<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
+<a name="L382"></a><tt class="py-lineno"> 382</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="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"><tt class="py-docstring"> in method_desc.</tt> </tt>
+<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"><tt class="py-docstring"> The updated Dictionary stored in the 'parameters' key of the method</tt> </tt>
+<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"><tt class="py-docstring"> description dictionary.</tt> </tt>
+<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L389"></a><tt class="py-lineno"> 389</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="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"> </tt>
+<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"> <tt class="py-comment"># Add in the parameters common to all methods.</tt> </tt>
+<a name="L392"></a><tt class="py-lineno"> 392</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-94" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-94', 'get', 'link-76');">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="L393"></a><tt class="py-lineno"> 393</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="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> </tt>
+<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"> <tt class="py-comment"># Add in undocumented query parameters.</tt> </tt>
+<a name="L396"></a><tt class="py-lineno"> 396</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-95" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETERS" class="py-name" href="#" onclick="return doclink('link-95', 'STACK_QUERY_PARAMETERS', 'link-53');">STACK_QUERY_PARAMETERS</a></tt><tt class="py-op">:</tt> </tt>
+<a name="L397"></a><tt class="py-lineno"> 397</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-96" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-96', 'STACK_QUERY_PARAMETER_DEFAULT_VALUE', 'link-54');">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="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"> </tt>
+<a name="L399"></a><tt class="py-lineno"> 399</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="L400"></a><tt class="py-lineno"> 400</tt> <tt class="py-line"> <tt class="py-comment"># a request payload.</tt> </tt>
+<a name="L401"></a><tt class="py-lineno"> 401</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-97" class="py-name"><a title="googleapiclient.discovery.HTTP_PAYLOAD_METHODS" class="py-name" href="#" onclick="return doclink('link-97', 'HTTP_PAYLOAD_METHODS', 'link-49');">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="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"> <tt id="link-98" 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-98', 'body', 'link-98');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-99" class="py-name"><a title="googleapiclient.discovery.BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-99', 'BODY_PARAMETER_DEFAULT_VALUE', 'link-51');">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="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"> <tt id="link-100" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-100', 'body', 'link-98');">body</a></tt><tt class="py-op">.</tt><tt id="link-101" 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-101', 'update', 'link-101');">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="L404"></a><tt class="py-lineno"> 404</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-102" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-102', 'body', 'link-98');">body</a></tt> </tt>
+<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"> </tt>
+<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parameters</tt> </tt>
+</div><a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> </tt>
+<a name="_fix_up_media_upload"></a><div id="_fix_up_media_upload-def"><a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"> </tt>
+<a name="L409"></a><tt class="py-lineno"> 409</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="L410"></a><tt class="py-lineno"> 410</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="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L412"></a><tt class="py-lineno"> 412</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="L413"></a><tt class="py-lineno"> 413</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="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"><tt class="py-docstring"> 'mediaUpload' in the method description, adds 'media_upload' key to</tt> </tt>
+<a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"><tt class="py-docstring"> parameters.</tt> </tt>
+<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
+<a name="L419"></a><tt class="py-lineno"> 419</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="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
+<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
+<a name="L422"></a><tt class="py-lineno"> 422</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="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"><tt class="py-docstring"> root, which is specified in the discovery document.</tt> </tt>
+<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"><tt class="py-docstring"> parameters: A dictionary describing method parameters for method described</tt> </tt>
+<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"><tt class="py-docstring"> in method_desc.</tt> </tt>
+<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"><tt class="py-docstring"> Triple (accept, max_size, media_path_url) where:</tt> </tt>
+<a name="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"><tt class="py-docstring"> - accept is a list of strings representing what content types are</tt> </tt>
+<a name="L430"></a><tt class="py-lineno"> 430</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="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"><tt class="py-docstring"> discovery document.</tt> </tt>
+<a name="L432"></a><tt class="py-lineno"> 432</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="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"><tt class="py-docstring"> media upload. Defaults to 0L if not in the discovery document.</tt> </tt>
+<a name="L434"></a><tt class="py-lineno"> 434</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="L435"></a><tt class="py-lineno"> 435</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="L436"></a><tt class="py-lineno"> 436</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="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"><tt class="py-docstring"> media upload is not supported, this is None.</tt> </tt>
+<a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L439"></a><tt class="py-lineno"> 439</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-103" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-103', 'get', 'link-76');">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="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"> <tt id="link-104" 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-101', 'accept', 'link-101');">accept</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-102" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-102', 'get', 'link-73');">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="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"> <tt class="py-name">max_size</tt> <tt class="py-op">=</tt> <tt id="link-103" 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-103', '_media_size_to_long', 'link-103');">_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-104" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-104', 'get', 'link-73');">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="L441"></a><tt class="py-lineno"> 441</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="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"> </tt>
-<a name="L443"></a><tt class="py-lineno"> 443</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="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"> <tt class="py-name">media_path_url</tt> <tt class="py-op">=</tt> <tt id="link-105" 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-105', '_media_path_url_from_info', 'link-105');">_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="L445"></a><tt class="py-lineno"> 445</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-106" class="py-name"><a title="googleapiclient.discovery.MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-106', 'MEDIA_BODY_PARAMETER_DEFAULT_VALUE', 'link-49');">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="L446"></a><tt class="py-lineno"> 446</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="L447"></a><tt class="py-lineno"> 447</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="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"> </tt>
-<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-107" class="py-name"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-104', 'accept', 'link-104');">accept</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-105" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-105', 'get', 'link-76');">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="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"> <tt class="py-name">max_size</tt> <tt class="py-op">=</tt> <tt id="link-106" 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-106', '_media_size_to_long', 'link-106');">_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-107" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-107', 'get', 'link-76');">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="L442"></a><tt class="py-lineno"> 442</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="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"> </tt>
+<a name="L444"></a><tt class="py-lineno"> 444</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="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"> <tt class="py-name">media_path_url</tt> <tt class="py-op">=</tt> <tt id="link-108" 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-108', '_media_path_url_from_info', 'link-108');">_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="L446"></a><tt class="py-lineno"> 446</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-109" class="py-name"><a title="googleapiclient.discovery.MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-109', 'MEDIA_BODY_PARAMETER_DEFAULT_VALUE', 'link-52');">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="L447"></a><tt class="py-lineno"> 447</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="L448"></a><tt class="py-lineno"> 448</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="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"> </tt>
+<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-110" 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-107', 'accept', 'link-101');">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="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"> </tt>
-<a name="_fix_up_method_description"></a><div id="_fix_up_method_description-def"><a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"> </tt>
-<a name="L452"></a><tt class="py-lineno"> 452</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="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"> <tt class="py-docstring">"""Updates a method description in a discovery document.</tt> </tt>
-<a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"><tt class="py-docstring"> SIDE EFFECTS: Changes the parameters dictionary in the method description with</tt> </tt>
-<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"><tt class="py-docstring"> extra parameters which are used locally.</tt> </tt>
-<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
-<a name="L460"></a><tt class="py-lineno"> 460</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="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
-<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
-<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L465"></a><tt class="py-lineno"> 465</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="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"><tt class="py-docstring"> where:</tt> </tt>
-<a name="L467"></a><tt class="py-lineno"> 467</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="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"><tt class="py-docstring"> the API root, which is specified in the discovery document.</tt> </tt>
-<a name="L469"></a><tt class="py-lineno"> 469</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="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"><tt class="py-docstring"> described in the method description.</tt> </tt>
-<a name="L471"></a><tt class="py-lineno"> 471</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="L472"></a><tt class="py-lineno"> 472</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="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"><tt class="py-docstring"> - accept is a list of strings representing what content types are</tt> </tt>
-<a name="L474"></a><tt class="py-lineno"> 474</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="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"><tt class="py-docstring"> discovery document.</tt> </tt>
-<a name="L476"></a><tt class="py-lineno"> 476</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="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"><tt class="py-docstring"> media upload. Defaults to 0L if not in the discovery document.</tt> </tt>
-<a name="L478"></a><tt class="py-lineno"> 478</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="L479"></a><tt class="py-lineno"> 479</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="L480"></a><tt class="py-lineno"> 480</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="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"><tt class="py-docstring"> media upload is not supported, this is None.</tt> </tt>
-<a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L483"></a><tt class="py-lineno"> 483</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="L484"></a><tt class="py-lineno"> 484</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="L485"></a><tt class="py-lineno"> 485</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="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"> </tt>
-<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"> <tt class="py-name">parameters</tt> <tt class="py-op">=</tt> <tt id="link-108" 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-108', '_fix_up_parameters', 'link-108');">_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="L488"></a><tt class="py-lineno"> 488</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="L489"></a><tt class="py-lineno"> 489</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="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"> <tt class="py-comment"># also sets a 'media_body' parameter.</tt> </tt>
-<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"> <tt id="link-109" class="py-name"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-110', 'accept', 'link-104');">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="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"> </tt>
+<a name="_fix_up_method_description"></a><div id="_fix_up_method_description-def"><a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> </tt>
+<a name="L453"></a><tt class="py-lineno"> 453</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="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"> <tt class="py-docstring">"""Updates a method description in a discovery document.</tt> </tt>
+<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"><tt class="py-docstring"> SIDE EFFECTS: Changes the parameters dictionary in the method description with</tt> </tt>
+<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"><tt class="py-docstring"> extra parameters which are used locally.</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"> Args:</tt> </tt>
+<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
+<a name="L461"></a><tt class="py-lineno"> 461</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="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
+<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
+<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L466"></a><tt class="py-lineno"> 466</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="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"><tt class="py-docstring"> where:</tt> </tt>
+<a name="L468"></a><tt class="py-lineno"> 468</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="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"><tt class="py-docstring"> the API root, which is specified in the discovery document.</tt> </tt>
+<a name="L470"></a><tt class="py-lineno"> 470</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="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"><tt class="py-docstring"> described in the method description.</tt> </tt>
+<a name="L472"></a><tt class="py-lineno"> 472</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="L473"></a><tt class="py-lineno"> 473</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="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"><tt class="py-docstring"> - accept is a list of strings representing what content types are</tt> </tt>
+<a name="L475"></a><tt class="py-lineno"> 475</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="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"><tt class="py-docstring"> discovery document.</tt> </tt>
+<a name="L477"></a><tt class="py-lineno"> 477</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="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"><tt class="py-docstring"> media upload. Defaults to 0L if not in the discovery document.</tt> </tt>
+<a name="L479"></a><tt class="py-lineno"> 479</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="L480"></a><tt class="py-lineno"> 480</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="L481"></a><tt class="py-lineno"> 481</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="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"><tt class="py-docstring"> media upload is not supported, this is None.</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-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="L485"></a><tt class="py-lineno"> 485</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="L486"></a><tt class="py-lineno"> 486</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="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"> </tt>
+<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"> <tt class="py-name">parameters</tt> <tt class="py-op">=</tt> <tt id="link-111" 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-111', '_fix_up_parameters', 'link-111');">_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="L489"></a><tt class="py-lineno"> 489</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="L490"></a><tt class="py-lineno"> 490</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="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"> <tt class="py-comment"># also sets a 'media_body' parameter.</tt> </tt>
+<a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"> <tt id="link-112" 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-109', 'accept', 'link-101');">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-110" 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-110', '_fix_up_media_upload', 'link-110');">_fix_up_media_upload</a></tt><tt class="py-op">(</tt> </tt>
-<a name="L492"></a><tt class="py-lineno"> 492</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="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"> </tt>
-<a name="L494"></a><tt class="py-lineno"> 494</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-111" class="py-name"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-112', 'accept', 'link-104');">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-113" 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-113', '_fix_up_media_upload', 'link-113');">_fix_up_media_upload</a></tt><tt class="py-op">(</tt> </tt>
+<a name="L493"></a><tt class="py-lineno"> 493</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="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"> </tt>
+<a name="L495"></a><tt class="py-lineno"> 495</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-114" 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-111', 'accept', 'link-101');">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="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"> </tt>
-<a name="_urljoin"></a><div id="_urljoin-def"><a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"> </tt>
-<a name="L497"></a><tt class="py-lineno"> 497</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="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"> <tt class="py-docstring">"""Custom urljoin replacement supporting : before / in url."""</tt> </tt>
-<a name="L499"></a><tt class="py-lineno"> 499</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="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"> <tt class="py-comment"># the case of discovery documents, we know:</tt> </tt>
-<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"> <tt class="py-comment"># * base will never contain params, query, or fragment</tt> </tt>
-<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"> <tt class="py-comment"># * url will never contain a scheme or net_loc.</tt> </tt>
-<a name="L503"></a><tt class="py-lineno"> 503</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="L504"></a><tt class="py-lineno"> 504</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="L505"></a><tt class="py-lineno"> 505</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="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"> <tt class="py-comment"># absolute url.</tt> </tt>
-<a name="L507"></a><tt class="py-lineno"> 507</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="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urljoin</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
-<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"> <tt class="py-name">new_base</tt> <tt class="py-op">=</tt> <tt class="py-name">base</tt> <tt class="py-keyword">if</tt> <tt class="py-name">base</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 class="py-name">base</tt> <tt class="py-op">+</tt> <tt class="py-string">'/'</tt> </tt>
-<a name="L510"></a><tt class="py-lineno"> 510</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="L511"></a><tt class="py-lineno"> 511</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="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"> </tt>
-<a name="ResourceMethodParameters"></a><div id="ResourceMethodParameters-def"><a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"> </tt>
-<a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"><tt class="py-comment"># TODO(dhermes): Convert this class to ResourceMethod and make it callable</tt> </tt>
-<a name="L515"></a><tt class="py-lineno"> 515</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="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"> <tt class="py-docstring">"""Represents the parameters associated with a method.</tt> </tt>
-<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"><tt class="py-docstring"> Attributes:</tt> </tt>
-<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"><tt class="py-docstring"> argmap: Map from method parameter name (string) to query parameter name</tt> </tt>
-<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"><tt class="py-docstring"> (string).</tt> </tt>
-<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"><tt class="py-docstring"> required_params: List of required parameters (represented by parameter</tt> </tt>
-<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"><tt class="py-docstring"> name as string).</tt> </tt>
-<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"><tt class="py-docstring"> repeated_params: List of repeated parameters (represented by parameter</tt> </tt>
-<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"><tt class="py-docstring"> name as string).</tt> </tt>
-<a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"><tt class="py-docstring"> pattern_params: Map from method parameter name (string) to regular</tt> </tt>
-<a name="L526"></a><tt class="py-lineno"> 526</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="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"><tt class="py-docstring"> value for that parameter must match the regular expression.</tt> </tt>
-<a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"><tt class="py-docstring"> query_params: List of parameters (represented by parameter name as string)</tt> </tt>
-<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"><tt class="py-docstring"> that will be used in the query string.</tt> </tt>
-<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"><tt class="py-docstring"> path_params: Set of parameters (represented by parameter name as string)</tt> </tt>
-<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"><tt class="py-docstring"> that will be used in the base URL path.</tt> </tt>
-<a name="L532"></a><tt class="py-lineno"> 532</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="L533"></a><tt class="py-lineno"> 533</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="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"><tt class="py-docstring"> 'boolean', 'integer', 'number', 'object', or 'string'. Reference:</tt> </tt>
-<a name="L535"></a><tt class="py-lineno"> 535</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="L536"></a><tt class="py-lineno"> 536</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="L537"></a><tt class="py-lineno"> 537</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="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>
-<a name="ResourceMethodParameters.__init__"></a><div id="ResourceMethodParameters.__init__-def"><a name="L540"></a><tt class="py-lineno"> 540</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="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for ResourceMethodParameters.</tt> </tt>
-<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"><tt class="py-docstring"> Sets default values and defers to set_parameters to populate.</tt> </tt>
-<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value</tt> </tt>
-<a name="L547"></a><tt class="py-lineno"> 547</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="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"><tt class="py-docstring"> the deserialized discovery document.</tt> </tt>
-<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L550"></a><tt class="py-lineno"> 550</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="L551"></a><tt class="py-lineno"> 551</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="L552"></a><tt class="py-lineno"> 552</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="L553"></a><tt class="py-lineno"> 553</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="L554"></a><tt class="py-lineno"> 554</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="L555"></a><tt class="py-lineno"> 555</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="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"> <tt class="py-comment"># parsing is gotten rid of.</tt> </tt>
-<a name="L557"></a><tt class="py-lineno"> 557</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 class="py-name">set</tt><tt class="py-op">(</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">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="L559"></a><tt class="py-lineno"> 559</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="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"> </tt>
-<a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-112" 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-112', 'set_parameters', 'link-112');">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="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"> </tt>
-<a name="ResourceMethodParameters.set_parameters"></a><div id="ResourceMethodParameters.set_parameters-def"><a name="L563"></a><tt class="py-lineno"> 563</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="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"> <tt class="py-docstring">"""Populates maps and lists based on method description.</tt> </tt>
-<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L566"></a><tt class="py-lineno"> 566</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="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"><tt class="py-docstring"> the parameter dictionary.</tt> </tt>
-<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value</tt> </tt>
-<a name="L571"></a><tt class="py-lineno"> 571</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="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"><tt class="py-docstring"> the deserialized discovery document.</tt> </tt>
-<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L574"></a><tt class="py-lineno"> 574</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-113" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-113', 'get', 'link-73');">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="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"> <tt class="py-name">param</tt> <tt class="py-op">=</tt> <tt id="link-114" 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-114', 'key2param', 'link-114');">key2param</a></tt><tt class="py-op">(</tt><tt class="py-name">arg</tt><tt class="py-op">)</tt> </tt>
-<a name="L576"></a><tt class="py-lineno"> 576</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="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"> </tt>
-<a name="L578"></a><tt class="py-lineno"> 578</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-115" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-115', 'get', 'link-73');">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="L579"></a><tt class="py-lineno"> 579</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="L580"></a><tt class="py-lineno"> 580</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-116" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-116', 'get', 'link-73');">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="L581"></a><tt class="py-lineno"> 581</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="L582"></a><tt class="py-lineno"> 582</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-117" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-117', 'get', 'link-73');">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="L583"></a><tt class="py-lineno"> 583</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="L584"></a><tt class="py-lineno"> 584</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-118" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-118', 'get', 'link-73');">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="L585"></a><tt class="py-lineno"> 585</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="L586"></a><tt class="py-lineno"> 586</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-119" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-119', 'get', 'link-73');">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="L587"></a><tt class="py-lineno"> 587</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="L588"></a><tt class="py-lineno"> 588</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-120" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-120', 'get', 'link-73');">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="L589"></a><tt class="py-lineno"> 589</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-121" 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-121', 'add', 'link-121');">add</a></tt><tt class="py-op">(</tt><tt class="py-name">param</tt><tt class="py-op">)</tt> </tt>
-<a name="L590"></a><tt class="py-lineno"> 590</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-122" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-122', 'get', 'link-73');">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="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> </tt>
-<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"> <tt class="py-comment"># TODO(dhermes): Determine if this is still necessary. Discovery based APIs</tt> </tt>
-<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> <tt class="py-comment"># should have all path parameters already marked with</tt> </tt>
-<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> <tt class="py-comment"># 'location: path'.</tt> </tt>
-<a name="L595"></a><tt class="py-lineno"> 595</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-123" class="py-name"><a title="googleapiclient.discovery.URITEMPLATE" class="py-name" href="#" onclick="return doclink('link-123', 'URITEMPLATE', 'link-42');">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="L596"></a><tt class="py-lineno"> 596</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-124" class="py-name"><a title="googleapiclient.discovery.VARNAME" class="py-name" href="#" onclick="return doclink('link-124', 'VARNAME', 'link-43');">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="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"> <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt id="link-125" class="py-name"><a title="googleapiclient.discovery.key2param" class="py-name" href="#" onclick="return doclink('link-125', 'key2param', 'link-114');">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="L598"></a><tt class="py-lineno"> 598</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-126" class="py-name"><a title="googleapiclient.http.BatchHttpRequest.add" class="py-name" href="#" onclick="return doclink('link-126', 'add', 'link-121');">add</a></tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
-<a name="L599"></a><tt class="py-lineno"> 599</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="L600"></a><tt class="py-lineno"> 600</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="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"> </tt>
-<a name="createMethod"></a><div id="createMethod-def"><a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"> </tt>
-<a name="L603"></a><tt class="py-lineno"> 603</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="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates a method for attaching to a Resource.</tt> </tt>
-<a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
-<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"><tt class="py-docstring"> methodDesc: object, fragment of deserialized discovery document that</tt> </tt>
-<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"><tt class="py-docstring"> describes the method.</tt> </tt>
-<a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"><tt class="py-docstring"> rootDesc: object, the entire deserialized discovery document.</tt> </tt>
-<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, mapping of schema names to schema descriptions.</tt> </tt>
-<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-127" 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-127', 'fix_method_name', 'link-127');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
-<a name="L614"></a><tt class="py-lineno"> 614</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-128" class="py-name"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-114', 'accept', 'link-104');">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="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"> </tt>
+<a name="_urljoin"></a><div id="_urljoin-def"><a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"> </tt>
+<a name="L498"></a><tt class="py-lineno"> 498</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="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"> <tt class="py-docstring">"""Custom urljoin replacement supporting : before / in url."""</tt> </tt>
+<a name="L500"></a><tt class="py-lineno"> 500</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="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"> <tt class="py-comment"># the case of discovery documents, we know:</tt> </tt>
+<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"> <tt class="py-comment"># * base will never contain params, query, or fragment</tt> </tt>
+<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"> <tt class="py-comment"># * url will never contain a scheme or net_loc.</tt> </tt>
+<a name="L504"></a><tt class="py-lineno"> 504</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="L505"></a><tt class="py-lineno"> 505</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="L506"></a><tt class="py-lineno"> 506</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="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"> <tt class="py-comment"># absolute url.</tt> </tt>
+<a name="L508"></a><tt class="py-lineno"> 508</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="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urljoin</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
+<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"> <tt class="py-name">new_base</tt> <tt class="py-op">=</tt> <tt class="py-name">base</tt> <tt class="py-keyword">if</tt> <tt class="py-name">base</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 class="py-name">base</tt> <tt class="py-op">+</tt> <tt class="py-string">'/'</tt> </tt>
+<a name="L511"></a><tt class="py-lineno"> 511</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="L512"></a><tt class="py-lineno"> 512</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="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"> </tt>
+<a name="ResourceMethodParameters"></a><div id="ResourceMethodParameters-def"><a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"> </tt>
+<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"><tt class="py-comment"># TODO(dhermes): Convert this class to ResourceMethod and make it callable</tt> </tt>
+<a name="L516"></a><tt class="py-lineno"> 516</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="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"> <tt class="py-docstring">"""Represents the parameters associated with a method.</tt> </tt>
+<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"><tt class="py-docstring"> Attributes:</tt> </tt>
+<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"><tt class="py-docstring"> argmap: Map from method parameter name (string) to query parameter name</tt> </tt>
+<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"><tt class="py-docstring"> (string).</tt> </tt>
+<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"><tt class="py-docstring"> required_params: List of required parameters (represented by parameter</tt> </tt>
+<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"><tt class="py-docstring"> name as string).</tt> </tt>
+<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"><tt class="py-docstring"> repeated_params: List of repeated parameters (represented by parameter</tt> </tt>
+<a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"><tt class="py-docstring"> name as string).</tt> </tt>
+<a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"><tt class="py-docstring"> pattern_params: Map from method parameter name (string) to regular</tt> </tt>
+<a name="L527"></a><tt class="py-lineno"> 527</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="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"><tt class="py-docstring"> value for that parameter must match the regular expression.</tt> </tt>
+<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"><tt class="py-docstring"> query_params: List of parameters (represented by parameter name as string)</tt> </tt>
+<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"><tt class="py-docstring"> that will be used in the query string.</tt> </tt>
+<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"><tt class="py-docstring"> path_params: Set of parameters (represented by parameter name as string)</tt> </tt>
+<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"><tt class="py-docstring"> that will be used in the base URL path.</tt> </tt>
+<a name="L533"></a><tt class="py-lineno"> 533</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="L534"></a><tt class="py-lineno"> 534</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="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"><tt class="py-docstring"> 'boolean', 'integer', 'number', 'object', or 'string'. Reference:</tt> </tt>
+<a name="L536"></a><tt class="py-lineno"> 536</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="L537"></a><tt class="py-lineno"> 537</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="L538"></a><tt class="py-lineno"> 538</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="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> </tt>
+<a name="ResourceMethodParameters.__init__"></a><div id="ResourceMethodParameters.__init__-def"><a name="L541"></a><tt class="py-lineno"> 541</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="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for ResourceMethodParameters.</tt> </tt>
+<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"><tt class="py-docstring"> Sets default values and defers to set_parameters to populate.</tt> </tt>
+<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value</tt> </tt>
+<a name="L548"></a><tt class="py-lineno"> 548</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="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"><tt class="py-docstring"> the deserialized discovery document.</tt> </tt>
+<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L551"></a><tt class="py-lineno"> 551</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="L552"></a><tt class="py-lineno"> 552</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="L553"></a><tt class="py-lineno"> 553</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="L554"></a><tt class="py-lineno"> 554</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="L555"></a><tt class="py-lineno"> 555</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="L556"></a><tt class="py-lineno"> 556</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="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"> <tt class="py-comment"># parsing is gotten rid of.</tt> </tt>
+<a name="L558"></a><tt class="py-lineno"> 558</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 class="py-name">set</tt><tt class="py-op">(</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">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="L560"></a><tt class="py-lineno"> 560</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="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">self</tt><tt class="py-op">.</tt><tt id="link-115" 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-115', 'set_parameters', 'link-115');">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="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> </tt>
+<a name="ResourceMethodParameters.set_parameters"></a><div id="ResourceMethodParameters.set_parameters-def"><a name="L564"></a><tt class="py-lineno"> 564</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="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"> <tt class="py-docstring">"""Populates maps and lists based on method description.</tt> </tt>
+<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L567"></a><tt class="py-lineno"> 567</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="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"><tt class="py-docstring"> the parameter dictionary.</tt> </tt>
+<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value</tt> </tt>
+<a name="L572"></a><tt class="py-lineno"> 572</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="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"><tt class="py-docstring"> the deserialized discovery document.</tt> </tt>
+<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L575"></a><tt class="py-lineno"> 575</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-116" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-116', 'get', 'link-76');">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="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"> <tt class="py-name">param</tt> <tt class="py-op">=</tt> <tt id="link-117" 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-117', 'key2param', 'link-117');">key2param</a></tt><tt class="py-op">(</tt><tt class="py-name">arg</tt><tt class="py-op">)</tt> </tt>
+<a name="L577"></a><tt class="py-lineno"> 577</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="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"> </tt>
+<a name="L579"></a><tt class="py-lineno"> 579</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-118" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-118', 'get', 'link-76');">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="L580"></a><tt class="py-lineno"> 580</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="L581"></a><tt class="py-lineno"> 581</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-119" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-119', 'get', 'link-76');">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="L582"></a><tt class="py-lineno"> 582</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="L583"></a><tt class="py-lineno"> 583</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-120" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-120', 'get', 'link-76');">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="L584"></a><tt class="py-lineno"> 584</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="L585"></a><tt class="py-lineno"> 585</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-121" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-121', 'get', 'link-76');">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="L586"></a><tt class="py-lineno"> 586</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="L587"></a><tt class="py-lineno"> 587</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-122" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-122', 'get', 'link-76');">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="L588"></a><tt class="py-lineno"> 588</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="L589"></a><tt class="py-lineno"> 589</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-123" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-123', 'get', 'link-76');">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="L590"></a><tt class="py-lineno"> 590</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-124" 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-124', 'add', 'link-124');">add</a></tt><tt class="py-op">(</tt><tt class="py-name">param</tt><tt class="py-op">)</tt> </tt>
+<a name="L591"></a><tt class="py-lineno"> 591</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-125" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-125', 'get', 'link-76');">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="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"> </tt>
+<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> <tt class="py-comment"># TODO(dhermes): Determine if this is still necessary. Discovery based APIs</tt> </tt>
+<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> <tt class="py-comment"># should have all path parameters already marked with</tt> </tt>
+<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"> <tt class="py-comment"># 'location: path'.</tt> </tt>
+<a name="L596"></a><tt class="py-lineno"> 596</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-126" class="py-name"><a title="googleapiclient.discovery.URITEMPLATE" class="py-name" href="#" onclick="return doclink('link-126', '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="L597"></a><tt class="py-lineno"> 597</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-127" class="py-name"><a title="googleapiclient.discovery.VARNAME" class="py-name" href="#" onclick="return doclink('link-127', '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="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"> <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt id="link-128" class="py-name"><a title="googleapiclient.discovery.key2param" class="py-name" href="#" onclick="return doclink('link-128', 'key2param', 'link-117');">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="L599"></a><tt class="py-lineno"> 599</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-129" class="py-name"><a title="googleapiclient.http.BatchHttpRequest.add" class="py-name" href="#" onclick="return doclink('link-129', 'add', 'link-124');">add</a></tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
+<a name="L600"></a><tt class="py-lineno"> 600</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="L601"></a><tt class="py-lineno"> 601</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="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"> </tt>
+<a name="createMethod"></a><div id="createMethod-def"><a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"> </tt>
+<a name="L604"></a><tt class="py-lineno"> 604</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="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates a method for attaching to a Resource.</tt> </tt>
+<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
+<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"><tt class="py-docstring"> methodDesc: object, fragment of deserialized discovery document that</tt> </tt>
+<a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"><tt class="py-docstring"> describes the method.</tt> </tt>
+<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"><tt class="py-docstring"> rootDesc: object, the entire deserialized discovery document.</tt> </tt>
+<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, mapping of schema names to schema descriptions.</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 class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-130" 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-130', 'fix_method_name', 'link-130');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
+<a name="L615"></a><tt class="py-lineno"> 615</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-131" 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-128', 'accept', 'link-101');">accept</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L615"></a><tt class="py-lineno"> 615</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-129" 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-129', '_fix_up_method_description', 'link-129');">_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="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> </tt>
-<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> <tt class="py-name">parameters</tt> <tt class="py-op">=</tt> <tt id="link-130" 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-130', 'ResourceMethodParameters', 'link-130');">ResourceMethodParameters</a></tt><tt class="py-op">(</tt><tt class="py-name">methodDesc</tt><tt class="py-op">)</tt> </tt>
-<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"> </tt>
-<a name="L619"></a><tt class="py-lineno"> 619</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="L620"></a><tt class="py-lineno"> 620</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="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"> </tt>
-<a name="L622"></a><tt class="py-lineno"> 622</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="L623"></a><tt class="py-lineno"> 623</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="L624"></a><tt class="py-lineno"> 624</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="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> </tt>
-<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"> <tt class="py-comment"># Remove args that have a value of None.</tt> </tt>
-<a name="L627"></a><tt class="py-lineno"> 627</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="L628"></a><tt class="py-lineno"> 628</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="L629"></a><tt class="py-lineno"> 629</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="L630"></a><tt class="py-lineno"> 630</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="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"> </tt>
-<a name="L632"></a><tt class="py-lineno"> 632</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="L633"></a><tt class="py-lineno"> 633</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="L634"></a><tt class="py-lineno"> 634</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="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-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="L637"></a><tt class="py-lineno"> 637</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="L638"></a><tt class="py-lineno"> 638</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="L639"></a><tt class="py-lineno"> 639</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="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L641"></a><tt class="py-lineno"> 641</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="L642"></a><tt class="py-lineno"> 642</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="L643"></a><tt class="py-lineno"> 643</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="L644"></a><tt class="py-lineno"> 644</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="L645"></a><tt class="py-lineno"> 645</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="L646"></a><tt class="py-lineno"> 646</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="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"> </tt>
-<a name="L648"></a><tt class="py-lineno"> 648</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="L649"></a><tt class="py-lineno"> 649</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="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"> <tt class="py-comment"># We need to handle the case of a repeated enum</tt> </tt>
-<a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"> <tt class="py-comment"># name differently, since we want to handle both</tt> </tt>
-<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"> <tt class="py-comment"># arg='value' and arg=['value1', 'value2']</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-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="L654"></a><tt class="py-lineno"> 654</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="L655"></a><tt class="py-lineno"> 655</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="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L657"></a><tt class="py-lineno"> 657</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="L658"></a><tt class="py-lineno"> 658</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="L659"></a><tt class="py-lineno"> 659</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="L660"></a><tt class="py-lineno"> 660</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="L661"></a><tt class="py-lineno"> 661</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="L662"></a><tt class="py-lineno"> 662</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="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"> </tt>
-<a name="L664"></a><tt class="py-lineno"> 664</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="L665"></a><tt class="py-lineno"> 665</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="L666"></a><tt class="py-lineno"> 666</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="L667"></a><tt class="py-lineno"> 667</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-131" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-131', 'get', 'link-73');">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="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> <tt class="py-comment"># For repeated parameters we cast each member of the list.</tt> </tt>
-<a name="L669"></a><tt class="py-lineno"> 669</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="L670"></a><tt class="py-lineno"> 670</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-132" 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-132', '_cast', 'link-132');">_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="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt class="py-keyword">else</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">cast_value</tt> <tt class="py-op">=</tt> <tt id="link-133" class="py-name"><a title="googleapiclient.discovery._cast" class="py-name" href="#" onclick="return doclink('link-133', '_cast', 'link-132');">_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="L673"></a><tt class="py-lineno"> 673</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="L674"></a><tt class="py-lineno"> 674</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="L675"></a><tt class="py-lineno"> 675</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="L676"></a><tt class="py-lineno"> 676</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="L677"></a><tt class="py-lineno"> 677</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-134" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-134', 'get', 'link-73');">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="L678"></a><tt class="py-lineno"> 678</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-135" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-135', 'get', 'link-73');">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="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"> </tt>
-<a name="L680"></a><tt class="py-lineno"> 680</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="L681"></a><tt class="py-lineno"> 681</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="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"> </tt>
-<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"> <tt id="link-136" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-136', 'model', 'link-30');">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="L684"></a><tt class="py-lineno"> 684</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="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"> <tt id="link-137" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-137', 'model', 'link-30');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-138" class="py-name"><a title="googleapiclient.model.MediaModel" class="py-name" href="#" onclick="return doclink('link-138', 'MediaModel', 'link-34');">MediaModel</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L686"></a><tt class="py-lineno"> 686</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="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"> <tt id="link-139" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-139', 'model', 'link-30');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-140" class="py-name"><a title="googleapiclient.model.RawModel" class="py-name" href="#" onclick="return doclink('link-140', 'RawModel', 'link-37');">RawModel</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> </tt>
-<a name="L689"></a><tt class="py-lineno"> 689</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="L690"></a><tt class="py-lineno"> 690</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-141" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-141', 'body', 'link-95');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-142" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-142', 'model', 'link-30');">model</a></tt><tt class="py-op">.</tt><tt id="link-143" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-131', 'accept', 'link-104');">accept</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L616"></a><tt class="py-lineno"> 616</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-132" 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-132', '_fix_up_method_description', 'link-132');">_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="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> </tt>
+<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"> <tt class="py-name">parameters</tt> <tt class="py-op">=</tt> <tt id="link-133" 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-133', 'ResourceMethodParameters', 'link-133');">ResourceMethodParameters</a></tt><tt class="py-op">(</tt><tt class="py-name">methodDesc</tt><tt class="py-op">)</tt> </tt>
+<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"> </tt>
+<a name="L620"></a><tt class="py-lineno"> 620</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="L621"></a><tt class="py-lineno"> 621</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="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"> </tt>
+<a name="L623"></a><tt class="py-lineno"> 623</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="L624"></a><tt class="py-lineno"> 624</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="L625"></a><tt class="py-lineno"> 625</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="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"> </tt>
+<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"> <tt class="py-comment"># Remove args that have a value of None.</tt> </tt>
+<a name="L628"></a><tt class="py-lineno"> 628</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="L629"></a><tt class="py-lineno"> 629</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="L630"></a><tt class="py-lineno"> 630</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="L631"></a><tt class="py-lineno"> 631</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="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"> </tt>
+<a name="L633"></a><tt class="py-lineno"> 633</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="L634"></a><tt class="py-lineno"> 634</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="L635"></a><tt class="py-lineno"> 635</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="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"> </tt>
+<a name="L637"></a><tt class="py-lineno"> 637</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="L638"></a><tt class="py-lineno"> 638</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="L639"></a><tt class="py-lineno"> 639</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="L640"></a><tt class="py-lineno"> 640</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="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L642"></a><tt class="py-lineno"> 642</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="L643"></a><tt class="py-lineno"> 643</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="L644"></a><tt class="py-lineno"> 644</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="L645"></a><tt class="py-lineno"> 645</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="L646"></a><tt class="py-lineno"> 646</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="L647"></a><tt class="py-lineno"> 647</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="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"> </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">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="L650"></a><tt class="py-lineno"> 650</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="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"> <tt class="py-comment"># We need to handle the case of a repeated enum</tt> </tt>
+<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"> <tt class="py-comment"># name differently, since we want to handle both</tt> </tt>
+<a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> <tt class="py-comment"># arg='value' and arg=['value1', 'value2']</tt> </tt>
+<a name="L654"></a><tt class="py-lineno"> 654</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="L655"></a><tt class="py-lineno"> 655</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="L656"></a><tt class="py-lineno"> 656</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="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"> <tt class="py-keyword">else</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">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="L659"></a><tt class="py-lineno"> 659</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="L660"></a><tt class="py-lineno"> 660</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="L661"></a><tt class="py-lineno"> 661</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="L662"></a><tt class="py-lineno"> 662</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="L663"></a><tt class="py-lineno"> 663</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="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-name">actual_query_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
+<a name="L666"></a><tt class="py-lineno"> 666</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="L667"></a><tt class="py-lineno"> 667</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="L668"></a><tt class="py-lineno"> 668</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-134" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-134', 'get', 'link-76');">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="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"> <tt class="py-comment"># For repeated parameters we cast each member of the list.</tt> </tt>
+<a name="L670"></a><tt class="py-lineno"> 670</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="L671"></a><tt class="py-lineno"> 671</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-135" 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-135', '_cast', 'link-135');">_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="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"> <tt class="py-keyword">else</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">cast_value</tt> <tt class="py-op">=</tt> <tt id="link-136" class="py-name"><a title="googleapiclient.discovery._cast" class="py-name" href="#" onclick="return doclink('link-136', '_cast', 'link-135');">_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="L674"></a><tt class="py-lineno"> 674</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="L675"></a><tt class="py-lineno"> 675</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="L676"></a><tt class="py-lineno"> 676</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="L677"></a><tt class="py-lineno"> 677</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="L678"></a><tt class="py-lineno"> 678</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-137" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-137', 'get', 'link-76');">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="L679"></a><tt class="py-lineno"> 679</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-138" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-138', 'get', 'link-76');">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="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"> </tt>
+<a name="L681"></a><tt class="py-lineno"> 681</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="L682"></a><tt class="py-lineno"> 682</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="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"> </tt>
+<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"> <tt id="link-139" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-139', '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="L685"></a><tt class="py-lineno"> 685</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="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"> <tt id="link-140" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-140', 'model', 'link-33');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-141" class="py-name"><a title="googleapiclient.model.MediaModel" class="py-name" href="#" onclick="return doclink('link-141', 'MediaModel', 'link-37');">MediaModel</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L687"></a><tt class="py-lineno"> 687</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="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt id="link-142" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-142', 'model', 'link-33');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-143" class="py-name"><a title="googleapiclient.model.RawModel" class="py-name" href="#" onclick="return doclink('link-143', 'RawModel', 'link-40');">RawModel</a></tt><tt class="py-op">(</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">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
+<a name="L691"></a><tt class="py-lineno"> 691</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-144" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-144', 'body', 'link-98');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-145" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-145', 'model', 'link-33');">model</a></tt><tt class="py-op">.</tt><tt id="link-146" 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-143', 'request', 'link-60');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt>
-<a name="L691"></a><tt class="py-lineno"> 691</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="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> </tt>
-<a name="L693"></a><tt class="py-lineno"> 693</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="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt id="link-144" 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-144', '_urljoin', 'link-144');">_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="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> </tt>
-<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"> <tt id="link-145" 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-145', 'resumable', 'link-145');">resumable</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
-<a name="L697"></a><tt class="py-lineno"> 697</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="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-keyword">if</tt> <tt class="py-name">media_filename</tt><tt class="py-op">:</tt> </tt>
-<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> <tt class="py-comment"># Ensure we end up with a valid MediaUpload object.</tt> </tt>
-<a name="L701"></a><tt class="py-lineno"> 701</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="L702"></a><tt class="py-lineno"> 702</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="L703"></a><tt class="py-lineno"> 703</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="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-146" class="py-name"><a title="googleapiclient.errors.UnknownFileType" class="py-name" href="#" onclick="return doclink('link-146', '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="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-147" class="py-name"><a title="googleapiclient.mimeparse" class="py-name" href="#" onclick="return doclink('link-147', 'mimeparse', 'link-1');">mimeparse</a></tt><tt class="py-op">.</tt><tt id="link-148" 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-148', 'best_match', 'link-148');">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-149" class="py-name"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-146', 'request', 'link-63');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt>
+<a name="L692"></a><tt class="py-lineno"> 692</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="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-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="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt id="link-147" 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-147', '_urljoin', 'link-147');">_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="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 id="link-148" 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-148', 'resumable', 'link-148');">resumable</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
+<a name="L698"></a><tt class="py-lineno"> 698</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="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> </tt>
+<a name="L700"></a><tt class="py-lineno"> 700</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="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> <tt class="py-comment"># Ensure we end up with a valid MediaUpload object.</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">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="L703"></a><tt class="py-lineno"> 703</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="L704"></a><tt class="py-lineno"> 704</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="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-149" class="py-name"><a title="googleapiclient.errors.UnknownFileType" class="py-name" href="#" onclick="return doclink('link-149', '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="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-150" class="py-name"><a title="googleapiclient.mimeparse" class="py-name" href="#" onclick="return doclink('link-150', 'mimeparse', 'link-1');">mimeparse</a></tt><tt class="py-op">.</tt><tt id="link-151" 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-151', 'best_match', 'link-151');">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-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-149', 'accept', 'link-101');">accept</a></tt><tt class="py-op">)</tt><tt class="py-op">)</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">raise</tt> <tt id="link-150" class="py-name"><a title="googleapiclient.errors.UnacceptableMimeTypeError" class="py-name" href="#" onclick="return doclink('link-150', '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="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"> <tt class="py-name">media_upload</tt> <tt class="py-op">=</tt> <tt id="link-151" class="py-name"><a title="googleapiclient.http.MediaFileUpload" class="py-name" href="#" onclick="return doclink('link-151', 'MediaFileUpload', 'link-25');">MediaFileUpload</a></tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">,</tt> </tt>
-<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> <tt id="link-152" 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-152', 'mimetype', 'link-152');">mimetype</a></tt><tt class="py-op">=</tt><tt class="py-name">media_mime_type</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">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-153" class="py-name"><a title="googleapiclient.http.MediaUpload" class="py-name" href="#" onclick="return doclink('link-153', 'MediaUpload', 'link-28');">MediaUpload</a></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-name">media_upload</tt> <tt class="py-op">=</tt> <tt class="py-name">media_filename</tt> </tt>
-<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"> <tt class="py-keyword">else</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">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="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> </tt>
-<a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> <tt class="py-comment"># Check the maxSize</tt> </tt>
-<a name="L715"></a><tt class="py-lineno"> 715</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-154" 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-154', 'size', 'link-154');">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-155" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
-googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-155', 'size', 'link-154');">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="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-156" class="py-name"><a title="googleapiclient.errors.MediaUploadSizeError" class="py-name" href="#" onclick="return doclink('link-156', '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="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> </tt>
-<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"> <tt class="py-comment"># Use the media path uri for media uploads</tt> </tt>
-<a name="L719"></a><tt class="py-lineno"> 719</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="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt id="link-157" class="py-name"><a title="googleapiclient.discovery._urljoin" class="py-name" href="#" onclick="return doclink('link-157', '_urljoin', 'link-144');">_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="L721"></a><tt class="py-lineno"> 721</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-158" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-158', 'resumable', 'link-145');">resumable</a></tt><tt class="py-op">(</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-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="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"> </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">media_upload</tt><tt class="py-op">.</tt><tt id="link-159" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-159', 'resumable', 'link-145');">resumable</a></tt><tt class="py-op">(</tt><tt class="py-op">)</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"># This is all we need to do for resumable, if the body exists it gets</tt> </tt>
-<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"> <tt class="py-comment"># sent in the first request, otherwise an empty body is sent.</tt> </tt>
-<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt id="link-160" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-160', 'resumable', 'link-145');">resumable</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt> </tt>
-<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> <tt class="py-comment"># A non-resumable upload</tt> </tt>
-<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-161" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-161', 'body', 'link-95');">body</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"> <tt class="py-comment"># This is a simple media upload</tt> </tt>
-<a name="L732"></a><tt class="py-lineno"> 732</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-162" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.mimetype
-googleapiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-162', 'mimetype', 'link-152');">mimetype</a></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 id="link-163" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-163', 'body', 'link-95');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-164" 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-164', 'getbytes', 'link-164');">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-165" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
-googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-165', 'size', 'link-154');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L734"></a><tt class="py-lineno"> 734</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="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"> <tt class="py-comment"># This is a multipart/related upload.</tt> </tt>
-<a name="L737"></a><tt class="py-lineno"> 737</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="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"> <tt class="py-comment"># msgRoot should not write out it's own headers</tt> </tt>
-<a name="L739"></a><tt class="py-lineno"> 739</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="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"> </tt>
-<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"> <tt class="py-comment"># attach the body as one part</tt> </tt>
-<a name="L742"></a><tt class="py-lineno"> 742</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="L743"></a><tt class="py-lineno"> 743</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-166" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-166', 'body', 'link-95');">body</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L744"></a><tt class="py-lineno"> 744</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="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"> </tt>
-<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"> <tt class="py-comment"># attach the media as the second part</tt> </tt>
-<a name="L747"></a><tt class="py-lineno"> 747</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-167" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.mimetype
-googleapiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-167', 'mimetype', 'link-152');">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="L748"></a><tt class="py-lineno"> 748</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="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"> </tt>
-<a name="L750"></a><tt class="py-lineno"> 750</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-168" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.getbytes
-googleapiclient.http.MediaUpload.getbytes" class="py-name" href="#" onclick="return doclink('link-168', 'getbytes', 'link-164');">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-169" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
-googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-169', 'size', 'link-154');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</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">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="L752"></a><tt class="py-lineno"> 752</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="L753"></a><tt class="py-lineno"> 753</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="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"> <tt class="py-comment"># it plays games with `From ` lines.</tt> </tt>
-<a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"> <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt class="py-name">StringIO</tt><tt class="py-op">(</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">g</tt> <tt class="py-op">=</tt> <tt class="py-name">Generator</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="L757"></a><tt class="py-lineno"> 757</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="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> <tt id="link-170" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-170', 'body', 'link-95');">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="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> </tt>
-<a name="L760"></a><tt class="py-lineno"> 760</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="L761"></a><tt class="py-lineno"> 761</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="L762"></a><tt class="py-lineno"> 762</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="L763"></a><tt class="py-lineno"> 763</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="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"> </tt>
-<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"> <tt id="link-171" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-171', 'logger', 'link-41');">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="L766"></a><tt class="py-lineno"> 766</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="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> <tt id="link-172" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-172', 'model', 'link-30');">model</a></tt><tt class="py-op">.</tt><tt id="link-173" 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-173', 'response', 'link-173');">response</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> <tt class="py-name">url</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">method</tt><tt class="py-op">=</tt><tt class="py-name">httpMethod</tt><tt class="py-op">,</tt> </tt>
-<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"> <tt id="link-174" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-174', 'body', 'link-95');">body</a></tt><tt class="py-op">=</tt><tt id="link-175" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-175', 'body', 'link-95');">body</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L771"></a><tt class="py-lineno"> 771</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="L772"></a><tt class="py-lineno"> 772</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="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"> <tt id="link-176" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-176', 'resumable', 'link-145');">resumable</a></tt><tt class="py-op">=</tt><tt id="link-177" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-177', 'resumable', 'link-145');">resumable</a></tt><tt class="py-op">)</tt> </tt>
-</div><a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"> </tt>
-<a name="L775"></a><tt class="py-lineno"> 775</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-178" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-178', 'get', 'link-73');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt id="link-179" class="py-name"><a title="googleapiclient.discovery.DEFAULT_METHOD_DOC" class="py-name" href="#" onclick="return doclink('link-179', 'DEFAULT_METHOD_DOC', 'link-45');">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="L776"></a><tt class="py-lineno"> 776</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="L777"></a><tt class="py-lineno"> 777</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="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"> </tt>
-<a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"> <tt class="py-comment"># Skip undocumented params and params common to all methods.</tt> </tt>
-<a name="L780"></a><tt class="py-lineno"> 780</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-180" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-180', 'get', 'link-73');">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="L781"></a><tt class="py-lineno"> 781</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-181" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETERS" class="py-name" href="#" onclick="return doclink('link-181', 'STACK_QUERY_PARAMETERS', 'link-50');">STACK_QUERY_PARAMETERS</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> </tt>
-<a name="L783"></a><tt class="py-lineno"> 783</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="L784"></a><tt class="py-lineno"> 784</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-182" class="py-name"><a title="googleapiclient.discovery.key2param" class="py-name" href="#" onclick="return doclink('link-182', 'key2param', 'link-114');">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-183" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-183', 'get', 'link-73');">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="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"> </tt>
-<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> <tt class="py-comment"># Move body to the front of the line.</tt> </tt>
-<a name="L787"></a><tt class="py-lineno"> 787</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="L788"></a><tt class="py-lineno"> 788</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="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"> </tt>
-<a name="L790"></a><tt class="py-lineno"> 790</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="L791"></a><tt class="py-lineno"> 791</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="L792"></a><tt class="py-lineno"> 792</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="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"> </tt>
-<a name="L794"></a><tt class="py-lineno"> 794</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="L795"></a><tt class="py-lineno"> 795</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="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
-<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> </tt>
-<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"> <tt class="py-name">repeated</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </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">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="L800"></a><tt class="py-lineno"> 800</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="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> <tt class="py-name">required</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
-<a name="L802"></a><tt class="py-lineno"> 802</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="L803"></a><tt class="py-lineno"> 803</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="L804"></a><tt class="py-lineno"> 804</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="L805"></a><tt class="py-lineno"> 805</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-184" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-184', 'get', 'link-73');">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="L806"></a><tt class="py-lineno"> 806</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="L807"></a><tt class="py-lineno"> 807</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="L808"></a><tt class="py-lineno"> 808</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="L809"></a><tt class="py-lineno"> 809</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="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> <tt id="link-185" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-185', 'schema', 'link-39');">schema</a></tt><tt class="py-op">.</tt><tt id="link-186" 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-186', 'prettyPrintByName', 'link-186');">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="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L812"></a><tt class="py-lineno"> 812</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-187" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-187', 'get', 'link-73');">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="L813"></a><tt class="py-lineno"> 813</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="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"> <tt class="py-name">repeated</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L815"></a><tt class="py-lineno"> 815</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-188" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-188', 'get', 'link-73');">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="L816"></a><tt class="py-lineno"> 816</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-189" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-189', 'get', 'link-73');">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="L817"></a><tt class="py-lineno"> 817</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="L818"></a><tt class="py-lineno"> 818</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="L819"></a><tt class="py-lineno"> 819</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="L820"></a><tt class="py-lineno"> 820</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="L821"></a><tt class="py-lineno"> 821</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="L822"></a><tt class="py-lineno"> 822</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="L823"></a><tt class="py-lineno"> 823</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="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"> <tt class="py-keyword">else</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">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="L826"></a><tt class="py-lineno"> 826</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-190" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-190', 'schema', 'link-39');">schema</a></tt><tt class="py-op">.</tt><tt id="link-191" 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-191', 'prettyPrintSchema', 'link-191');">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="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"> </tt>
-<a name="L828"></a><tt class="py-lineno"> 828</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="L829"></a><tt class="py-lineno"> 829</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="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"> </tt>
-<a name="createNextMethod"></a><div id="createNextMethod-def"><a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> </tt>
-<a name="L832"></a><tt class="py-lineno"> 832</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="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates any _next methods for attaching to a Resource.</tt> </tt>
-<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"><tt class="py-docstring"> The _next methods allow for easy iteration through list() responses.</tt> </tt>
-<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
-<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-192" class="py-name"><a title="googleapiclient.discovery.fix_method_name" class="py-name" href="#" onclick="return doclink('link-192', 'fix_method_name', 'link-127');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
-<a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> </tt>
-<a name="L842"></a><tt class="py-lineno"> 842</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="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieves the next page of results.</tt> </tt>
-<a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"><tt class="py-docstring">Args:</tt> </tt>
-<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"><tt class="py-docstring"> previous_request: The request for the previous page. (required)</tt> </tt>
-<a name="L847"></a><tt class="py-lineno"> 847</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="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"><tt class="py-docstring">Returns:</tt> </tt>
-<a name="L850"></a><tt class="py-lineno"> 850</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="L851"></a><tt class="py-lineno"> 851</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="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"> <tt class="py-comment"># Retrieve nextPageToken from previous_response</tt> </tt>
-<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> <tt class="py-comment"># Use as pageToken in previous_request to create new request.</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-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-op">:</tt> </tt>
-<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</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 id="link-193" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-152', 'accept', 'link-104');">accept</a></tt><tt class="py-op">)</tt><tt class="py-op">)</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 id="link-153" class="py-name"><a title="googleapiclient.errors.UnacceptableMimeTypeError" class="py-name" href="#" onclick="return doclink('link-153', '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="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> <tt class="py-name">media_upload</tt> <tt class="py-op">=</tt> <tt id="link-154" class="py-name"><a title="googleapiclient.http.MediaFileUpload" class="py-name" href="#" onclick="return doclink('link-154', '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="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt id="link-155" 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-155', 'mimetype', 'link-155');">mimetype</a></tt><tt class="py-op">=</tt><tt class="py-name">media_mime_type</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">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-156" class="py-name"><a title="googleapiclient.http.MediaUpload" class="py-name" href="#" onclick="return doclink('link-156', 'MediaUpload', 'link-31');">MediaUpload</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L711"></a><tt class="py-lineno"> 711</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="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> <tt class="py-keyword">else</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">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="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> </tt>
+<a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"> <tt class="py-comment"># Check the maxSize</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">media_upload</tt><tt class="py-op">.</tt><tt id="link-157" 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-157', 'size', 'link-157');">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-158" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
+googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-158', 'size', 'link-157');">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="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-159" class="py-name"><a title="googleapiclient.errors.MediaUploadSizeError" class="py-name" href="#" onclick="return doclink('link-159', '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="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"> </tt>
+<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-comment"># Use the media path uri for media uploads</tt> </tt>
+<a name="L720"></a><tt class="py-lineno"> 720</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="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt id="link-160" class="py-name"><a title="googleapiclient.discovery._urljoin" class="py-name" href="#" onclick="return doclink('link-160', '_urljoin', 'link-147');">_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="L722"></a><tt class="py-lineno"> 722</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-161" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-161', 'resumable', 'link-148');">resumable</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L723"></a><tt class="py-lineno"> 723</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="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"> </tt>
+<a name="L725"></a><tt class="py-lineno"> 725</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-162" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-162', 'resumable', 'link-148');">resumable</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L726"></a><tt class="py-lineno"> 726</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="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt class="py-comment"># sent in the first request, otherwise an empty body is sent.</tt> </tt>
+<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"> <tt id="link-163" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-163', 'resumable', 'link-148');">resumable</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</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-comment"># A non-resumable upload</tt> </tt>
+<a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-164" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-164', 'body', 'link-98');">body</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"> <tt class="py-comment"># This is a simple media upload</tt> </tt>
+<a name="L733"></a><tt class="py-lineno"> 733</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-165" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.mimetype
+googleapiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-165', 'mimetype', 'link-155');">mimetype</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"> <tt id="link-166" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-166', 'body', 'link-98');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-167" 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-167', 'getbytes', 'link-167');">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-168" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
+googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-168', 'size', 'link-157');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L735"></a><tt class="py-lineno"> 735</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="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"> <tt class="py-comment"># This is a multipart/related upload.</tt> </tt>
+<a name="L738"></a><tt class="py-lineno"> 738</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="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"> <tt class="py-comment"># msgRoot should not write out it's own headers</tt> </tt>
+<a name="L740"></a><tt class="py-lineno"> 740</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="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"> </tt>
+<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> <tt class="py-comment"># attach the body as one part</tt> </tt>
+<a name="L743"></a><tt class="py-lineno"> 743</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="L744"></a><tt class="py-lineno"> 744</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-169" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-169', 'body', 'link-98');">body</a></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">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="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"> </tt>
+<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-comment"># attach the media as the second part</tt> </tt>
+<a name="L748"></a><tt class="py-lineno"> 748</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-170" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.mimetype
+googleapiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-170', 'mimetype', 'link-155');">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="L749"></a><tt class="py-lineno"> 749</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="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"> </tt>
+<a name="L751"></a><tt class="py-lineno"> 751</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-171" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.getbytes
+googleapiclient.http.MediaUpload.getbytes" class="py-name" href="#" onclick="return doclink('link-171', 'getbytes', 'link-167');">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-172" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
+googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-172', 'size', 'link-157');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L752"></a><tt class="py-lineno"> 752</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="L753"></a><tt class="py-lineno"> 753</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="L754"></a><tt class="py-lineno"> 754</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="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"> <tt class="py-comment"># it plays games with `From ` lines.</tt> </tt>
+<a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"> <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt class="py-name">StringIO</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"> <tt class="py-name">g</tt> <tt class="py-op">=</tt> <tt class="py-name">Generator</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="L758"></a><tt class="py-lineno"> 758</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="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> <tt id="link-173" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-173', 'body', 'link-98');">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="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> </tt>
+<a name="L761"></a><tt class="py-lineno"> 761</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="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-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="L763"></a><tt class="py-lineno"> 763</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="L764"></a><tt class="py-lineno"> 764</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="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 id="link-174" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-174', '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="L767"></a><tt class="py-lineno"> 767</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="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> <tt id="link-175" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-175', 'model', 'link-33');">model</a></tt><tt class="py-op">.</tt><tt id="link-176" 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-176', 'response', 'link-176');">response</a></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>
+<a name="L770"></a><tt class="py-lineno"> 770</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="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> <tt id="link-177" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-177', 'body', 'link-98');">body</a></tt><tt class="py-op">=</tt><tt id="link-178" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-178', 'body', 'link-98');">body</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L772"></a><tt class="py-lineno"> 772</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="L773"></a><tt class="py-lineno"> 773</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="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"> <tt id="link-179" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-179', 'resumable', 'link-148');">resumable</a></tt><tt class="py-op">=</tt><tt id="link-180" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-180', 'resumable', 'link-148');">resumable</a></tt><tt class="py-op">)</tt> </tt>
+</div><a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"> </tt>
+<a name="L776"></a><tt class="py-lineno"> 776</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-181" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-181', 'get', 'link-76');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt id="link-182" class="py-name"><a title="googleapiclient.discovery.DEFAULT_METHOD_DOC" class="py-name" href="#" onclick="return doclink('link-182', 'DEFAULT_METHOD_DOC', 'link-48');">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="L777"></a><tt class="py-lineno"> 777</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="L778"></a><tt class="py-lineno"> 778</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="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"> </tt>
+<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"> <tt class="py-comment"># Skip undocumented params and params common to all methods.</tt> </tt>
+<a name="L781"></a><tt class="py-lineno"> 781</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-183" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-183', 'get', 'link-76');">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="L782"></a><tt class="py-lineno"> 782</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-184" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETERS" class="py-name" href="#" onclick="return doclink('link-184', 'STACK_QUERY_PARAMETERS', 'link-53');">STACK_QUERY_PARAMETERS</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"> </tt>
+<a name="L784"></a><tt class="py-lineno"> 784</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="L785"></a><tt class="py-lineno"> 785</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-185" class="py-name"><a title="googleapiclient.discovery.key2param" class="py-name" href="#" onclick="return doclink('link-185', 'key2param', 'link-117');">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-186" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-186', 'get', 'link-76');">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="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"># Move body to the front of the line.</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-string">'body'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">all_args</tt><tt class="py-op">:</tt> </tt>
+<a name="L789"></a><tt class="py-lineno"> 789</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="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-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="L792"></a><tt class="py-lineno"> 792</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="L793"></a><tt class="py-lineno"> 793</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="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> </tt>
+<a name="L795"></a><tt class="py-lineno"> 795</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="L796"></a><tt class="py-lineno"> 796</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="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> <tt class="py-keyword">continue</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-name">repeated</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
+<a name="L800"></a><tt class="py-lineno"> 800</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="L801"></a><tt class="py-lineno"> 801</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="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> <tt class="py-name">required</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
+<a name="L803"></a><tt class="py-lineno"> 803</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="L804"></a><tt class="py-lineno"> 804</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="L805"></a><tt class="py-lineno"> 805</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="L806"></a><tt class="py-lineno"> 806</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-187" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-187', 'get', 'link-76');">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="L807"></a><tt class="py-lineno"> 807</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="L808"></a><tt class="py-lineno"> 808</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="L809"></a><tt class="py-lineno"> 809</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="L810"></a><tt class="py-lineno"> 810</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="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt id="link-188" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-188', 'schema', 'link-42');">schema</a></tt><tt class="py-op">.</tt><tt id="link-189" 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-189', 'prettyPrintByName', 'link-189');">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="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L813"></a><tt class="py-lineno"> 813</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-190" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-190', 'get', 'link-76');">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="L814"></a><tt class="py-lineno"> 814</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="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"> <tt class="py-name">repeated</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">enum</tt> <tt class="py-op">=</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">.</tt><tt id="link-191" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-191', 'get', 'link-76');">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="L817"></a><tt class="py-lineno"> 817</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-192" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-192', 'get', 'link-76');">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="L818"></a><tt class="py-lineno"> 818</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="L819"></a><tt class="py-lineno"> 819</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="L820"></a><tt class="py-lineno"> 820</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="L821"></a><tt class="py-lineno"> 821</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="L822"></a><tt class="py-lineno"> 822</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="L823"></a><tt class="py-lineno"> 823</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="L824"></a><tt class="py-lineno"> 824</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="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"> <tt class="py-keyword">else</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">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="L827"></a><tt class="py-lineno"> 827</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-193" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-193', 'schema', 'link-42');">schema</a></tt><tt class="py-op">.</tt><tt id="link-194" 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-194', 'prettyPrintSchema', 'link-194');">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="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"> </tt>
+<a name="L829"></a><tt class="py-lineno"> 829</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="L830"></a><tt class="py-lineno"> 830</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="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> </tt>
+<a name="createNextMethod"></a><div id="createNextMethod-def"><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> <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="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates any _next methods for attaching to a Resource.</tt> </tt>
+<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"><tt class="py-docstring"> The _next methods allow for easy iteration through list() responses.</tt> </tt>
+<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
+<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-195" class="py-name"><a title="googleapiclient.discovery.fix_method_name" class="py-name" href="#" onclick="return doclink('link-195', 'fix_method_name', 'link-130');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
+<a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"> </tt>
+<a name="L843"></a><tt class="py-lineno"> 843</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="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieves the next page of results.</tt> </tt>
+<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"><tt class="py-docstring">Args:</tt> </tt>
+<a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"><tt class="py-docstring"> previous_request: The request for the previous page. (required)</tt> </tt>
+<a name="L848"></a><tt class="py-lineno"> 848</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="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"><tt class="py-docstring">Returns:</tt> </tt>
+<a name="L851"></a><tt class="py-lineno"> 851</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="L852"></a><tt class="py-lineno"> 852</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="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> <tt class="py-comment"># Retrieve nextPageToken from previous_response</tt> </tt>
+<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"> <tt class="py-comment"># Use as pageToken in previous_request to create new request.</tt> </tt>
+<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"> </tt>
+<a name="L857"></a><tt class="py-lineno"> 857</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-op">:</tt> </tt>
+<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
+<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"> </tt>
+<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"> <tt id="link-196" 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-193', 'request', 'link-60');">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="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-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="L862"></a><tt class="py-lineno"> 862</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-194" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-196', 'request', 'link-63');">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="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> </tt>
+<a name="L862"></a><tt class="py-lineno"> 862</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="L863"></a><tt class="py-lineno"> 863</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-197" 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-194', 'request', 'link-60');">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="L863"></a><tt class="py-lineno"> 863</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="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-comment"># Find and remove old 'pageToken' value from URI</tt> </tt>
-<a name="L866"></a><tt class="py-lineno"> 866</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="L867"></a><tt class="py-lineno"> 867</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="L868"></a><tt class="py-lineno"> 868</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="L869"></a><tt class="py-lineno"> 869</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="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 id="link-195" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-197', 'request', 'link-63');">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="L864"></a><tt class="py-lineno"> 864</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="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"> </tt>
+<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> <tt class="py-comment"># Find and remove old 'pageToken' value from URI</tt> </tt>
+<a name="L867"></a><tt class="py-lineno"> 867</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="L868"></a><tt class="py-lineno"> 868</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="L869"></a><tt class="py-lineno"> 869</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="L870"></a><tt class="py-lineno"> 870</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="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> </tt>
+<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> <tt id="link-198" 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-195', 'request', 'link-60');">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="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 id="link-196" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-196', 'logger', 'link-41');">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="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"> </tt>
-<a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-197" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-198', 'request', 'link-63');">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="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> </tt>
+<a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"> <tt id="link-199" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-199', '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="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"> </tt>
+<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-200" 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-197', 'request', 'link-60');">request</a></tt> </tt>
-</div><a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> </tt>
-<a name="L877"></a><tt class="py-lineno"> 877</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="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"> </tt>
-<a name="Resource"></a><div id="Resource-def"><a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"> </tt>
-<a name="L880"></a><tt class="py-lineno"> 880</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="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"> <tt class="py-docstring">"""A class for interacting with a resource."""</tt> </tt>
-<a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"> </tt>
-<a name="Resource.__init__"></a><div id="Resource.__init__-def"><a name="L883"></a><tt class="py-lineno"> 883</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="L884"></a><tt class="py-lineno"> 884</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="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> <tt class="py-docstring">"""Build a Resource from the API description.</tt> </tt>
-<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, Object to make http requests with.</tt> </tt>
-<a name="L889"></a><tt class="py-lineno"> 889</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="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"><tt class="py-docstring"> URI.</tt> </tt>
-<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"><tt class="py-docstring"> model: googleapiclient.Model, converts to and from the wire format.</tt> </tt>
-<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder: class or callable that instantiates an</tt> </tt>
-<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"><tt class="py-docstring"> googleapiclient.HttpRequest object.</tt> </tt>
-<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, key obtained from</tt> </tt>
-<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"><tt class="py-docstring"> https://code.google.com/apis/console</tt> </tt>
-<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"><tt class="py-docstring"> resourceDesc: object, section of deserialized discovery document that</tt> </tt>
-<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"><tt class="py-docstring"> describes a resource. Note that the top level discovery document</tt> </tt>
-<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"><tt class="py-docstring"> is considered a resource.</tt> </tt>
-<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"><tt class="py-docstring"> rootDesc: object, the entire deserialized discovery document.</tt> </tt>
-<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, mapping of schema names to schema descriptions.</tt> </tt>
-<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L902"></a><tt class="py-lineno"> 902</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="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"> </tt>
-<a name="L904"></a><tt class="py-lineno"> 904</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-198" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-198', 'http', 'link-21');">http</a></tt> </tt>
-<a name="L905"></a><tt class="py-lineno"> 905</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="L906"></a><tt class="py-lineno"> 906</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-199" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-199', 'model', 'link-30');">model</a></tt> </tt>
-<a name="L907"></a><tt class="py-lineno"> 907</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="L908"></a><tt class="py-lineno"> 908</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="L909"></a><tt class="py-lineno"> 909</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="L910"></a><tt class="py-lineno"> 910</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="L911"></a><tt class="py-lineno"> 911</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-200" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-200', 'schema', 'link-39');">schema</a></tt> </tt>
-<a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"> </tt>
-<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-201" 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-201', '_set_service_methods', 'link-201');">_set_service_methods</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> </tt>
-<a name="Resource._set_dynamic_attr"></a><div id="Resource._set_dynamic_attr-def"><a name="L915"></a><tt class="py-lineno"> 915</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="L916"></a><tt class="py-lineno"> 916</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="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"> attr_name: string; The name of the attribute to be set</tt> </tt>
-<a name="L920"></a><tt class="py-lineno"> 920</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="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-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="L923"></a><tt class="py-lineno"> 923</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="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"> </tt>
-<a name="Resource.__getstate__"></a><div id="Resource.__getstate__-def"><a name="L925"></a><tt class="py-lineno"> 925</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="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"> <tt class="py-docstring">"""Trim the state down to something that can be pickled.</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-docstring"> Uses the fact that the instance variable _dynamic_attrs holds attrs that</tt> </tt>
-<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"><tt class="py-docstring"> will be wiped and restored on pickle serialization.</tt> </tt>
-<a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L931"></a><tt class="py-lineno"> 931</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="L932"></a><tt class="py-lineno"> 932</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="L933"></a><tt class="py-lineno"> 933</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="L934"></a><tt class="py-lineno"> 934</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="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">state_dict</tt> </tt>
-</div><a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> </tt>
-<a name="Resource.__setstate__"></a><div id="Resource.__setstate__-def"><a name="L937"></a><tt class="py-lineno"> 937</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="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> <tt class="py-docstring">"""Reconstitute the state of the object from being pickled.</tt> </tt>
-<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L940"></a><tt class="py-lineno"> 940</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="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"><tt class="py-docstring"> will be wiped and restored on pickle serialization.</tt> </tt>
-<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L943"></a><tt class="py-lineno"> 943</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-202" class="py-name"><a title="googleapiclient.channel.Channel.update" class="py-name" href="#" onclick="return doclink('link-202', 'update', 'link-98');">update</a></tt><tt class="py-op">(</tt><tt class="py-name">state</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">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="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-203" class="py-name"><a title="googleapiclient.discovery.Resource._set_service_methods" class="py-name" href="#" onclick="return doclink('link-203', '_set_service_methods', 'link-201');">_set_service_methods</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"> </tt>
-<a name="Resource._set_service_methods"></a><div id="Resource._set_service_methods-def"><a name="L947"></a><tt class="py-lineno"> 947</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="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-204" 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-204', '_add_basic_methods', 'link-204');">_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="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-205" 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-205', '_add_nested_resources', 'link-205');">_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="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-206" 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-206', '_add_next_methods', 'link-206');">_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="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"> </tt>
-<a name="Resource._add_basic_methods"></a><div id="Resource._add_basic_methods-def"><a name="L952"></a><tt class="py-lineno"> 952</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="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"> <tt class="py-comment"># Add basic methods to Resource</tt> </tt>
-<a name="L954"></a><tt class="py-lineno"> 954</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="L955"></a><tt class="py-lineno"> 955</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="L956"></a><tt class="py-lineno"> 956</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-207" 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-207', 'createMethod', 'link-207');">createMethod</a></tt><tt class="py-op">(</tt> </tt>
-<a name="L957"></a><tt class="py-lineno"> 957</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-208" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-208', 'schema', 'link-39');">schema</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-209" 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-209', '_set_dynamic_attr', 'link-209');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
-<a name="L959"></a><tt class="py-lineno"> 959</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="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"> <tt class="py-comment"># Add in _media methods. The functionality of the attached method will</tt> </tt>
-<a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"> <tt class="py-comment"># change when it sees that the method name ends in _media.</tt> </tt>
-<a name="L962"></a><tt class="py-lineno"> 962</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-210" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-210', 'get', 'link-73');">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="L963"></a><tt class="py-lineno"> 963</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-211" class="py-name"><a title="googleapiclient.discovery.createMethod" class="py-name" href="#" onclick="return doclink('link-211', 'createMethod', 'link-207');">createMethod</a></tt><tt class="py-op">(</tt> </tt>
-<a name="L964"></a><tt class="py-lineno"> 964</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-212" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-212', 'schema', 'link-39');">schema</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-213" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-213', '_set_dynamic_attr', 'link-209');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
-<a name="L966"></a><tt class="py-lineno"> 966</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="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"> </tt>
-<a name="Resource._add_nested_resources"></a><div id="Resource._add_nested_resources-def"><a name="L968"></a><tt class="py-lineno"> 968</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="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"> <tt class="py-comment"># Add in nested resources</tt> </tt>
-<a name="L970"></a><tt class="py-lineno"> 970</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="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"> </tt>
-<a name="L972"></a><tt class="py-lineno"> 972</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="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a method on the Resource to access a nested Resource.</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-docstring"> Args:</tt> </tt>
-<a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
-<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"><tt class="py-docstring"> methodDesc: object, fragment of deserialized discovery document that</tt> </tt>
-<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"><tt class="py-docstring"> describes the method.</tt> </tt>
-<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-214" class="py-name"><a title="googleapiclient.discovery.fix_method_name" class="py-name" href="#" onclick="return doclink('link-214', 'fix_method_name', 'link-127');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
-<a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"> </tt>
-<a name="L982"></a><tt class="py-lineno"> 982</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="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-215" class="py-name"><a title="googleapiclient.discovery.Resource" class="py-name" href="#" onclick="return doclink('link-215', 'Resource', 'link-82');">Resource</a></tt><tt class="py-op">(</tt><tt id="link-216" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-216', '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="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt id="link-217" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-217', 'model', 'link-30');">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="L985"></a><tt class="py-lineno"> 985</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="L986"></a><tt class="py-lineno"> 986</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="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"> <tt id="link-218" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-218', 'schema', 'link-39');">schema</a></tt><tt class="py-op">=</tt><tt id="link-219" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-219', 'schema', 'link-39');">schema</a></tt><tt class="py-op">)</tt> </tt>
-</div><a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"> </tt>
-<a name="L989"></a><tt class="py-lineno"> 989</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="L990"></a><tt class="py-lineno"> 990</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="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"> </tt>
-<a name="L992"></a><tt class="py-lineno"> 992</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="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"> </tt>
-<a name="L994"></a><tt class="py-lineno"> 994</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="L995"></a><tt class="py-lineno"> 995</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="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-220" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-220', '_set_dynamic_attr', 'link-209');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
-<a name="L997"></a><tt class="py-lineno"> 997</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="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"> </tt>
-<a name="Resource._add_next_methods"></a><div id="Resource._add_next_methods-def"><a name="L999"></a><tt class="py-lineno"> 999</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="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"> <tt class="py-comment"># Add _next() methods</tt> </tt>
-<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"> <tt class="py-comment"># Look for response bodies in schema that contain nextPageToken, and methods</tt> </tt>
-<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"> <tt class="py-comment"># that take a pageToken parameter.</tt> </tt>
-<a name="L1003"></a><tt class="py-lineno">1003</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="L1004"></a><tt class="py-lineno">1004</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="L1005"></a><tt class="py-lineno">1005</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="L1006"></a><tt class="py-lineno">1006</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="L1007"></a><tt class="py-lineno">1007</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="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> <tt class="py-name">responseSchema</tt> <tt class="py-op">=</tt> <tt id="link-221" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-221', 'schema', 'link-39');">schema</a></tt><tt class="py-op">.</tt><tt id="link-222" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-222', 'get', 'link-73');">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="L1009"></a><tt class="py-lineno">1009</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-223" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-223', 'get', 'link-73');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'properties'</tt><tt class="py-op">,</tt> </tt>
-<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
-<a name="L1011"></a><tt class="py-lineno">1011</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-224" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-224', 'get', 'link-73');">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="L1012"></a><tt class="py-lineno">1012</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="L1013"></a><tt class="py-lineno">1013</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-225" 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-225', 'createNextMethod', 'link-225');">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="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-226" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-226', '_set_dynamic_attr', 'link-209');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
-<a name="L1015"></a><tt class="py-lineno">1015</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="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"> </tt><script type="text/javascript">
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-200', 'request', 'link-63');">request</a></tt> </tt>
+</div><a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"> </tt>
+<a name="L878"></a><tt class="py-lineno"> 878</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="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"> </tt>
+<a name="Resource"></a><div id="Resource-def"><a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"> </tt>
+<a name="L881"></a><tt class="py-lineno"> 881</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="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"> <tt class="py-docstring">"""A class for interacting with a resource."""</tt> </tt>
+<a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"> </tt>
+<a name="Resource.__init__"></a><div id="Resource.__init__-def"><a name="L884"></a><tt class="py-lineno"> 884</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="L885"></a><tt class="py-lineno"> 885</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="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> <tt class="py-docstring">"""Build a Resource from the API description.</tt> </tt>
+<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, Object to make http requests with.</tt> </tt>
+<a name="L890"></a><tt class="py-lineno"> 890</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="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"><tt class="py-docstring"> URI.</tt> </tt>
+<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"><tt class="py-docstring"> model: googleapiclient.Model, converts to and from the wire format.</tt> </tt>
+<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder: class or callable that instantiates an</tt> </tt>
+<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"><tt class="py-docstring"> googleapiclient.HttpRequest object.</tt> </tt>
+<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, key obtained from</tt> </tt>
+<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"><tt class="py-docstring"> https://code.google.com/apis/console</tt> </tt>
+<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"><tt class="py-docstring"> resourceDesc: object, section of deserialized discovery document that</tt> </tt>
+<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"><tt class="py-docstring"> describes a resource. Note that the top level discovery document</tt> </tt>
+<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"><tt class="py-docstring"> is considered a resource.</tt> </tt>
+<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"><tt class="py-docstring"> rootDesc: object, the entire deserialized discovery document.</tt> </tt>
+<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, mapping of schema names to schema descriptions.</tt> </tt>
+<a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L903"></a><tt class="py-lineno"> 903</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="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"> </tt>
+<a name="L905"></a><tt class="py-lineno"> 905</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-201" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-201', 'http', 'link-21');">http</a></tt> </tt>
+<a name="L906"></a><tt class="py-lineno"> 906</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="L907"></a><tt class="py-lineno"> 907</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-202" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-202', 'model', 'link-33');">model</a></tt> </tt>
+<a name="L908"></a><tt class="py-lineno"> 908</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="L909"></a><tt class="py-lineno"> 909</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="L910"></a><tt class="py-lineno"> 910</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="L911"></a><tt class="py-lineno"> 911</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="L912"></a><tt class="py-lineno"> 912</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-203" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-203', 'schema', 'link-42');">schema</a></tt> </tt>
+<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"> </tt>
+<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-204" 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-204', '_set_service_methods', 'link-204');">_set_service_methods</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"> </tt>
+<a name="Resource._set_dynamic_attr"></a><div id="Resource._set_dynamic_attr-def"><a name="L916"></a><tt class="py-lineno"> 916</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="L917"></a><tt class="py-lineno"> 917</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="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"><tt class="py-docstring"> attr_name: string; The name of the attribute to be set</tt> </tt>
+<a name="L921"></a><tt class="py-lineno"> 921</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="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L923"></a><tt class="py-lineno"> 923</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="L924"></a><tt class="py-lineno"> 924</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="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"> </tt>
+<a name="Resource.__getstate__"></a><div id="Resource.__getstate__-def"><a name="L926"></a><tt class="py-lineno"> 926</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="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"> <tt class="py-docstring">"""Trim the state down to something that can be pickled.</tt> </tt>
+<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L929"></a><tt class="py-lineno"> 929</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="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"><tt class="py-docstring"> will be wiped and restored on pickle serialization.</tt> </tt>
+<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L932"></a><tt class="py-lineno"> 932</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="L933"></a><tt class="py-lineno"> 933</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="L934"></a><tt class="py-lineno"> 934</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="L935"></a><tt class="py-lineno"> 935</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="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">state_dict</tt> </tt>
+</div><a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"> </tt>
+<a name="Resource.__setstate__"></a><div id="Resource.__setstate__-def"><a name="L938"></a><tt class="py-lineno"> 938</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="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"> <tt class="py-docstring">"""Reconstitute the state of the object from being pickled.</tt> </tt>
+<a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L941"></a><tt class="py-lineno"> 941</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="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"><tt class="py-docstring"> will be wiped and restored on pickle serialization.</tt> </tt>
+<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L944"></a><tt class="py-lineno"> 944</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-205" class="py-name"><a title="googleapiclient.channel.Channel.update" class="py-name" href="#" onclick="return doclink('link-205', 'update', 'link-101');">update</a></tt><tt class="py-op">(</tt><tt class="py-name">state</tt><tt class="py-op">)</tt> </tt>
+<a name="L945"></a><tt class="py-lineno"> 945</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="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-206" class="py-name"><a title="googleapiclient.discovery.Resource._set_service_methods" class="py-name" href="#" onclick="return doclink('link-206', '_set_service_methods', 'link-204');">_set_service_methods</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"> </tt>
+<a name="Resource._set_service_methods"></a><div id="Resource._set_service_methods-def"><a name="L948"></a><tt class="py-lineno"> 948</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="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-207" 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-207', '_add_basic_methods', 'link-207');">_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="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-208" 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-208', '_add_nested_resources', 'link-208');">_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="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-209" 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-209', '_add_next_methods', 'link-209');">_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="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"> </tt>
+<a name="Resource._add_basic_methods"></a><div id="Resource._add_basic_methods-def"><a name="L953"></a><tt class="py-lineno"> 953</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="L954"></a><tt class="py-lineno"> 954</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="L955"></a><tt class="py-lineno"> 955</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="L956"></a><tt class="py-lineno"> 956</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="L957"></a><tt class="py-lineno"> 957</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-210" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-210', 'get', 'link-76');">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="L958"></a><tt class="py-lineno"> 958</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="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a BatchHttpRequest object based on the discovery document.</tt> </tt>
+<a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L962"></a><tt class="py-lineno"> 962</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="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"><tt class="py-docstring"> form callback(id, response, exception). The first parameter is the</tt> </tt>
+<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"><tt class="py-docstring"> request id, and the second is the deserialized response object. The</tt> </tt>
+<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"><tt class="py-docstring"> third is an apiclient.errors.HttpError exception object if an HTTP</tt> </tt>
+<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"><tt class="py-docstring"> error occurred while processing the request, or None if no error</tt> </tt>
+<a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"><tt class="py-docstring"> occurred.</tt> </tt>
+<a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"><tt class="py-docstring"> A BatchHttpRequest object based on the discovery document.</tt> </tt>
+<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-211" class="py-name"><a title="googleapiclient.http.BatchHttpRequest" class="py-name" href="#" onclick="return doclink('link-211', '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="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-212" 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-212', '_set_dynamic_attr', 'link-212');">_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="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"> </tt>
+<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"> <tt class="py-comment"># Add basic methods to Resource</tt> </tt>
+<a name="L976"></a><tt class="py-lineno"> 976</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="L977"></a><tt class="py-lineno"> 977</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="L978"></a><tt class="py-lineno"> 978</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-213" 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-213', 'createMethod', 'link-213');">createMethod</a></tt><tt class="py-op">(</tt> </tt>
+<a name="L979"></a><tt class="py-lineno"> 979</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-214" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-214', 'schema', 'link-42');">schema</a></tt><tt class="py-op">)</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 id="link-215" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-215', '_set_dynamic_attr', 'link-212');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
+<a name="L981"></a><tt class="py-lineno"> 981</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="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"> <tt class="py-comment"># Add in _media methods. The functionality of the attached method will</tt> </tt>
+<a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> <tt class="py-comment"># change when it sees that the method name ends in _media.</tt> </tt>
+<a name="L984"></a><tt class="py-lineno"> 984</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-216" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-216', 'get', 'link-76');">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="L985"></a><tt class="py-lineno"> 985</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-217" class="py-name"><a title="googleapiclient.discovery.createMethod" class="py-name" href="#" onclick="return doclink('link-217', 'createMethod', 'link-213');">createMethod</a></tt><tt class="py-op">(</tt> </tt>
+<a name="L986"></a><tt class="py-lineno"> 986</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-218" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-218', 'schema', 'link-42');">schema</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-219" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-219', '_set_dynamic_attr', 'link-212');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
+<a name="L988"></a><tt class="py-lineno"> 988</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="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"> </tt>
+<a name="Resource._add_nested_resources"></a><div id="Resource._add_nested_resources-def"><a name="L990"></a><tt class="py-lineno"> 990</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="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"> <tt class="py-comment"># Add in nested resources</tt> </tt>
+<a name="L992"></a><tt class="py-lineno"> 992</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="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"> </tt>
+<a name="L994"></a><tt class="py-lineno"> 994</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="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a method on the Resource to access a nested Resource.</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-docstring"> Args:</tt> </tt>
+<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
+<a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"><tt class="py-docstring"> methodDesc: object, fragment of deserialized discovery document that</tt> </tt>
+<a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"><tt class="py-docstring"> describes the method.</tt> </tt>
+<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-220" class="py-name"><a title="googleapiclient.discovery.fix_method_name" class="py-name" href="#" onclick="return doclink('link-220', 'fix_method_name', 'link-130');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
+<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"> </tt>
+<a name="L1004"></a><tt class="py-lineno">1004</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="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-221" class="py-name"><a title="googleapiclient.discovery.Resource" class="py-name" href="#" onclick="return doclink('link-221', 'Resource', 'link-85');">Resource</a></tt><tt class="py-op">(</tt><tt id="link-222" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-222', '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="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt id="link-223" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-223', '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="L1007"></a><tt class="py-lineno">1007</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="L1008"></a><tt class="py-lineno">1008</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="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"> <tt id="link-224" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-224', 'schema', 'link-42');">schema</a></tt><tt class="py-op">=</tt><tt id="link-225" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-225', 'schema', 'link-42');">schema</a></tt><tt class="py-op">)</tt> </tt>
+</div><a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"> </tt>
+<a name="L1011"></a><tt class="py-lineno">1011</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="L1012"></a><tt class="py-lineno">1012</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="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"> </tt>
+<a name="L1014"></a><tt class="py-lineno">1014</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="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"> </tt>
+<a name="L1016"></a><tt class="py-lineno">1016</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="L1017"></a><tt class="py-lineno">1017</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="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-226" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-226', '_set_dynamic_attr', 'link-212');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</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">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="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"> </tt>
+<a name="Resource._add_next_methods"></a><div id="Resource._add_next_methods-def"><a name="L1021"></a><tt class="py-lineno">1021</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="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"> <tt class="py-comment"># Add _next() methods</tt> </tt>
+<a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"> <tt class="py-comment"># Look for response bodies in schema that contain nextPageToken, and methods</tt> </tt>
+<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"> <tt class="py-comment"># that take a pageToken parameter.</tt> </tt>
+<a name="L1025"></a><tt class="py-lineno">1025</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="L1026"></a><tt class="py-lineno">1026</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="L1027"></a><tt class="py-lineno">1027</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="L1028"></a><tt class="py-lineno">1028</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="L1029"></a><tt class="py-lineno">1029</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="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"> <tt class="py-name">responseSchema</tt> <tt class="py-op">=</tt> <tt id="link-227" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-227', 'schema', 'link-42');">schema</a></tt><tt class="py-op">.</tt><tt id="link-228" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-228', 'get', 'link-76');">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="L1031"></a><tt class="py-lineno">1031</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-229" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-229', 'get', 'link-76');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'properties'</tt><tt class="py-op">,</tt> </tt>
+<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"> <tt class="py-op">{</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-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-230" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-230', 'get', 'link-76');">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="L1034"></a><tt class="py-lineno">1034</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="L1035"></a><tt class="py-lineno">1035</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-231" 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-231', 'createNextMethod', 'link-231');">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="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-232" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-232', '_set_dynamic_attr', 'link-212');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
+<a name="L1037"></a><tt class="py-lineno">1037</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="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
@@ -1162,7 +1184,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 0eba8cc..a62be1e 100644
--- a/docs/epy/googleapiclient.discovery.Resource-class.html
+++ b/docs/epy/googleapiclient.discovery.Resource-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 9a8ca36..713ff1a 100644
--- a/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html
+++ b/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 c2b0497..89b1f69 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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 abb878c..adeb58b 100644
--- a/docs/epy/googleapiclient.errors-pysrc.html
+++ b/docs/epy/googleapiclient.errors-pysrc.html
@@ -95,98 +95,100 @@
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt class="py-name">positional</tt><tt class="py-op">(</tt><tt class="py-number">3</tt><tt class="py-op">)</tt> </tt>
<a name="HttpError.__init__"></a><div id="HttpError.__init__-def"><a name="L38"></a><tt class="py-lineno"> 38</tt> <a class="py-toggle" href="#" id="HttpError.__init__-toggle" onclick="return toggle('HttpError.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.HttpError-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">resp</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">,</tt> <tt class="py-param">uri</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="HttpError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="HttpError.__init__-expanded"><a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-name">resp</tt> </tt>
-<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">content</tt> </tt>
-<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">uri</tt> </tt>
-</div><a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> </tt>
-<a name="HttpError._get_reason"></a><div id="HttpError._get_reason-def"><a name="L43"></a><tt class="py-lineno"> 43</tt> <a class="py-toggle" href="#" id="HttpError._get_reason-toggle" onclick="return toggle('HttpError._get_reason');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.HttpError-class.html#_get_reason">_get_reason</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="HttpError._get_reason-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="HttpError._get_reason-expanded"><a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> <tt class="py-docstring">"""Calculate the reason for the error from the response content."""</tt> </tt>
-<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> <tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> </tt>
-<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> <tt class="py-name">data</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">self</tt><tt class="py-op">.</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
-<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> <tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'error'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">'message'</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">except</tt> <tt class="py-op">(</tt><tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-name">KeyError</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">pass</tt> </tt>
-<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">reason</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"> <tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
-<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">reason</tt> </tt>
-</div><a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> </tt>
-<a name="HttpError.__repr__"></a><div id="HttpError.__repr__-def"><a name="L55"></a><tt class="py-lineno"> 55</tt> <a class="py-toggle" href="#" id="HttpError.__repr__-toggle" onclick="return toggle('HttpError.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.HttpError-class.html#__repr__">__repr__</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="HttpError.__repr__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="HttpError.__repr__-expanded"><a name="L56"></a><tt class="py-lineno"> 56</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">uri</tt><tt class="py-op">:</tt> </tt>
-<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<HttpError %s when requesting %s returned "%s">'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
-<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"> <tt class="py-name">self</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">self</tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Method googleapiclient.errors.HttpError._get_reason()=googleapiclient.errors.HttpError-class.html#_get_reason"><a title="googleapiclient.errors.HttpError._get_reason" class="py-name" href="#" onclick="return doclink('link-0', '_get_reason', 'link-0');">_get_reason</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> <tt class="py-keyword">else</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">return</tt> <tt class="py-string">'<HttpError %s "%s">'</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">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name"><a title="googleapiclient.errors.HttpError._get_reason" class="py-name" href="#" onclick="return doclink('link-1', '_get_reason', 'link-0');">_get_reason</a></tt><tt class="py-op">(</tt><tt class="py-op">)</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 class="py-name">__str__</tt> <tt class="py-op">=</tt> <tt id="link-2" class="py-name" targets="Method googleapiclient.errors.BatchError.__repr__()=googleapiclient.errors.BatchError-class.html#__repr__,Method googleapiclient.errors.HttpError.__repr__()=googleapiclient.errors.HttpError-class.html#__repr__"><a title="googleapiclient.errors.BatchError.__repr__
-googleapiclient.errors.HttpError.__repr__" class="py-name" href="#" onclick="return doclink('link-2', '__repr__', 'link-2');">__repr__</a></tt> </tt>
+<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">bytes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L41"></a><tt class="py-lineno"> 41</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">"HTTP content should be bytes"</tt><tt class="py-op">)</tt> </tt>
+<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">content</tt> </tt>
+<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">uri</tt> </tt>
+</div><a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> </tt>
+<a name="HttpError._get_reason"></a><div id="HttpError._get_reason-def"><a name="L45"></a><tt class="py-lineno"> 45</tt> <a class="py-toggle" href="#" id="HttpError._get_reason-toggle" onclick="return toggle('HttpError._get_reason');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.HttpError-class.html#_get_reason">_get_reason</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="HttpError._get_reason-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="HttpError._get_reason-expanded"><a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> <tt class="py-docstring">"""Calculate the reason for the error from the response content."""</tt> </tt>
+<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> <tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> </tt>
+<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-name">data</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">self</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 class="py-op">)</tt> </tt>
+<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> <tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'error'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">'message'</tt><tt class="py-op">]</tt> </tt>
+<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-op">(</tt><tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-name">KeyError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">reason</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
+<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">reason</tt> </tt>
+</div><a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> </tt>
+<a name="HttpError.__repr__"></a><div id="HttpError.__repr__-def"><a name="L57"></a><tt class="py-lineno"> 57</tt> <a class="py-toggle" href="#" id="HttpError.__repr__-toggle" onclick="return toggle('HttpError.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.HttpError-class.html#__repr__">__repr__</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="HttpError.__repr__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="HttpError.__repr__-expanded"><a name="L58"></a><tt class="py-lineno"> 58</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">uri</tt><tt class="py-op">:</tt> </tt>
+<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<HttpError %s when requesting %s returned "%s">'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
+<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> <tt class="py-name">self</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">self</tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Method googleapiclient.errors.HttpError._get_reason()=googleapiclient.errors.HttpError-class.html#_get_reason"><a title="googleapiclient.errors.HttpError._get_reason" class="py-name" href="#" onclick="return doclink('link-0', '_get_reason', 'link-0');">_get_reason</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> <tt class="py-keyword">else</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">return</tt> <tt class="py-string">'<HttpError %s "%s">'</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">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name"><a title="googleapiclient.errors.HttpError._get_reason" class="py-name" href="#" onclick="return doclink('link-1', '_get_reason', 'link-0');">_get_reason</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> </tt>
-<a name="InvalidJsonError"></a><div id="InvalidJsonError-def"><a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> </tt>
-<a name="L65"></a><tt class="py-lineno"> 65</tt> <a class="py-toggle" href="#" id="InvalidJsonError-toggle" onclick="return toggle('InvalidJsonError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.InvalidJsonError-class.html">InvalidJsonError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="InvalidJsonError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidJsonError-expanded"><a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> <tt class="py-docstring">"""The JSON returned could not be parsed."""</tt> </tt>
-<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
-</div><a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> </tt>
-<a name="UnknownFileType"></a><div id="UnknownFileType-def"><a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> </tt>
-<a name="L70"></a><tt class="py-lineno"> 70</tt> <a class="py-toggle" href="#" id="UnknownFileType-toggle" onclick="return toggle('UnknownFileType');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnknownFileType-class.html">UnknownFileType</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="UnknownFileType-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnknownFileType-expanded"><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-docstring">"""File type unknown or unexpected."""</tt> </tt>
-<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
-</div><a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> </tt>
-<a name="UnknownLinkType"></a><div id="UnknownLinkType-def"><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> <a class="py-toggle" href="#" id="UnknownLinkType-toggle" onclick="return toggle('UnknownLinkType');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnknownLinkType-class.html">UnknownLinkType</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="UnknownLinkType-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnknownLinkType-expanded"><a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-docstring">"""Link type unknown or unexpected."""</tt> </tt>
-<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
-</div><a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> </tt>
-<a name="UnknownApiNameOrVersion"></a><div id="UnknownApiNameOrVersion-def"><a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> </tt>
-<a name="L80"></a><tt class="py-lineno"> 80</tt> <a class="py-toggle" href="#" id="UnknownApiNameOrVersion-toggle" onclick="return toggle('UnknownApiNameOrVersion');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnknownApiNameOrVersion-class.html">UnknownApiNameOrVersion</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="UnknownApiNameOrVersion-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnknownApiNameOrVersion-expanded"><a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-docstring">"""No API with that name and version exists."""</tt> </tt>
-<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
-</div><a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> </tt>
-<a name="UnacceptableMimeTypeError"></a><div id="UnacceptableMimeTypeError-def"><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> <a class="py-toggle" href="#" id="UnacceptableMimeTypeError-toggle" onclick="return toggle('UnacceptableMimeTypeError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnacceptableMimeTypeError-class.html">UnacceptableMimeTypeError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="UnacceptableMimeTypeError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnacceptableMimeTypeError-expanded"><a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <tt class="py-docstring">"""That is an unacceptable mimetype for this operation."""</tt> </tt>
-<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
-</div><a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> </tt>
-<a name="MediaUploadSizeError"></a><div id="MediaUploadSizeError-def"><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> <a class="py-toggle" href="#" id="MediaUploadSizeError-toggle" onclick="return toggle('MediaUploadSizeError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.MediaUploadSizeError-class.html">MediaUploadSizeError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="MediaUploadSizeError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="MediaUploadSizeError-expanded"><a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-docstring">"""Media is larger than the method can accept."""</tt> </tt>
-<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
-</div><a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> </tt>
-<a name="ResumableUploadError"></a><div id="ResumableUploadError-def"><a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> </tt>
-<a name="L95"></a><tt class="py-lineno"> 95</tt> <a class="py-toggle" href="#" id="ResumableUploadError-toggle" onclick="return toggle('ResumableUploadError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.ResumableUploadError-class.html">ResumableUploadError</a><tt class="py-op">(</tt><tt class="py-base-class">HttpError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="ResumableUploadError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ResumableUploadError-expanded"><a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-docstring">"""Error occured during resumable upload."""</tt> </tt>
-<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
-</div><a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> </tt>
-<a name="InvalidChunkSizeError"></a><div id="InvalidChunkSizeError-def"><a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> </tt>
-<a name="L100"></a><tt class="py-lineno">100</tt> <a class="py-toggle" href="#" id="InvalidChunkSizeError-toggle" onclick="return toggle('InvalidChunkSizeError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.InvalidChunkSizeError-class.html">InvalidChunkSizeError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="InvalidChunkSizeError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidChunkSizeError-expanded"><a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-docstring">"""The given chunksize is not valid."""</tt> </tt>
-<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
-</div><a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> </tt>
-<a name="InvalidNotificationError"></a><div id="InvalidNotificationError-def"><a name="L104"></a><tt class="py-lineno">104</tt> <a class="py-toggle" href="#" id="InvalidNotificationError-toggle" onclick="return toggle('InvalidNotificationError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.InvalidNotificationError-class.html">InvalidNotificationError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="InvalidNotificationError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidNotificationError-expanded"><a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-docstring">"""The channel Notification is invalid."""</tt> </tt>
-<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
-</div><a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> </tt>
-<a name="BatchError"></a><div id="BatchError-def"><a name="L108"></a><tt class="py-lineno">108</tt> <a class="py-toggle" href="#" id="BatchError-toggle" onclick="return toggle('BatchError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.BatchError-class.html">BatchError</a><tt class="py-op">(</tt><tt class="py-base-class">HttpError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="BatchError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="BatchError-expanded"><a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-docstring">"""Error occured during batch operations."""</tt> </tt>
-<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> </tt>
-<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt class="py-name">positional</tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
-<a name="BatchError.__init__"></a><div id="BatchError.__init__-def"><a name="L112"></a><tt class="py-lineno">112</tt> <a class="py-toggle" href="#" id="BatchError.__init__-toggle" onclick="return toggle('BatchError.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.BatchError-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">reason</tt><tt class="py-op">,</tt> <tt class="py-param">resp</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">content</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="BatchError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="BatchError.__init__-expanded"><a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-name">resp</tt> </tt>
-<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">content</tt> </tt>
-<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">reason</tt> </tt>
-</div><a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> </tt>
-<a name="BatchError.__repr__"></a><div id="BatchError.__repr__-def"><a name="L117"></a><tt class="py-lineno">117</tt> <a class="py-toggle" href="#" id="BatchError.__repr__-toggle" onclick="return toggle('BatchError.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.BatchError-class.html#__repr__">__repr__</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="BatchError.__repr__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="BatchError.__repr__-expanded"><a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<BatchError %s "%s">'</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">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt><tt class="py-op">)</tt> </tt>
-</div><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-name">__str__</tt> <tt class="py-op">=</tt> <tt id="link-3" class="py-name"><a title="googleapiclient.errors.BatchError.__repr__
-googleapiclient.errors.HttpError.__repr__" class="py-name" href="#" onclick="return doclink('link-3', '__repr__', 'link-2');">__repr__</a></tt> </tt>
+<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-name">__str__</tt> <tt class="py-op">=</tt> <tt id="link-2" class="py-name" targets="Method googleapiclient.errors.BatchError.__repr__()=googleapiclient.errors.BatchError-class.html#__repr__,Method googleapiclient.errors.HttpError.__repr__()=googleapiclient.errors.HttpError-class.html#__repr__"><a title="googleapiclient.errors.BatchError.__repr__
+googleapiclient.errors.HttpError.__repr__" class="py-name" href="#" onclick="return doclink('link-2', '__repr__', 'link-2');">__repr__</a></tt> </tt>
+</div><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> </tt>
+<a name="InvalidJsonError"></a><div id="InvalidJsonError-def"><a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> </tt>
+<a name="L67"></a><tt class="py-lineno"> 67</tt> <a class="py-toggle" href="#" id="InvalidJsonError-toggle" onclick="return toggle('InvalidJsonError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.InvalidJsonError-class.html">InvalidJsonError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="InvalidJsonError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidJsonError-expanded"><a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-docstring">"""The JSON returned could not be parsed."""</tt> </tt>
+<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+</div><a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> </tt>
+<a name="UnknownFileType"></a><div id="UnknownFileType-def"><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> </tt>
+<a name="L72"></a><tt class="py-lineno"> 72</tt> <a class="py-toggle" href="#" id="UnknownFileType-toggle" onclick="return toggle('UnknownFileType');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnknownFileType-class.html">UnknownFileType</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="UnknownFileType-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnknownFileType-expanded"><a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-docstring">"""File type unknown or unexpected."""</tt> </tt>
+<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+</div><a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> </tt>
+<a name="UnknownLinkType"></a><div id="UnknownLinkType-def"><a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> </tt>
+<a name="L77"></a><tt class="py-lineno"> 77</tt> <a class="py-toggle" href="#" id="UnknownLinkType-toggle" onclick="return toggle('UnknownLinkType');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnknownLinkType-class.html">UnknownLinkType</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="UnknownLinkType-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnknownLinkType-expanded"><a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-docstring">"""Link type unknown or unexpected."""</tt> </tt>
+<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+</div><a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> </tt>
+<a name="UnknownApiNameOrVersion"></a><div id="UnknownApiNameOrVersion-def"><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> <a class="py-toggle" href="#" id="UnknownApiNameOrVersion-toggle" onclick="return toggle('UnknownApiNameOrVersion');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnknownApiNameOrVersion-class.html">UnknownApiNameOrVersion</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="UnknownApiNameOrVersion-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnknownApiNameOrVersion-expanded"><a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-docstring">"""No API with that name and version exists."""</tt> </tt>
+<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+</div><a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> </tt>
+<a name="UnacceptableMimeTypeError"></a><div id="UnacceptableMimeTypeError-def"><a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> </tt>
+<a name="L87"></a><tt class="py-lineno"> 87</tt> <a class="py-toggle" href="#" id="UnacceptableMimeTypeError-toggle" onclick="return toggle('UnacceptableMimeTypeError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnacceptableMimeTypeError-class.html">UnacceptableMimeTypeError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="UnacceptableMimeTypeError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnacceptableMimeTypeError-expanded"><a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-docstring">"""That is an unacceptable mimetype for this operation."""</tt> </tt>
+<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+</div><a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> </tt>
+<a name="MediaUploadSizeError"></a><div id="MediaUploadSizeError-def"><a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> </tt>
+<a name="L92"></a><tt class="py-lineno"> 92</tt> <a class="py-toggle" href="#" id="MediaUploadSizeError-toggle" onclick="return toggle('MediaUploadSizeError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.MediaUploadSizeError-class.html">MediaUploadSizeError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="MediaUploadSizeError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="MediaUploadSizeError-expanded"><a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-docstring">"""Media is larger than the method can accept."""</tt> </tt>
+<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+</div><a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> </tt>
+<a name="ResumableUploadError"></a><div id="ResumableUploadError-def"><a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> </tt>
+<a name="L97"></a><tt class="py-lineno"> 97</tt> <a class="py-toggle" href="#" id="ResumableUploadError-toggle" onclick="return toggle('ResumableUploadError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.ResumableUploadError-class.html">ResumableUploadError</a><tt class="py-op">(</tt><tt class="py-base-class">HttpError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="ResumableUploadError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ResumableUploadError-expanded"><a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-docstring">"""Error occured during resumable upload."""</tt> </tt>
+<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+</div><a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> </tt>
+<a name="InvalidChunkSizeError"></a><div id="InvalidChunkSizeError-def"><a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> </tt>
+<a name="L102"></a><tt class="py-lineno">102</tt> <a class="py-toggle" href="#" id="InvalidChunkSizeError-toggle" onclick="return toggle('InvalidChunkSizeError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.InvalidChunkSizeError-class.html">InvalidChunkSizeError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="InvalidChunkSizeError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidChunkSizeError-expanded"><a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt class="py-docstring">"""The given chunksize is not valid."""</tt> </tt>
+<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+</div><a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> </tt>
+<a name="InvalidNotificationError"></a><div id="InvalidNotificationError-def"><a name="L106"></a><tt class="py-lineno">106</tt> <a class="py-toggle" href="#" id="InvalidNotificationError-toggle" onclick="return toggle('InvalidNotificationError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.InvalidNotificationError-class.html">InvalidNotificationError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="InvalidNotificationError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidNotificationError-expanded"><a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt class="py-docstring">"""The channel Notification is invalid."""</tt> </tt>
+<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+</div><a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> </tt>
+<a name="BatchError"></a><div id="BatchError-def"><a name="L110"></a><tt class="py-lineno">110</tt> <a class="py-toggle" href="#" id="BatchError-toggle" onclick="return toggle('BatchError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.BatchError-class.html">BatchError</a><tt class="py-op">(</tt><tt class="py-base-class">HttpError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="BatchError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="BatchError-expanded"><a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> <tt class="py-docstring">"""Error occured during batch operations."""</tt> </tt>
+<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> </tt>
+<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt class="py-name">positional</tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
+<a name="BatchError.__init__"></a><div id="BatchError.__init__-def"><a name="L114"></a><tt class="py-lineno">114</tt> <a class="py-toggle" href="#" id="BatchError.__init__-toggle" onclick="return toggle('BatchError.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.BatchError-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">reason</tt><tt class="py-op">,</tt> <tt class="py-param">resp</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">content</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="BatchError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="BatchError.__init__-expanded"><a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-name">resp</tt> </tt>
+<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">content</tt> </tt>
+<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">reason</tt> </tt>
+</div><a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> </tt>
+<a name="BatchError.__repr__"></a><div id="BatchError.__repr__-def"><a name="L119"></a><tt class="py-lineno">119</tt> <a class="py-toggle" href="#" id="BatchError.__repr__-toggle" onclick="return toggle('BatchError.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.BatchError-class.html#__repr__">__repr__</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="BatchError.__repr__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="BatchError.__repr__-expanded"><a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<BatchError %s "%s">'</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">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt><tt class="py-op">)</tt> </tt>
</div><a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> </tt>
-<a name="UnexpectedMethodError"></a><div id="UnexpectedMethodError-def"><a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> </tt>
-<a name="L123"></a><tt class="py-lineno">123</tt> <a class="py-toggle" href="#" id="UnexpectedMethodError-toggle" onclick="return toggle('UnexpectedMethodError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnexpectedMethodError-class.html">UnexpectedMethodError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="UnexpectedMethodError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnexpectedMethodError-expanded"><a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt class="py-docstring">"""Exception raised by RequestMockBuilder on unexpected calls."""</tt> </tt>
-<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> </tt>
-<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt class="py-name">positional</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
-<a name="UnexpectedMethodError.__init__"></a><div id="UnexpectedMethodError.__init__-def"><a name="L127"></a><tt class="py-lineno">127</tt> <a class="py-toggle" href="#" id="UnexpectedMethodError.__init__-toggle" onclick="return toggle('UnexpectedMethodError.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.UnexpectedMethodError-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">methodId</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="UnexpectedMethodError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="UnexpectedMethodError.__init__-expanded"><a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for an UnexpectedMethodError."""</tt> </tt>
-<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-4" class="py-name" targets="Class googleapiclient.errors.UnexpectedMethodError=googleapiclient.errors.UnexpectedMethodError-class.html"><a title="googleapiclient.errors.UnexpectedMethodError" class="py-name" href="#" onclick="return doclink('link-4', 'UnexpectedMethodError', 'link-4');">UnexpectedMethodError</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method googleapiclient.channel.Channel.__init__()=googleapiclient.channel.Channel-class.html#__init__,Method googleapiclient.channel.Notification.__init__()=googleapiclient.channel.Notification-class.html#__init__,Method googleapiclient.discovery.Resource.__init__()=googleapiclient.discovery.Resource-class.html#__init__,Method googleapiclient.discovery.ResourceMethodParameters.__init__()=googleapiclient.discovery.ResourceMethodParameters-class.html#__init__,Method googleapiclient.errors.BatchError.__init__()=googleapiclient.errors.BatchError-class.html#__init__,Method googleapiclient.errors.HttpError.__init__()=googleapiclient.errors.HttpError-class.html#__init__,Method googleapiclient.errors.UnexpectedBodyError.__init__()=googleapiclient.errors.UnexpectedBodyError-class.html#__init__,Method googleapiclient.errors.UnexpectedMethodError.__init__()=googleapiclient.errors.UnexpectedMethodError-class.html#__init__,Method googleapiclient.http.BatchHttpRequest.__init__()=googleapiclient.http.BatchHttpRequest-class.html#__init__,Method googleapiclient.http.HttpMock.__init__()=googleapiclient.http.HttpMock-class.html#__init__,Method googleapiclient.http.HttpMockSequence.__init__()=googleapiclient.http.HttpMockSequence-class.html#__init__,Method googleapiclient.http.HttpRequest.__init__()=googleapiclient.http.HttpRequest-class.html#__init__,Method googleapiclient.http.HttpRequestMock.__init__()=googleapiclient.http.HttpRequestMock-class.html#__init__,Method googleapiclient.http.MediaDownloadProgress.__init__()=googleapiclient.http.MediaDownloadProgress-class.html#__init__,Method googleapiclient.http.MediaFileUpload.__init__()=googleapiclient.http.MediaFileUpload-class.html#__init__,Method googleapiclient.http.MediaInMemoryUpload.__init__()=googleapiclient.http.MediaInMemoryUpload-class.html#__init__,Method googleapiclient.http.MediaIoBaseDownload.__init__()=googleapiclient.http.MediaIoBaseDownload-class.html#__init__,Method googleapiclient.http.MediaIoBaseUpload.__init__()=googleapiclient.http.MediaIoBaseUpload-class.html#__init__,Method googleapiclient.http.MediaUploadProgress.__init__()=googleapiclient.http.MediaUploadProgress-class.html#__init__,Method googleapiclient.http.RequestMockBuilder.__init__()=googleapiclient.http.RequestMockBuilder-class.html#__init__,Method googleapiclient.http._StreamSlice.__init__()=googleapiclient.http._StreamSlice-class.html#__init__,Method googleapiclient.model.JsonModel.__init__()=googleapiclient.model.JsonModel-class.html#__init__,Method googleapiclient.model.ProtocolBufferModel.__init__()=googleapiclient.model.ProtocolBufferModel-class.html#__init__,Method googleapiclient.schema.Schemas.__init__()=googleapiclient.schema.Schemas-class.html#__init__,Method googleapiclient.schema._SchemaToStruct.__init__()=googleapiclient.schema._SchemaToStruct-class.html#__init__"><a title="googleapiclient.channel.Channel.__init__
+<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-name">__str__</tt> <tt class="py-op">=</tt> <tt id="link-3" class="py-name"><a title="googleapiclient.errors.BatchError.__repr__
+googleapiclient.errors.HttpError.__repr__" class="py-name" href="#" onclick="return doclink('link-3', '__repr__', 'link-2');">__repr__</a></tt> </tt>
+</div><a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> </tt>
+<a name="UnexpectedMethodError"></a><div id="UnexpectedMethodError-def"><a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> </tt>
+<a name="L125"></a><tt class="py-lineno">125</tt> <a class="py-toggle" href="#" id="UnexpectedMethodError-toggle" onclick="return toggle('UnexpectedMethodError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnexpectedMethodError-class.html">UnexpectedMethodError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="UnexpectedMethodError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnexpectedMethodError-expanded"><a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> <tt class="py-docstring">"""Exception raised by RequestMockBuilder on unexpected calls."""</tt> </tt>
+<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> </tt>
+<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt class="py-name">positional</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
+<a name="UnexpectedMethodError.__init__"></a><div id="UnexpectedMethodError.__init__-def"><a name="L129"></a><tt class="py-lineno">129</tt> <a class="py-toggle" href="#" id="UnexpectedMethodError.__init__-toggle" onclick="return toggle('UnexpectedMethodError.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.UnexpectedMethodError-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">methodId</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="UnexpectedMethodError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="UnexpectedMethodError.__init__-expanded"><a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for an UnexpectedMethodError."""</tt> </tt>
+<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-4" class="py-name" targets="Class googleapiclient.errors.UnexpectedMethodError=googleapiclient.errors.UnexpectedMethodError-class.html"><a title="googleapiclient.errors.UnexpectedMethodError" class="py-name" href="#" onclick="return doclink('link-4', 'UnexpectedMethodError', 'link-4');">UnexpectedMethodError</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method googleapiclient.channel.Channel.__init__()=googleapiclient.channel.Channel-class.html#__init__,Method googleapiclient.channel.Notification.__init__()=googleapiclient.channel.Notification-class.html#__init__,Method googleapiclient.discovery.Resource.__init__()=googleapiclient.discovery.Resource-class.html#__init__,Method googleapiclient.discovery.ResourceMethodParameters.__init__()=googleapiclient.discovery.ResourceMethodParameters-class.html#__init__,Method googleapiclient.errors.BatchError.__init__()=googleapiclient.errors.BatchError-class.html#__init__,Method googleapiclient.errors.HttpError.__init__()=googleapiclient.errors.HttpError-class.html#__init__,Method googleapiclient.errors.UnexpectedBodyError.__init__()=googleapiclient.errors.UnexpectedBodyError-class.html#__init__,Method googleapiclient.errors.UnexpectedMethodError.__init__()=googleapiclient.errors.UnexpectedMethodError-class.html#__init__,Method googleapiclient.http.BatchHttpRequest.__init__()=googleapiclient.http.BatchHttpRequest-class.html#__init__,Method googleapiclient.http.HttpMock.__init__()=googleapiclient.http.HttpMock-class.html#__init__,Method googleapiclient.http.HttpMockSequence.__init__()=googleapiclient.http.HttpMockSequence-class.html#__init__,Method googleapiclient.http.HttpRequest.__init__()=googleapiclient.http.HttpRequest-class.html#__init__,Method googleapiclient.http.HttpRequestMock.__init__()=googleapiclient.http.HttpRequestMock-class.html#__init__,Method googleapiclient.http.MediaDownloadProgress.__init__()=googleapiclient.http.MediaDownloadProgress-class.html#__init__,Method googleapiclient.http.MediaFileUpload.__init__()=googleapiclient.http.MediaFileUpload-class.html#__init__,Method googleapiclient.http.MediaInMemoryUpload.__init__()=googleapiclient.http.MediaInMemoryUpload-class.html#__init__,Method googleapiclient.http.MediaIoBaseDownload.__init__()=googleapiclient.http.MediaIoBaseDownload-class.html#__init__,Method googleapiclient.http.MediaIoBaseUpload.__init__()=googleapiclient.http.MediaIoBaseUpload-class.html#__init__,Method googleapiclient.http.MediaUploadProgress.__init__()=googleapiclient.http.MediaUploadProgress-class.html#__init__,Method googleapiclient.http.RequestMockBuilder.__init__()=googleapiclient.http.RequestMockBuilder-class.html#__init__,Method googleapiclient.http._StreamSlice.__init__()=googleapiclient.http._StreamSlice-class.html#__init__,Method googleapiclient.model.JsonModel.__init__()=googleapiclient.model.JsonModel-class.html#__init__,Method googleapiclient.model.ProtocolBufferModel.__init__()=googleapiclient.model.ProtocolBufferModel-class.html#__init__,Method googleapiclient.schema.Schemas.__init__()=googleapiclient.schema.Schemas-class.html#__init__,Method googleapiclient.schema._SchemaToStruct.__init__()=googleapiclient.schema._SchemaToStruct-class.html#__init__"><a title="googleapiclient.channel.Channel.__init__
googleapiclient.channel.Notification.__init__
googleapiclient.discovery.Resource.__init__
googleapiclient.discovery.ResourceMethodParameters.__init__
@@ -211,15 +213,15 @@
googleapiclient.model.ProtocolBufferModel.__init__
googleapiclient.schema.Schemas.__init__
googleapiclient.schema._SchemaToStruct.__init__" class="py-name" href="#" onclick="return doclink('link-5', '__init__', 'link-5');">__init__</a></tt><tt class="py-op">(</tt> </tt>
-<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-string">'Received unexpected call %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">methodId</tt><tt class="py-op">)</tt> </tt>
-</div></div><a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> </tt>
-<a name="UnexpectedBodyError"></a><div id="UnexpectedBodyError-def"><a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> </tt>
-<a name="L133"></a><tt class="py-lineno">133</tt> <a class="py-toggle" href="#" id="UnexpectedBodyError-toggle" onclick="return toggle('UnexpectedBodyError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnexpectedBodyError-class.html">UnexpectedBodyError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="UnexpectedBodyError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnexpectedBodyError-expanded"><a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> <tt class="py-docstring">"""Exception raised by RequestMockBuilder on unexpected bodies."""</tt> </tt>
-<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"> </tt>
-<a name="UnexpectedBodyError.__init__"></a><div id="UnexpectedBodyError.__init__-def"><a name="L136"></a><tt class="py-lineno">136</tt> <a class="py-toggle" href="#" id="UnexpectedBodyError.__init__-toggle" onclick="return toggle('UnexpectedBodyError.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.UnexpectedBodyError-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">expected</tt><tt class="py-op">,</tt> <tt class="py-param">provided</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="UnexpectedBodyError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="UnexpectedBodyError.__init__-expanded"><a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for an UnexpectedMethodError."""</tt> </tt>
-<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-6" class="py-name" targets="Class googleapiclient.errors.UnexpectedBodyError=googleapiclient.errors.UnexpectedBodyError-class.html"><a title="googleapiclient.errors.UnexpectedBodyError" class="py-name" href="#" onclick="return doclink('link-6', 'UnexpectedBodyError', 'link-6');">UnexpectedBodyError</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="googleapiclient.channel.Channel.__init__
+<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt class="py-string">'Received unexpected call %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">methodId</tt><tt class="py-op">)</tt> </tt>
+</div></div><a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> </tt>
+<a name="UnexpectedBodyError"></a><div id="UnexpectedBodyError-def"><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> <a class="py-toggle" href="#" id="UnexpectedBodyError-toggle" onclick="return toggle('UnexpectedBodyError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.errors.UnexpectedBodyError-class.html">UnexpectedBodyError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="UnexpectedBodyError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnexpectedBodyError-expanded"><a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt class="py-docstring">"""Exception raised by RequestMockBuilder on unexpected bodies."""</tt> </tt>
+<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> </tt>
+<a name="UnexpectedBodyError.__init__"></a><div id="UnexpectedBodyError.__init__-def"><a name="L138"></a><tt class="py-lineno">138</tt> <a class="py-toggle" href="#" id="UnexpectedBodyError.__init__-toggle" onclick="return toggle('UnexpectedBodyError.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.errors.UnexpectedBodyError-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">expected</tt><tt class="py-op">,</tt> <tt class="py-param">provided</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="UnexpectedBodyError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="UnexpectedBodyError.__init__-expanded"><a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for an UnexpectedMethodError."""</tt> </tt>
+<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-6" class="py-name" targets="Class googleapiclient.errors.UnexpectedBodyError=googleapiclient.errors.UnexpectedBodyError-class.html"><a title="googleapiclient.errors.UnexpectedBodyError" class="py-name" href="#" onclick="return doclink('link-6', 'UnexpectedBodyError', 'link-6');">UnexpectedBodyError</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="googleapiclient.channel.Channel.__init__
googleapiclient.channel.Notification.__init__
googleapiclient.discovery.Resource.__init__
googleapiclient.discovery.ResourceMethodParameters.__init__
@@ -244,8 +246,8 @@
googleapiclient.model.ProtocolBufferModel.__init__
googleapiclient.schema.Schemas.__init__
googleapiclient.schema._SchemaToStruct.__init__" class="py-name" href="#" onclick="return doclink('link-7', '__init__', 'link-5');">__init__</a></tt><tt class="py-op">(</tt> </tt>
-<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-string">'Expected: [%s] - Provided: [%s]'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">expected</tt><tt class="py-op">,</tt> <tt class="py-name">provided</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-</div></div><a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> </tt><script type="text/javascript">
+<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> <tt class="py-string">'Expected: [%s] - Provided: [%s]'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">expected</tt><tt class="py-op">,</tt> <tt class="py-name">provided</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+</div></div><a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
@@ -278,7 +280,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 1158eb8..9033c96 100644
--- a/docs/epy/googleapiclient.errors.BatchError-class.html
+++ b/docs/epy/googleapiclient.errors.BatchError-class.html
@@ -64,20 +64,20 @@
<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_17" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="84,31,241,51"/>
-<area shape="rect" id="node3_18" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="84,51,241,71"/>
-<area shape="rect" id="node3_19" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="84,73,241,93"/>
-<area shape="rect" id="node3_20" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="84,93,241,113"/>
-<area shape="rect" id="node3_21" href="javascript:void(0);" title="x[y]" alt="" coords="84,113,241,133"/>
-<area shape="rect" id="node3_22" href="javascript:void(0);" title="x[i:j]" alt="" coords="84,133,241,153"/>
-<area shape="rect" id="node3_23" href="javascript:void(0);" title="helper for pickle" alt="" coords="84,153,241,173"/>
-<area shape="rect" id="node3_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="84,173,241,193"/>
-<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="84,193,241,213"/>
-<area shape="rect" id="node3_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="84,213,241,233"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="72,5,253,240"/>
+<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"/>
-<area shape="rect" id="node4" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="134,339,189,384"/>
</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>
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 14ee45b..6bf4e42 100644
--- a/docs/epy/googleapiclient.errors.Error-class.html
+++ b/docs/epy/googleapiclient.errors.Error-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 06f550b..4e7755a 100644
--- a/docs/epy/googleapiclient.errors.HttpError-class.html
+++ b/docs/epy/googleapiclient.errors.HttpError-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 6ef8c74..f9a5897 100644
--- a/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html
+++ b/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 b05cadd..ba92a7b 100644
--- a/docs/epy/googleapiclient.errors.InvalidJsonError-class.html
+++ b/docs/epy/googleapiclient.errors.InvalidJsonError-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 c7ad39c..fd8e2e4 100644
--- a/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html
+++ b/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 5525a58..2dc3cba 100644
--- a/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html
+++ b/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 14914d1..b2a5fff 100644
--- a/docs/epy/googleapiclient.errors.ResumableUploadError-class.html
+++ b/docs/epy/googleapiclient.errors.ResumableUploadError-class.html
@@ -64,20 +64,20 @@
<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_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="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"/>
-<area shape="rect" id="node4" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="102,339,157,384"/>
</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>
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 fbd61ac..12d4611 100644
--- a/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html
+++ b/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 cb18a1e..4564da6 100644
--- a/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html
+++ b/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 7b2706f..a5ac2a1 100644
--- a/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html
+++ b/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 b4767f9..6d512e1 100644
--- a/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html
+++ b/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 500400b..de0e971 100644
--- a/docs/epy/googleapiclient.errors.UnknownFileType-class.html
+++ b/docs/epy/googleapiclient.errors.UnknownFileType-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 6ae3ab8..5effa54 100644
--- a/docs/epy/googleapiclient.errors.UnknownLinkType-class.html
+++ b/docs/epy/googleapiclient.errors.UnknownLinkType-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 fe910bd..533b9b1 100644
--- a/docs/epy/googleapiclient.http-module.html
+++ b/docs/epy/googleapiclient.http-module.html
@@ -405,7 +405,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 7c6d019..d421670 100644
--- a/docs/epy/googleapiclient.http-pysrc.html
+++ b/docs/epy/googleapiclient.http-pysrc.html
@@ -1409,178 +1409,175 @@
<a name="L1120"></a><tt class="py-lineno">1120</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">msg</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="L1121"></a><tt class="py-lineno">1121</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-54');">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="L1122"></a><tt class="py-lineno">1122</tt> <tt class="py-line"> </tt>
-<a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"> <tt class="py-comment"># Strip off the \n\n that the MIME lib tacks onto the end of the payload.</tt> </tt>
-<a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-210" class="py-name"><a title="googleapiclient.http.HttpMock.request
+<a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">status_line</tt> <tt class="py-op">+</tt> <tt id="link-210" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-210', 'body', 'link-54');">body</a></tt> </tt>
+</div><a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"> </tt>
+<a name="BatchHttpRequest._deserialize_response"></a><div id="BatchHttpRequest._deserialize_response-def"><a name="L1125"></a><tt class="py-lineno">1125</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._deserialize_response-toggle" onclick="return toggle('BatchHttpRequest._deserialize_response');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http.BatchHttpRequest-class.html#_deserialize_response">_deserialize_response</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">payload</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="BatchHttpRequest._deserialize_response-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._deserialize_response-expanded"><a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert string into httplib2 response and content.</tt> </tt>
+<a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"><tt class="py-docstring"> payload: string, headers and body as a string.</tt> </tt>
+<a name="L1130"></a><tt class="py-lineno">1130</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L1132"></a><tt class="py-lineno">1132</tt> <tt class="py-line"><tt class="py-docstring"> A pair (resp, content), such as would be returned from httplib2.request.</tt> </tt>
+<a name="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"> <tt class="py-comment"># Strip off the status line</tt> </tt>
+<a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"> <tt class="py-name">status_line</tt><tt class="py-op">,</tt> <tt class="py-name">payload</tt> <tt class="py-op">=</tt> <tt class="py-name">payload</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
+<a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"> <tt class="py-name">protocol</tt><tt class="py-op">,</tt> <tt class="py-name">status</tt><tt class="py-op">,</tt> <tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">status_line</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-number">2</tt><tt class="py-op">)</tt> </tt>
+<a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"> </tt>
+<a name="L1138"></a><tt class="py-lineno">1138</tt> <tt class="py-line"> <tt class="py-comment"># Parse the rest of the response</tt> </tt>
+<a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"> <tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt class="py-name">FeedParser</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L1140"></a><tt class="py-lineno">1140</tt> <tt class="py-line"> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">feed</tt><tt class="py-op">(</tt><tt class="py-name">payload</tt><tt class="py-op">)</tt> </tt>
+<a name="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'status'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">status</tt> </tt>
+<a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"> </tt>
+<a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"> <tt class="py-comment"># Create httplib2.Response from the parsed headers.</tt> </tt>
+<a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"> <tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Response</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
+<a name="L1146"></a><tt class="py-lineno">1146</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">reason</tt> </tt>
+<a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">version</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">protocol</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-number">1</tt><tt class="py-op">)</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-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'.'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"> </tt>
+<a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">payload</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\r\n\r\n'</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-number">1</tt><tt class="py-op">]</tt> </tt>
+<a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"> </tt>
+<a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt>
+</div><a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"> </tt>
+<a name="BatchHttpRequest._new_id"></a><div id="BatchHttpRequest._new_id-def"><a name="L1153"></a><tt class="py-lineno">1153</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._new_id-toggle" onclick="return toggle('BatchHttpRequest._new_id');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http.BatchHttpRequest-class.html#_new_id">_new_id</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="BatchHttpRequest._new_id-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._new_id-expanded"><a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a new id.</tt> </tt>
+<a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"><tt class="py-docstring"> Auto incrementing number that avoids conflicts with ids already used.</tt> </tt>
+<a name="L1157"></a><tt class="py-lineno">1157</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L1159"></a><tt class="py-lineno">1159</tt> <tt class="py-line"><tt class="py-docstring"> string, a new unique id.</tt> </tt>
+<a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1161"></a><tt class="py-lineno">1161</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
+<a name="L1162"></a><tt class="py-lineno">1162</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">:</tt> </tt>
+<a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
+<a name="L1164"></a><tt class="py-lineno">1164</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">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L1165"></a><tt class="py-lineno">1165</tt> <tt class="py-line"> </tt>
+<a name="L1166"></a><tt class="py-lineno">1166</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt class="py-name">positional</tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
+<a name="BatchHttpRequest.add"></a><div id="BatchHttpRequest.add-def"><a name="L1167"></a><tt class="py-lineno">1167</tt> <a class="py-toggle" href="#" id="BatchHttpRequest.add-toggle" onclick="return toggle('BatchHttpRequest.add');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http.BatchHttpRequest-class.html#add">add</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">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-param">request_id</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="BatchHttpRequest.add-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest.add-expanded"><a name="L1168"></a><tt class="py-lineno">1168</tt> <tt class="py-line"> <tt class="py-docstring">"""Add a new request.</tt> </tt>
+<a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"><tt class="py-docstring"> Every callback added will be paired with a unique id, the request_id. That</tt> </tt>
+<a name="L1171"></a><tt class="py-lineno">1171</tt> <tt class="py-line"><tt class="py-docstring"> unique id will be passed back to the callback when the response comes back</tt> </tt>
+<a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"><tt class="py-docstring"> from the server. The default behavior is to have the library generate it's</tt> </tt>
+<a name="L1173"></a><tt class="py-lineno">1173</tt> <tt class="py-line"><tt class="py-docstring"> own unique id. If the caller passes in a request_id then they must ensure</tt> </tt>
+<a name="L1174"></a><tt class="py-lineno">1174</tt> <tt class="py-line"><tt class="py-docstring"> uniqueness for each request_id, and if they are not an exception is</tt> </tt>
+<a name="L1175"></a><tt class="py-lineno">1175</tt> <tt class="py-line"><tt class="py-docstring"> raised. Callers should either supply all request_ids or nevery supply a</tt> </tt>
+<a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"><tt class="py-docstring"> request id, to avoid such an error.</tt> </tt>
+<a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"><tt class="py-docstring"> request: HttpRequest, Request to add to the batch.</tt> </tt>
+<a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"><tt class="py-docstring"> callback: callable, A callback to be called for this response, of the</tt> </tt>
+<a name="L1181"></a><tt class="py-lineno">1181</tt> <tt class="py-line"><tt class="py-docstring"> form callback(id, response, exception). The first parameter is the</tt> </tt>
+<a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"><tt class="py-docstring"> request id, and the second is the deserialized response object. The</tt> </tt>
+<a name="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"><tt class="py-docstring"> third is an googleapiclient.errors.HttpError exception object if an HTTP error</tt> </tt>
+<a name="L1184"></a><tt class="py-lineno">1184</tt> <tt class="py-line"><tt class="py-docstring"> occurred while processing the request, or None if no errors occurred.</tt> </tt>
+<a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"><tt class="py-docstring"> request_id: string, A unique id for the request. The id will be passed to</tt> </tt>
+<a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"><tt class="py-docstring"> the callback with the response.</tt> </tt>
+<a name="L1187"></a><tt class="py-lineno">1187</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1188"></a><tt class="py-lineno">1188</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L1189"></a><tt class="py-lineno">1189</tt> <tt class="py-line"><tt class="py-docstring"> None</tt> </tt>
+<a name="L1190"></a><tt class="py-lineno">1190</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1191"></a><tt class="py-lineno">1191</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt>
+<a name="L1192"></a><tt class="py-lineno">1192</tt> <tt class="py-line"><tt class="py-docstring"> BatchError if a media request is added to a batch.</tt> </tt>
+<a name="L1193"></a><tt class="py-lineno">1193</tt> <tt class="py-line"><tt class="py-docstring"> KeyError is the request_id is not unique.</tt> </tt>
+<a name="L1194"></a><tt class="py-lineno">1194</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1195"></a><tt class="py-lineno">1195</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L1196"></a><tt class="py-lineno">1196</tt> <tt class="py-line"> <tt class="py-name">request_id</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-211" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._new_id()=googleapiclient.http.BatchHttpRequest-class.html#_new_id"><a title="googleapiclient.http.BatchHttpRequest._new_id" class="py-name" href="#" onclick="return doclink('link-211', '_new_id', 'link-211');">_new_id</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L1197"></a><tt class="py-lineno">1197</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-212" 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-210', 'request', 'link-63');">request</a></tt><tt class="py-op">.</tt><tt id="link-211" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-211', 'body', 'link-54');">body</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L1125"></a><tt class="py-lineno">1125</tt> <tt class="py-line"> <tt id="link-212" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-212', 'body', 'link-54');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-213" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-213', 'body', 'link-54');">body</a></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>
-<a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"> </tt>
-<a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">status_line</tt> <tt class="py-op">+</tt> <tt id="link-214" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-214', 'body', 'link-54');">body</a></tt> </tt>
-</div><a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"> </tt>
-<a name="BatchHttpRequest._deserialize_response"></a><div id="BatchHttpRequest._deserialize_response-def"><a name="L1129"></a><tt class="py-lineno">1129</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._deserialize_response-toggle" onclick="return toggle('BatchHttpRequest._deserialize_response');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http.BatchHttpRequest-class.html#_deserialize_response">_deserialize_response</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">payload</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="BatchHttpRequest._deserialize_response-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._deserialize_response-expanded"><a name="L1130"></a><tt class="py-lineno">1130</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert string into httplib2 response and content.</tt> </tt>
-<a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1132"></a><tt class="py-lineno">1132</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"><tt class="py-docstring"> payload: string, headers and body as a string.</tt> </tt>
-<a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"><tt class="py-docstring"> A pair (resp, content), such as would be returned from httplib2.request.</tt> </tt>
-<a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L1138"></a><tt class="py-lineno">1138</tt> <tt class="py-line"> <tt class="py-comment"># Strip off the status line</tt> </tt>
-<a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"> <tt class="py-name">status_line</tt><tt class="py-op">,</tt> <tt class="py-name">payload</tt> <tt class="py-op">=</tt> <tt class="py-name">payload</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
-<a name="L1140"></a><tt class="py-lineno">1140</tt> <tt class="py-line"> <tt class="py-name">protocol</tt><tt class="py-op">,</tt> <tt class="py-name">status</tt><tt class="py-op">,</tt> <tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">status_line</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-number">2</tt><tt class="py-op">)</tt> </tt>
-<a name="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"> </tt>
-<a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"> <tt class="py-comment"># Parse the rest of the response</tt> </tt>
-<a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"> <tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt class="py-name">FeedParser</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">feed</tt><tt class="py-op">(</tt><tt class="py-name">payload</tt><tt class="py-op">)</tt> </tt>
-<a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L1146"></a><tt class="py-lineno">1146</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'status'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">status</tt> </tt>
-<a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"> </tt>
-<a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"> <tt class="py-comment"># Create httplib2.Response from the parsed headers.</tt> </tt>
-<a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"> <tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Response</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
-<a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">reason</tt> </tt>
-<a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">version</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">protocol</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-number">1</tt><tt class="py-op">)</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-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'.'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"> </tt>
-<a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">payload</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\r\n\r\n'</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-number">1</tt><tt class="py-op">]</tt> </tt>
-<a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"> </tt>
-<a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt>
-</div><a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"> </tt>
-<a name="BatchHttpRequest._new_id"></a><div id="BatchHttpRequest._new_id-def"><a name="L1157"></a><tt class="py-lineno">1157</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._new_id-toggle" onclick="return toggle('BatchHttpRequest._new_id');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http.BatchHttpRequest-class.html#_new_id">_new_id</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="BatchHttpRequest._new_id-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._new_id-expanded"><a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a new id.</tt> </tt>
-<a name="L1159"></a><tt class="py-lineno">1159</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"><tt class="py-docstring"> Auto incrementing number that avoids conflicts with ids already used.</tt> </tt>
-<a name="L1161"></a><tt class="py-lineno">1161</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1162"></a><tt class="py-lineno">1162</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"><tt class="py-docstring"> string, a new unique id.</tt> </tt>
-<a name="L1164"></a><tt class="py-lineno">1164</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L1165"></a><tt class="py-lineno">1165</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
-<a name="L1166"></a><tt class="py-lineno">1166</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">:</tt> </tt>
-<a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
-<a name="L1168"></a><tt class="py-lineno">1168</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">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"> </tt>
-<a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt class="py-name">positional</tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
-<a name="BatchHttpRequest.add"></a><div id="BatchHttpRequest.add-def"><a name="L1171"></a><tt class="py-lineno">1171</tt> <a class="py-toggle" href="#" id="BatchHttpRequest.add-toggle" onclick="return toggle('BatchHttpRequest.add');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http.BatchHttpRequest-class.html#add">add</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">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-param">request_id</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="BatchHttpRequest.add-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest.add-expanded"><a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"> <tt class="py-docstring">"""Add a new request.</tt> </tt>
-<a name="L1173"></a><tt class="py-lineno">1173</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1174"></a><tt class="py-lineno">1174</tt> <tt class="py-line"><tt class="py-docstring"> Every callback added will be paired with a unique id, the request_id. That</tt> </tt>
-<a name="L1175"></a><tt class="py-lineno">1175</tt> <tt class="py-line"><tt class="py-docstring"> unique id will be passed back to the callback when the response comes back</tt> </tt>
-<a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"><tt class="py-docstring"> from the server. The default behavior is to have the library generate it's</tt> </tt>
-<a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"><tt class="py-docstring"> own unique id. If the caller passes in a request_id then they must ensure</tt> </tt>
-<a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"><tt class="py-docstring"> uniqueness for each request_id, and if they are not an exception is</tt> </tt>
-<a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"><tt class="py-docstring"> raised. Callers should either supply all request_ids or nevery supply a</tt> </tt>
-<a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"><tt class="py-docstring"> request id, to avoid such an error.</tt> </tt>
-<a name="L1181"></a><tt class="py-lineno">1181</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"><tt class="py-docstring"> request: HttpRequest, Request to add to the batch.</tt> </tt>
-<a name="L1184"></a><tt class="py-lineno">1184</tt> <tt class="py-line"><tt class="py-docstring"> callback: callable, A callback to be called for this response, of the</tt> </tt>
-<a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"><tt class="py-docstring"> form callback(id, response, exception). The first parameter is the</tt> </tt>
-<a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"><tt class="py-docstring"> request id, and the second is the deserialized response object. The</tt> </tt>
-<a name="L1187"></a><tt class="py-lineno">1187</tt> <tt class="py-line"><tt class="py-docstring"> third is an googleapiclient.errors.HttpError exception object if an HTTP error</tt> </tt>
-<a name="L1188"></a><tt class="py-lineno">1188</tt> <tt class="py-line"><tt class="py-docstring"> occurred while processing the request, or None if no errors occurred.</tt> </tt>
-<a name="L1189"></a><tt class="py-lineno">1189</tt> <tt class="py-line"><tt class="py-docstring"> request_id: string, A unique id for the request. The id will be passed to</tt> </tt>
-<a name="L1190"></a><tt class="py-lineno">1190</tt> <tt class="py-line"><tt class="py-docstring"> the callback with the response.</tt> </tt>
-<a name="L1191"></a><tt class="py-lineno">1191</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1192"></a><tt class="py-lineno">1192</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L1193"></a><tt class="py-lineno">1193</tt> <tt class="py-line"><tt class="py-docstring"> None</tt> </tt>
-<a name="L1194"></a><tt class="py-lineno">1194</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1195"></a><tt class="py-lineno">1195</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt>
-<a name="L1196"></a><tt class="py-lineno">1196</tt> <tt class="py-line"><tt class="py-docstring"> BatchError if a media request is added to a batch.</tt> </tt>
-<a name="L1197"></a><tt class="py-lineno">1197</tt> <tt class="py-line"><tt class="py-docstring"> KeyError is the request_id is not unique.</tt> </tt>
-<a name="L1198"></a><tt class="py-lineno">1198</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L1199"></a><tt class="py-lineno">1199</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L1200"></a><tt class="py-lineno">1200</tt> <tt class="py-line"> <tt class="py-name">request_id</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-215" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._new_id()=googleapiclient.http.BatchHttpRequest-class.html#_new_id"><a title="googleapiclient.http.BatchHttpRequest._new_id" class="py-name" href="#" onclick="return doclink('link-215', '_new_id', 'link-215');">_new_id</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L1201"></a><tt class="py-lineno">1201</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-216" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-212', 'request', 'link-63');">request</a></tt><tt class="py-op">.</tt><tt id="link-213" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-213', 'resumable', 'link-36');">resumable</a></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="L1198"></a><tt class="py-lineno">1198</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-214" class="py-name"><a title="googleapiclient.errors.BatchError" class="py-name" href="#" onclick="return doclink('link-214', 'BatchError', 'link-4');">BatchError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Media requests cannot be used in a batch request."</tt><tt class="py-op">)</tt> </tt>
+<a name="L1199"></a><tt class="py-lineno">1199</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">:</tt> </tt>
+<a name="L1200"></a><tt class="py-lineno">1200</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">KeyError</tt><tt class="py-op">(</tt><tt class="py-string">"A request with this ID already exists: %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt>
+<a name="L1201"></a><tt class="py-lineno">1201</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-215" 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-216', 'request', 'link-63');">request</a></tt><tt class="py-op">.</tt><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-36');">resumable</a></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="L1202"></a><tt class="py-lineno">1202</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-218" class="py-name"><a title="googleapiclient.errors.BatchError" class="py-name" href="#" onclick="return doclink('link-218', 'BatchError', 'link-4');">BatchError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Media requests cannot be used in a batch request."</tt><tt class="py-op">)</tt> </tt>
-<a name="L1203"></a><tt class="py-lineno">1203</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">:</tt> </tt>
-<a name="L1204"></a><tt class="py-lineno">1204</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">KeyError</tt><tt class="py-op">(</tt><tt class="py-string">"A request with this ID already exists: %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt>
-<a name="L1205"></a><tt class="py-lineno">1205</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-219" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-215', 'request', 'link-63');">request</a></tt> </tt>
+<a name="L1202"></a><tt class="py-lineno">1202</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callbacks</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">callback</tt> </tt>
+<a name="L1203"></a><tt class="py-lineno">1203</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L1204"></a><tt class="py-lineno">1204</tt> <tt class="py-line"> </tt>
+<a name="BatchHttpRequest._execute"></a><div id="BatchHttpRequest._execute-def"><a name="L1205"></a><tt class="py-lineno">1205</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._execute-toggle" onclick="return toggle('BatchHttpRequest._execute');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http.BatchHttpRequest-class.html#_execute">_execute</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">order</tt><tt class="py-op">,</tt> <tt class="py-param">requests</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="BatchHttpRequest._execute-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._execute-expanded"><a name="L1206"></a><tt class="py-lineno">1206</tt> <tt class="py-line"> <tt class="py-docstring">"""Serialize batch request, send to server, process response.</tt> </tt>
+<a name="L1207"></a><tt class="py-lineno">1207</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1208"></a><tt class="py-lineno">1208</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L1209"></a><tt class="py-lineno">1209</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, an http object to be used to make the request with.</tt> </tt>
+<a name="L1210"></a><tt class="py-lineno">1210</tt> <tt class="py-line"><tt class="py-docstring"> order: list, list of request ids in the order they were added to the</tt> </tt>
+<a name="L1211"></a><tt class="py-lineno">1211</tt> <tt class="py-line"><tt class="py-docstring"> batch.</tt> </tt>
+<a name="L1212"></a><tt class="py-lineno">1212</tt> <tt class="py-line"><tt class="py-docstring"> request: list, list of request objects to send.</tt> </tt>
+<a name="L1213"></a><tt class="py-lineno">1213</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1214"></a><tt class="py-lineno">1214</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt>
+<a name="L1215"></a><tt class="py-lineno">1215</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.HttpLib2Error if a transport error has occured.</tt> </tt>
+<a name="L1216"></a><tt class="py-lineno">1216</tt> <tt class="py-line"><tt class="py-docstring"> googleapiclient.errors.BatchError if the response is the wrong format.</tt> </tt>
+<a name="L1217"></a><tt class="py-lineno">1217</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1218"></a><tt class="py-lineno">1218</tt> <tt class="py-line"> <tt class="py-name">message</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMEMultipart</tt><tt class="py-op">(</tt><tt class="py-string">'mixed'</tt><tt class="py-op">)</tt> </tt>
+<a name="L1219"></a><tt class="py-lineno">1219</tt> <tt class="py-line"> <tt class="py-comment"># Message should not write out it's own headers.</tt> </tt>
+<a name="L1220"></a><tt class="py-lineno">1220</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">message</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="L1221"></a><tt class="py-lineno">1221</tt> <tt class="py-line"> </tt>
+<a name="L1222"></a><tt class="py-lineno">1222</tt> <tt class="py-line"> <tt class="py-comment"># Add all the individual requests.</tt> </tt>
+<a name="L1223"></a><tt class="py-lineno">1223</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">order</tt><tt class="py-op">:</tt> </tt>
+<a name="L1224"></a><tt class="py-lineno">1224</tt> <tt class="py-line"> <tt id="link-216" 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-219', 'request', 'link-63');">request</a></tt> </tt>
-<a name="L1206"></a><tt class="py-lineno">1206</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callbacks</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">callback</tt> </tt>
-<a name="L1207"></a><tt class="py-lineno">1207</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L1208"></a><tt class="py-lineno">1208</tt> <tt class="py-line"> </tt>
-<a name="BatchHttpRequest._execute"></a><div id="BatchHttpRequest._execute-def"><a name="L1209"></a><tt class="py-lineno">1209</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._execute-toggle" onclick="return toggle('BatchHttpRequest._execute');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http.BatchHttpRequest-class.html#_execute">_execute</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">order</tt><tt class="py-op">,</tt> <tt class="py-param">requests</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="BatchHttpRequest._execute-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._execute-expanded"><a name="L1210"></a><tt class="py-lineno">1210</tt> <tt class="py-line"> <tt class="py-docstring">"""Serialize batch request, send to server, process response.</tt> </tt>
-<a name="L1211"></a><tt class="py-lineno">1211</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1212"></a><tt class="py-lineno">1212</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L1213"></a><tt class="py-lineno">1213</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, an http object to be used to make the request with.</tt> </tt>
-<a name="L1214"></a><tt class="py-lineno">1214</tt> <tt class="py-line"><tt class="py-docstring"> order: list, list of request ids in the order they were added to the</tt> </tt>
-<a name="L1215"></a><tt class="py-lineno">1215</tt> <tt class="py-line"><tt class="py-docstring"> batch.</tt> </tt>
-<a name="L1216"></a><tt class="py-lineno">1216</tt> <tt class="py-line"><tt class="py-docstring"> request: list, list of request objects to send.</tt> </tt>
-<a name="L1217"></a><tt class="py-lineno">1217</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1218"></a><tt class="py-lineno">1218</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt>
-<a name="L1219"></a><tt class="py-lineno">1219</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.HttpLib2Error if a transport error has occured.</tt> </tt>
-<a name="L1220"></a><tt class="py-lineno">1220</tt> <tt class="py-line"><tt class="py-docstring"> googleapiclient.errors.BatchError if the response is the wrong format.</tt> </tt>
-<a name="L1221"></a><tt class="py-lineno">1221</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L1222"></a><tt class="py-lineno">1222</tt> <tt class="py-line"> <tt class="py-name">message</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMEMultipart</tt><tt class="py-op">(</tt><tt class="py-string">'mixed'</tt><tt class="py-op">)</tt> </tt>
-<a name="L1223"></a><tt class="py-lineno">1223</tt> <tt class="py-line"> <tt class="py-comment"># Message should not write out it's own headers.</tt> </tt>
-<a name="L1224"></a><tt class="py-lineno">1224</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">message</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>
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-216', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
<a name="L1225"></a><tt class="py-lineno">1225</tt> <tt class="py-line"> </tt>
-<a name="L1226"></a><tt class="py-lineno">1226</tt> <tt class="py-line"> <tt class="py-comment"># Add all the individual requests.</tt> </tt>
-<a name="L1227"></a><tt class="py-lineno">1227</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">order</tt><tt class="py-op">:</tt> </tt>
-<a name="L1228"></a><tt class="py-lineno">1228</tt> <tt class="py-line"> <tt id="link-220" 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-220', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
+<a name="L1226"></a><tt class="py-lineno">1226</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-string">'application'</tt><tt class="py-op">,</tt> <tt class="py-string">'http'</tt><tt class="py-op">)</tt> </tt>
+<a name="L1227"></a><tt class="py-lineno">1227</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="L1228"></a><tt class="py-lineno">1228</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'Content-ID'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-217" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._id_to_header()=googleapiclient.http.BatchHttpRequest-class.html#_id_to_header"><a title="googleapiclient.http.BatchHttpRequest._id_to_header" class="py-name" href="#" onclick="return doclink('link-217', '_id_to_header', 'link-217');">_id_to_header</a></tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt>
<a name="L1229"></a><tt class="py-lineno">1229</tt> <tt class="py-line"> </tt>
-<a name="L1230"></a><tt class="py-lineno">1230</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-string">'application'</tt><tt class="py-op">,</tt> <tt class="py-string">'http'</tt><tt class="py-op">)</tt> </tt>
-<a name="L1231"></a><tt class="py-lineno">1231</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="L1232"></a><tt class="py-lineno">1232</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'Content-ID'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-221" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._id_to_header()=googleapiclient.http.BatchHttpRequest-class.html#_id_to_header"><a title="googleapiclient.http.BatchHttpRequest._id_to_header" class="py-name" href="#" onclick="return doclink('link-221', '_id_to_header', 'link-221');">_id_to_header</a></tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt>
+<a name="L1230"></a><tt class="py-lineno">1230</tt> <tt class="py-line"> <tt id="link-218" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-218', 'body', 'link-54');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-219" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._serialize_request()=googleapiclient.http.BatchHttpRequest-class.html#_serialize_request"><a title="googleapiclient.http.BatchHttpRequest._serialize_request" class="py-name" href="#" onclick="return doclink('link-219', '_serialize_request', 'link-219');">_serialize_request</a></tt><tt class="py-op">(</tt><tt id="link-220" 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-220', 'request', 'link-63');">request</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L1231"></a><tt class="py-lineno">1231</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-221" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-221', 'body', 'link-54');">body</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L1232"></a><tt class="py-lineno">1232</tt> <tt class="py-line"> <tt class="py-name">message</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="L1233"></a><tt class="py-lineno">1233</tt> <tt class="py-line"> </tt>
-<a name="L1234"></a><tt class="py-lineno">1234</tt> <tt class="py-line"> <tt id="link-222" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-222', 'body', 'link-54');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-223" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._serialize_request()=googleapiclient.http.BatchHttpRequest-class.html#_serialize_request"><a title="googleapiclient.http.BatchHttpRequest._serialize_request" class="py-name" href="#" onclick="return doclink('link-223', '_serialize_request', 'link-223');">_serialize_request</a></tt><tt class="py-op">(</tt><tt id="link-224" 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-224', 'request', 'link-63');">request</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L1235"></a><tt class="py-lineno">1235</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-225" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-225', 'body', 'link-54');">body</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L1236"></a><tt class="py-lineno">1236</tt> <tt class="py-line"> <tt class="py-name">message</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="L1237"></a><tt class="py-lineno">1237</tt> <tt class="py-line"> </tt>
-<a name="L1238"></a><tt class="py-lineno">1238</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="L1239"></a><tt class="py-lineno">1239</tt> <tt class="py-line"> <tt class="py-comment"># it plays games with `From ` lines.</tt> </tt>
-<a name="L1240"></a><tt class="py-lineno">1240</tt> <tt class="py-line"> <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt class="py-name">StringIO</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L1241"></a><tt class="py-lineno">1241</tt> <tt class="py-line"> <tt class="py-name">g</tt> <tt class="py-op">=</tt> <tt class="py-name">Generator</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="L1242"></a><tt class="py-lineno">1242</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">message</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="L1243"></a><tt class="py-lineno">1243</tt> <tt class="py-line"> <tt id="link-226" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-226', 'body', 'link-54');">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="L1234"></a><tt class="py-lineno">1234</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="L1235"></a><tt class="py-lineno">1235</tt> <tt class="py-line"> <tt class="py-comment"># it plays games with `From ` lines.</tt> </tt>
+<a name="L1236"></a><tt class="py-lineno">1236</tt> <tt class="py-line"> <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt class="py-name">StringIO</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L1237"></a><tt class="py-lineno">1237</tt> <tt class="py-line"> <tt class="py-name">g</tt> <tt class="py-op">=</tt> <tt class="py-name">Generator</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="L1238"></a><tt class="py-lineno">1238</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">message</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="L1239"></a><tt class="py-lineno">1239</tt> <tt class="py-line"> <tt id="link-222" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-222', 'body', 'link-54');">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="L1240"></a><tt class="py-lineno">1240</tt> <tt class="py-line"> </tt>
+<a name="L1241"></a><tt class="py-lineno">1241</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="L1242"></a><tt class="py-lineno">1242</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/mixed; '</tt> </tt>
+<a name="L1243"></a><tt class="py-lineno">1243</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">message</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="L1244"></a><tt class="py-lineno">1244</tt> <tt class="py-line"> </tt>
-<a name="L1245"></a><tt class="py-lineno">1245</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="L1246"></a><tt class="py-lineno">1246</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/mixed; '</tt> </tt>
-<a name="L1247"></a><tt class="py-lineno">1247</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">message</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="L1248"></a><tt class="py-lineno">1248</tt> <tt class="py-line"> </tt>
-<a name="L1249"></a><tt class="py-lineno">1249</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-227" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-227', 'http', 'link-66');">http</a></tt><tt class="py-op">.</tt><tt id="link-228" class="py-name"><a title="googleapiclient.http.HttpMock.request
+<a name="L1245"></a><tt class="py-lineno">1245</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-223" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-223', 'http', 'link-66');">http</a></tt><tt class="py-op">.</tt><tt id="link-224" 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-228', 'request', 'link-63');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_batch_uri</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">=</tt><tt class="py-string">'POST'</tt><tt class="py-op">,</tt> <tt id="link-229" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-229', 'body', 'link-54');">body</a></tt><tt class="py-op">=</tt><tt id="link-230" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-230', 'body', 'link-54');">body</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L1250"></a><tt class="py-lineno">1250</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="L1251"></a><tt class="py-lineno">1251</tt> <tt class="py-line"> </tt>
-<a name="L1252"></a><tt class="py-lineno">1252</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">300</tt><tt class="py-op">:</tt> </tt>
-<a name="L1253"></a><tt class="py-lineno">1253</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-231" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-231', 'HttpError', 'link-7');">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">self</tt><tt class="py-op">.</tt><tt class="py-name">_batch_uri</tt><tt class="py-op">)</tt> </tt>
-<a name="L1254"></a><tt class="py-lineno">1254</tt> <tt class="py-line"> </tt>
-<a name="L1255"></a><tt class="py-lineno">1255</tt> <tt class="py-line"> <tt class="py-comment"># Now break out the individual responses and store each one.</tt> </tt>
-<a name="L1256"></a><tt class="py-lineno">1256</tt> <tt class="py-line"> <tt class="py-name">boundary</tt><tt class="py-op">,</tt> <tt class="py-name">_</tt> <tt class="py-op">=</tt> <tt class="py-name">content</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
-<a name="L1257"></a><tt class="py-lineno">1257</tt> <tt class="py-line"> </tt>
-<a name="L1258"></a><tt class="py-lineno">1258</tt> <tt class="py-line"> <tt class="py-comment"># Prepend with a content-type header so FeedParser can handle it.</tt> </tt>
-<a name="L1259"></a><tt class="py-lineno">1259</tt> <tt class="py-line"> <tt class="py-name">header</tt> <tt class="py-op">=</tt> <tt class="py-string">'content-type: %s\r\n\r\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt> </tt>
-<a name="L1260"></a><tt class="py-lineno">1260</tt> <tt class="py-line"> <tt class="py-name">for_parser</tt> <tt class="py-op">=</tt> <tt class="py-name">header</tt> <tt class="py-op">+</tt> <tt class="py-name">content</tt> </tt>
-<a name="L1261"></a><tt class="py-lineno">1261</tt> <tt class="py-line"> </tt>
-<a name="L1262"></a><tt class="py-lineno">1262</tt> <tt class="py-line"> <tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt class="py-name">FeedParser</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L1263"></a><tt class="py-lineno">1263</tt> <tt class="py-line"> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">feed</tt><tt class="py-op">(</tt><tt class="py-name">for_parser</tt><tt class="py-op">)</tt> </tt>
-<a name="L1264"></a><tt class="py-lineno">1264</tt> <tt class="py-line"> <tt class="py-name">mime_response</tt> <tt class="py-op">=</tt> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L1265"></a><tt class="py-lineno">1265</tt> <tt class="py-line"> </tt>
-<a name="L1266"></a><tt class="py-lineno">1266</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">mime_response</tt><tt class="py-op">.</tt><tt class="py-name">is_multipart</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1267"></a><tt class="py-lineno">1267</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-232" class="py-name"><a title="googleapiclient.errors.BatchError" class="py-name" href="#" onclick="return doclink('link-232', 'BatchError', 'link-4');">BatchError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Response not in multipart/mixed format."</tt><tt class="py-op">,</tt> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> </tt>
-<a name="L1268"></a><tt class="py-lineno">1268</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>
-<a name="L1269"></a><tt class="py-lineno">1269</tt> <tt class="py-line"> </tt>
-<a name="L1270"></a><tt class="py-lineno">1270</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">part</tt> <tt class="py-keyword">in</tt> <tt class="py-name">mime_response</tt><tt class="py-op">.</tt><tt class="py-name">get_payload</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1271"></a><tt class="py-lineno">1271</tt> <tt class="py-line"> <tt class="py-name">request_id</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-233" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._header_to_id()=googleapiclient.http.BatchHttpRequest-class.html#_header_to_id"><a title="googleapiclient.http.BatchHttpRequest._header_to_id" class="py-name" href="#" onclick="return doclink('link-233', '_header_to_id', 'link-233');">_header_to_id</a></tt><tt class="py-op">(</tt><tt class="py-name">part</tt><tt class="py-op">[</tt><tt class="py-string">'Content-ID'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L1272"></a><tt class="py-lineno">1272</tt> <tt class="py-line"> <tt id="link-234" 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-234', 'response', 'link-234');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-235" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._deserialize_response()=googleapiclient.http.BatchHttpRequest-class.html#_deserialize_response"><a title="googleapiclient.http.BatchHttpRequest._deserialize_response" class="py-name" href="#" onclick="return doclink('link-235', '_deserialize_response', 'link-235');">_deserialize_response</a></tt><tt class="py-op">(</tt><tt class="py-name">part</tt><tt class="py-op">.</tt><tt class="py-name">get_payload</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L1273"></a><tt class="py-lineno">1273</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_responses</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt id="link-236" class="py-name"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-236', 'response', 'link-234');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-224', 'request', 'link-63');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_batch_uri</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">=</tt><tt class="py-string">'POST'</tt><tt class="py-op">,</tt> <tt id="link-225" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-225', 'body', 'link-54');">body</a></tt><tt class="py-op">=</tt><tt id="link-226" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-226', 'body', 'link-54');">body</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L1246"></a><tt class="py-lineno">1246</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="L1247"></a><tt class="py-lineno">1247</tt> <tt class="py-line"> </tt>
+<a name="L1248"></a><tt class="py-lineno">1248</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">300</tt><tt class="py-op">:</tt> </tt>
+<a name="L1249"></a><tt class="py-lineno">1249</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-227" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-227', 'HttpError', 'link-7');">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">self</tt><tt class="py-op">.</tt><tt class="py-name">_batch_uri</tt><tt class="py-op">)</tt> </tt>
+<a name="L1250"></a><tt class="py-lineno">1250</tt> <tt class="py-line"> </tt>
+<a name="L1251"></a><tt class="py-lineno">1251</tt> <tt class="py-line"> <tt class="py-comment"># Prepend with a content-type header so FeedParser can handle it.</tt> </tt>
+<a name="L1252"></a><tt class="py-lineno">1252</tt> <tt class="py-line"> <tt class="py-name">header</tt> <tt class="py-op">=</tt> <tt class="py-string">'content-type: %s\r\n\r\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt> </tt>
+<a name="L1253"></a><tt class="py-lineno">1253</tt> <tt class="py-line"> <tt class="py-comment"># PY3's FeedParser only accepts unicode. So we should decode content</tt> </tt>
+<a name="L1254"></a><tt class="py-lineno">1254</tt> <tt class="py-line"> <tt class="py-comment"># here, and encode each payload again.</tt> </tt>
+<a name="L1255"></a><tt class="py-lineno">1255</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">PY3</tt><tt class="py-op">:</tt> </tt>
+<a name="L1256"></a><tt class="py-lineno">1256</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="L1257"></a><tt class="py-lineno">1257</tt> <tt class="py-line"> <tt class="py-name">for_parser</tt> <tt class="py-op">=</tt> <tt class="py-name">header</tt> <tt class="py-op">+</tt> <tt class="py-name">content</tt> </tt>
+<a name="L1258"></a><tt class="py-lineno">1258</tt> <tt class="py-line"> </tt>
+<a name="L1259"></a><tt class="py-lineno">1259</tt> <tt class="py-line"> <tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt class="py-name">FeedParser</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L1260"></a><tt class="py-lineno">1260</tt> <tt class="py-line"> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">feed</tt><tt class="py-op">(</tt><tt class="py-name">for_parser</tt><tt class="py-op">)</tt> </tt>
+<a name="L1261"></a><tt class="py-lineno">1261</tt> <tt class="py-line"> <tt class="py-name">mime_response</tt> <tt class="py-op">=</tt> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L1262"></a><tt class="py-lineno">1262</tt> <tt class="py-line"> </tt>
+<a name="L1263"></a><tt class="py-lineno">1263</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">mime_response</tt><tt class="py-op">.</tt><tt class="py-name">is_multipart</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1264"></a><tt class="py-lineno">1264</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-228" class="py-name"><a title="googleapiclient.errors.BatchError" class="py-name" href="#" onclick="return doclink('link-228', 'BatchError', 'link-4');">BatchError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Response not in multipart/mixed format."</tt><tt class="py-op">,</tt> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> </tt>
+<a name="L1265"></a><tt class="py-lineno">1265</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>
+<a name="L1266"></a><tt class="py-lineno">1266</tt> <tt class="py-line"> </tt>
+<a name="L1267"></a><tt class="py-lineno">1267</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">part</tt> <tt class="py-keyword">in</tt> <tt class="py-name">mime_response</tt><tt class="py-op">.</tt><tt class="py-name">get_payload</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1268"></a><tt class="py-lineno">1268</tt> <tt class="py-line"> <tt class="py-name">request_id</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-229" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._header_to_id()=googleapiclient.http.BatchHttpRequest-class.html#_header_to_id"><a title="googleapiclient.http.BatchHttpRequest._header_to_id" class="py-name" href="#" onclick="return doclink('link-229', '_header_to_id', 'link-229');">_header_to_id</a></tt><tt class="py-op">(</tt><tt class="py-name">part</tt><tt class="py-op">[</tt><tt class="py-string">'Content-ID'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L1269"></a><tt class="py-lineno">1269</tt> <tt class="py-line"> <tt id="link-230" 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-230', 'response', 'link-230');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-231" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._deserialize_response()=googleapiclient.http.BatchHttpRequest-class.html#_deserialize_response"><a title="googleapiclient.http.BatchHttpRequest._deserialize_response" class="py-name" href="#" onclick="return doclink('link-231', '_deserialize_response', 'link-231');">_deserialize_response</a></tt><tt class="py-op">(</tt><tt class="py-name">part</tt><tt class="py-op">.</tt><tt class="py-name">get_payload</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L1270"></a><tt class="py-lineno">1270</tt> <tt class="py-line"> <tt class="py-comment"># We encode content here to emulate normal http response.</tt> </tt>
+<a name="L1271"></a><tt class="py-lineno">1271</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">content</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">text_type</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1272"></a><tt class="py-lineno">1272</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">encode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt> </tt>
+<a name="L1273"></a><tt class="py-lineno">1273</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_responses</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt id="link-232" class="py-name"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-232', 'response', 'link-230');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1274"></a><tt class="py-lineno">1274</tt> <tt class="py-line"> </tt>
<a name="L1275"></a><tt class="py-lineno">1275</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt class="py-name">positional</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="BatchHttpRequest.execute"></a><div id="BatchHttpRequest.execute-def"><a name="L1276"></a><tt class="py-lineno">1276</tt> <a class="py-toggle" href="#" id="BatchHttpRequest.execute-toggle" onclick="return toggle('BatchHttpRequest.execute');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http.BatchHttpRequest-class.html#execute">execute</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-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
@@ -1600,26 +1597,26 @@
<a name="L1290"></a><tt class="py-lineno">1290</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1291"></a><tt class="py-lineno">1291</tt> <tt class="py-line"> </tt>
<a name="L1292"></a><tt class="py-lineno">1292</tt> <tt class="py-line"> <tt class="py-comment"># If http is not supplied use the first valid one given in the requests.</tt> </tt>
-<a name="L1293"></a><tt class="py-lineno">1293</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-237" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-237', 'http', 'link-66');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L1293"></a><tt class="py-lineno">1293</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-233" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-233', 'http', 'link-66');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1294"></a><tt class="py-lineno">1294</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">:</tt> </tt>
-<a name="L1295"></a><tt class="py-lineno">1295</tt> <tt class="py-line"> <tt id="link-238" class="py-name"><a title="googleapiclient.http.HttpMock.request
+<a name="L1295"></a><tt class="py-lineno">1295</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-238', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
-<a name="L1296"></a><tt class="py-lineno">1296</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-239" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-234', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
+<a name="L1296"></a><tt class="py-lineno">1296</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-235" 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-239', 'request', 'link-63');">request</a></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="L1297"></a><tt class="py-lineno">1297</tt> <tt class="py-line"> <tt id="link-240" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-240', 'http', 'link-66');">http</a></tt> <tt class="py-op">=</tt> <tt id="link-241" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-235', 'request', 'link-63');">request</a></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="L1297"></a><tt class="py-lineno">1297</tt> <tt class="py-line"> <tt id="link-236" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-236', 'http', 'link-66');">http</a></tt> <tt class="py-op">=</tt> <tt id="link-237" 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-241', 'request', 'link-63');">request</a></tt><tt class="py-op">.</tt><tt id="link-242" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-242', 'http', 'link-66');">http</a></tt> </tt>
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-237', 'request', 'link-63');">request</a></tt><tt class="py-op">.</tt><tt id="link-238" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-238', 'http', 'link-66');">http</a></tt> </tt>
<a name="L1298"></a><tt class="py-lineno">1298</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L1299"></a><tt class="py-lineno">1299</tt> <tt class="py-line"> </tt>
-<a name="L1300"></a><tt class="py-lineno">1300</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-243" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-243', 'http', 'link-66');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L1300"></a><tt class="py-lineno">1300</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-239" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-239', 'http', 'link-66');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1301"></a><tt class="py-lineno">1301</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">"Missing a valid http object."</tt><tt class="py-op">)</tt> </tt>
<a name="L1302"></a><tt class="py-lineno">1302</tt> <tt class="py-line"> </tt>
-<a name="L1303"></a><tt class="py-lineno">1303</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-244" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._execute()=googleapiclient.http.BatchHttpRequest-class.html#_execute"><a title="googleapiclient.http.BatchHttpRequest._execute" class="py-name" href="#" onclick="return doclink('link-244', '_execute', 'link-244');">_execute</a></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-66');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">)</tt> </tt>
+<a name="L1303"></a><tt class="py-lineno">1303</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-240" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._execute()=googleapiclient.http.BatchHttpRequest-class.html#_execute"><a title="googleapiclient.http.BatchHttpRequest._execute" class="py-name" href="#" onclick="return doclink('link-240', '_execute', 'link-240');">_execute</a></tt><tt class="py-op">(</tt><tt id="link-241" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-241', 'http', 'link-66');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">)</tt> </tt>
<a name="L1304"></a><tt class="py-lineno">1304</tt> <tt class="py-line"> </tt>
<a name="L1305"></a><tt class="py-lineno">1305</tt> <tt class="py-line"> <tt class="py-comment"># Loop over all the requests and check for 401s. For each 401 request the</tt> </tt>
<a name="L1306"></a><tt class="py-lineno">1306</tt> <tt class="py-line"> <tt class="py-comment"># credentials should be refreshed and then sent again in a separate batch.</tt> </tt>
@@ -1630,21 +1627,21 @@
<a name="L1311"></a><tt class="py-lineno">1311</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 class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_responses</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
<a name="L1312"></a><tt class="py-lineno">1312</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-string">'status'</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'401'</tt><tt class="py-op">:</tt> </tt>
<a name="L1313"></a><tt class="py-lineno">1313</tt> <tt class="py-line"> <tt class="py-name">redo_order</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt>
-<a name="L1314"></a><tt class="py-lineno">1314</tt> <tt class="py-line"> <tt id="link-246" class="py-name"><a title="googleapiclient.http.HttpMock.request
+<a name="L1314"></a><tt class="py-lineno">1314</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-246', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
-<a name="L1315"></a><tt class="py-lineno">1315</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.http.BatchHttpRequest._refresh_and_apply_credentials()=googleapiclient.http.BatchHttpRequest-class.html#_refresh_and_apply_credentials"><a title="googleapiclient.http.BatchHttpRequest._refresh_and_apply_credentials" class="py-name" href="#" onclick="return doclink('link-247', '_refresh_and_apply_credentials', 'link-247');">_refresh_and_apply_credentials</a></tt><tt class="py-op">(</tt><tt id="link-248" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-242', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
+<a name="L1315"></a><tt class="py-lineno">1315</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-243" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest._refresh_and_apply_credentials()=googleapiclient.http.BatchHttpRequest-class.html#_refresh_and_apply_credentials"><a title="googleapiclient.http.BatchHttpRequest._refresh_and_apply_credentials" class="py-name" href="#" onclick="return doclink('link-243', '_refresh_and_apply_credentials', 'link-243');">_refresh_and_apply_credentials</a></tt><tt class="py-op">(</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-248', 'request', 'link-63');">request</a></tt><tt class="py-op">,</tt> <tt id="link-249" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-249', 'http', 'link-66');">http</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L1316"></a><tt class="py-lineno">1316</tt> <tt class="py-line"> <tt class="py-name">redo_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-250" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-244', 'request', 'link-63');">request</a></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-66');">http</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L1316"></a><tt class="py-lineno">1316</tt> <tt class="py-line"> <tt class="py-name">redo_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-246" 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-250', 'request', 'link-63');">request</a></tt> </tt>
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-246', 'request', 'link-63');">request</a></tt> </tt>
<a name="L1317"></a><tt class="py-lineno">1317</tt> <tt class="py-line"> </tt>
<a name="L1318"></a><tt class="py-lineno">1318</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">redo_requests</tt><tt class="py-op">:</tt> </tt>
-<a name="L1319"></a><tt class="py-lineno">1319</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-251" class="py-name"><a title="googleapiclient.http.BatchHttpRequest._execute" class="py-name" href="#" onclick="return doclink('link-251', '_execute', 'link-244');">_execute</a></tt><tt class="py-op">(</tt><tt id="link-252" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-252', 'http', 'link-66');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">redo_order</tt><tt class="py-op">,</tt> <tt class="py-name">redo_requests</tt><tt class="py-op">)</tt> </tt>
+<a name="L1319"></a><tt class="py-lineno">1319</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-247" class="py-name"><a title="googleapiclient.http.BatchHttpRequest._execute" class="py-name" href="#" onclick="return doclink('link-247', '_execute', 'link-240');">_execute</a></tt><tt class="py-op">(</tt><tt id="link-248" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-248', 'http', 'link-66');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">redo_order</tt><tt class="py-op">,</tt> <tt class="py-name">redo_requests</tt><tt class="py-op">)</tt> </tt>
<a name="L1320"></a><tt class="py-lineno">1320</tt> <tt class="py-line"> </tt>
<a name="L1321"></a><tt class="py-lineno">1321</tt> <tt class="py-line"> <tt class="py-comment"># Now process all callbacks that are erroring, and raise an exception for</tt> </tt>
<a name="L1322"></a><tt class="py-lineno">1322</tt> <tt class="py-line"> <tt class="py-comment"># ones that return a non-2xx response? Or add extra parameter to callback</tt> </tt>
@@ -1653,35 +1650,35 @@
<a name="L1325"></a><tt class="py-lineno">1325</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">:</tt> </tt>
<a name="L1326"></a><tt class="py-lineno">1326</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 class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_responses</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
<a name="L1327"></a><tt class="py-lineno">1327</tt> <tt class="py-line"> </tt>
-<a name="L1328"></a><tt class="py-lineno">1328</tt> <tt class="py-line"> <tt id="link-253" class="py-name"><a title="googleapiclient.http.HttpMock.request
+<a name="L1328"></a><tt class="py-lineno">1328</tt> <tt class="py-line"> <tt id="link-249" 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-253', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-249', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
<a name="L1329"></a><tt class="py-lineno">1329</tt> <tt class="py-line"> <tt class="py-name">callback</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callbacks</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt>
<a name="L1330"></a><tt class="py-lineno">1330</tt> <tt class="py-line"> </tt>
-<a name="L1331"></a><tt class="py-lineno">1331</tt> <tt class="py-line"> <tt id="link-254" class="py-name"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-254', 'response', 'link-234');">response</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
+<a name="L1331"></a><tt class="py-lineno">1331</tt> <tt class="py-line"> <tt id="link-250" class="py-name"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-250', 'response', 'link-230');">response</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1332"></a><tt class="py-lineno">1332</tt> <tt class="py-line"> <tt class="py-name">exception</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1333"></a><tt class="py-lineno">1333</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1334"></a><tt class="py-lineno">1334</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">300</tt><tt class="py-op">:</tt> </tt>
-<a name="L1335"></a><tt class="py-lineno">1335</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-255" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-255', 'HttpError', 'link-7');">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 id="link-256" class="py-name"><a title="googleapiclient.http.HttpMock.request
+<a name="L1335"></a><tt class="py-lineno">1335</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-251" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-251', 'HttpError', 'link-7');">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 id="link-252" 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-256', 'request', 'link-63');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt> </tt>
-<a name="L1336"></a><tt class="py-lineno">1336</tt> <tt class="py-line"> <tt id="link-257" class="py-name"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-257', 'response', 'link-234');">response</a></tt> <tt class="py-op">=</tt> <tt id="link-258" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-252', 'request', 'link-63');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt> </tt>
+<a name="L1336"></a><tt class="py-lineno">1336</tt> <tt class="py-line"> <tt id="link-253" class="py-name"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-253', 'response', 'link-230');">response</a></tt> <tt class="py-op">=</tt> <tt id="link-254" 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-258', 'request', 'link-63');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">postproc</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>
-<a name="L1337"></a><tt class="py-lineno">1337</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-259" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-259', 'HttpError', 'link-7');">HttpError</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-254', 'request', 'link-63');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">postproc</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>
+<a name="L1337"></a><tt class="py-lineno">1337</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-255" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-255', 'HttpError', 'link-7');">HttpError</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L1338"></a><tt class="py-lineno">1338</tt> <tt class="py-line"> <tt class="py-name">exception</tt> <tt class="py-op">=</tt> <tt class="py-name">e</tt> </tt>
<a name="L1339"></a><tt class="py-lineno">1339</tt> <tt class="py-line"> </tt>
<a name="L1340"></a><tt class="py-lineno">1340</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">callback</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="L1341"></a><tt class="py-lineno">1341</tt> <tt class="py-line"> <tt class="py-name">callback</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">,</tt> <tt id="link-260" class="py-name"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-260', 'response', 'link-234');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">exception</tt><tt class="py-op">)</tt> </tt>
+<a name="L1341"></a><tt class="py-lineno">1341</tt> <tt class="py-line"> <tt class="py-name">callback</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">,</tt> <tt id="link-256" class="py-name"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-256', 'response', 'link-230');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">exception</tt><tt class="py-op">)</tt> </tt>
<a name="L1342"></a><tt class="py-lineno">1342</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">_callback</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="L1343"></a><tt class="py-lineno">1343</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callback</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">,</tt> <tt id="link-261" class="py-name"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-261', 'response', 'link-234');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">exception</tt><tt class="py-op">)</tt> </tt>
+<a name="L1343"></a><tt class="py-lineno">1343</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callback</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">,</tt> <tt id="link-257" class="py-name"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-257', 'response', 'link-230');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">exception</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L1344"></a><tt class="py-lineno">1344</tt> <tt class="py-line"> </tt>
<a name="HttpRequestMock"></a><div id="HttpRequestMock-def"><a name="L1345"></a><tt class="py-lineno">1345</tt> <tt class="py-line"> </tt>
<a name="L1346"></a><tt class="py-lineno">1346</tt> <a class="py-toggle" href="#" id="HttpRequestMock-toggle" onclick="return toggle('HttpRequestMock');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.http.HttpRequestMock-class.html">HttpRequestMock</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
@@ -1767,31 +1764,31 @@
<a name="L1426"></a><tt class="py-lineno">1426</tt> <tt class="py-line"><tt class="py-docstring"> parameters and the expected response.</tt> </tt>
<a name="L1427"></a><tt class="py-lineno">1427</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1428"></a><tt class="py-lineno">1428</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">methodId</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">responses</tt><tt class="py-op">:</tt> </tt>
-<a name="L1429"></a><tt class="py-lineno">1429</tt> <tt class="py-line"> <tt id="link-262" class="py-name"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-262', 'response', 'link-234');">response</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">responses</tt><tt class="py-op">[</tt><tt class="py-name">methodId</tt><tt class="py-op">]</tt> </tt>
-<a name="L1430"></a><tt class="py-lineno">1430</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-263" class="py-name"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-263', 'response', 'link-234');">response</a></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="L1431"></a><tt class="py-lineno">1431</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-264" class="py-name"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-264', 'response', 'link-234');">response</a></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="L1429"></a><tt class="py-lineno">1429</tt> <tt class="py-line"> <tt id="link-258" class="py-name"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-258', 'response', 'link-230');">response</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">responses</tt><tt class="py-op">[</tt><tt class="py-name">methodId</tt><tt class="py-op">]</tt> </tt>
+<a name="L1430"></a><tt class="py-lineno">1430</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-259" class="py-name"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-259', 'response', 'link-230');">response</a></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="L1431"></a><tt class="py-lineno">1431</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-260" class="py-name"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-260', 'response', 'link-230');">response</a></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="L1432"></a><tt class="py-lineno">1432</tt> <tt class="py-line"> <tt class="py-comment"># Test the body against the supplied expected_body.</tt> </tt>
-<a name="L1433"></a><tt class="py-lineno">1433</tt> <tt class="py-line"> <tt class="py-name">expected_body</tt> <tt class="py-op">=</tt> <tt id="link-265" class="py-name"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-265', 'response', 'link-234');">response</a></tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> </tt>
-<a name="L1434"></a><tt class="py-lineno">1434</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">bool</tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-name">bool</tt><tt class="py-op">(</tt><tt id="link-266" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-266', 'body', 'link-54');">body</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1433"></a><tt class="py-lineno">1433</tt> <tt class="py-line"> <tt class="py-name">expected_body</tt> <tt class="py-op">=</tt> <tt id="link-261" class="py-name"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-261', 'response', 'link-230');">response</a></tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> </tt>
+<a name="L1434"></a><tt class="py-lineno">1434</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">bool</tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-name">bool</tt><tt class="py-op">(</tt><tt id="link-262" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-262', 'body', 'link-54');">body</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1435"></a><tt class="py-lineno">1435</tt> <tt class="py-line"> <tt class="py-comment"># Not expecting a body and provided one</tt> </tt>
<a name="L1436"></a><tt class="py-lineno">1436</tt> <tt class="py-line"> <tt class="py-comment"># or expecting a body and not provided one.</tt> </tt>
-<a name="L1437"></a><tt class="py-lineno">1437</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-267" class="py-name"><a title="googleapiclient.errors.UnexpectedBodyError" class="py-name" href="#" onclick="return doclink('link-267', 'UnexpectedBodyError', 'link-16');">UnexpectedBodyError</a></tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">,</tt> <tt id="link-268" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-268', 'body', 'link-54');">body</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L1437"></a><tt class="py-lineno">1437</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-263" class="py-name"><a title="googleapiclient.errors.UnexpectedBodyError" class="py-name" href="#" onclick="return doclink('link-263', 'UnexpectedBodyError', 'link-16');">UnexpectedBodyError</a></tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">,</tt> <tt id="link-264" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-264', 'body', 'link-54');">body</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1438"></a><tt class="py-lineno">1438</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">expected_body</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1439"></a><tt class="py-lineno">1439</tt> <tt class="py-line"> <tt class="py-name">expected_body</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">expected_body</tt><tt class="py-op">)</tt> </tt>
-<a name="L1440"></a><tt class="py-lineno">1440</tt> <tt class="py-line"> <tt id="link-269" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-269', 'body', 'link-54');">body</a></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 id="link-270" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-270', 'body', 'link-54');">body</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L1441"></a><tt class="py-lineno">1441</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-271" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-271', 'body', 'link-54');">body</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">expected_body</tt><tt class="py-op">:</tt> </tt>
-<a name="L1442"></a><tt class="py-lineno">1442</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-272" class="py-name"><a title="googleapiclient.errors.UnexpectedBodyError" class="py-name" href="#" onclick="return doclink('link-272', 'UnexpectedBodyError', 'link-16');">UnexpectedBodyError</a></tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">,</tt> <tt id="link-273" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-273', 'body', 'link-54');">body</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L1443"></a><tt class="py-lineno">1443</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-274" class="py-name" targets="Class googleapiclient.http.HttpRequestMock=googleapiclient.http.HttpRequestMock-class.html"><a title="googleapiclient.http.HttpRequestMock" class="py-name" href="#" onclick="return doclink('link-274', 'HttpRequestMock', 'link-274');">HttpRequestMock</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">postproc</tt><tt class="py-op">)</tt> </tt>
+<a name="L1440"></a><tt class="py-lineno">1440</tt> <tt class="py-line"> <tt id="link-265" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-265', 'body', 'link-54');">body</a></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 id="link-266" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-266', 'body', 'link-54');">body</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L1441"></a><tt class="py-lineno">1441</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-267" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-267', 'body', 'link-54');">body</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">expected_body</tt><tt class="py-op">:</tt> </tt>
+<a name="L1442"></a><tt class="py-lineno">1442</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-268" class="py-name"><a title="googleapiclient.errors.UnexpectedBodyError" class="py-name" href="#" onclick="return doclink('link-268', 'UnexpectedBodyError', 'link-16');">UnexpectedBodyError</a></tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">,</tt> <tt id="link-269" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-269', 'body', 'link-54');">body</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L1443"></a><tt class="py-lineno">1443</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-270" class="py-name" targets="Class googleapiclient.http.HttpRequestMock=googleapiclient.http.HttpRequestMock-class.html"><a title="googleapiclient.http.HttpRequestMock" class="py-name" href="#" onclick="return doclink('link-270', 'HttpRequestMock', 'link-270');">HttpRequestMock</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">postproc</tt><tt class="py-op">)</tt> </tt>
<a name="L1444"></a><tt class="py-lineno">1444</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">check_unexpected</tt><tt class="py-op">:</tt> </tt>
-<a name="L1445"></a><tt class="py-lineno">1445</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-275" class="py-name"><a title="googleapiclient.errors.UnexpectedMethodError" class="py-name" href="#" onclick="return doclink('link-275', 'UnexpectedMethodError', 'link-19');">UnexpectedMethodError</a></tt><tt class="py-op">(</tt><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="L1445"></a><tt class="py-lineno">1445</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-271" class="py-name"><a title="googleapiclient.errors.UnexpectedMethodError" class="py-name" href="#" onclick="return doclink('link-271', 'UnexpectedMethodError', 'link-19');">UnexpectedMethodError</a></tt><tt class="py-op">(</tt><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="L1446"></a><tt class="py-lineno">1446</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L1447"></a><tt class="py-lineno">1447</tt> <tt class="py-line"> <tt id="link-276" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-276', 'model', 'link-21');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-277" class="py-name"><a title="googleapiclient.model.JsonModel" class="py-name" href="#" onclick="return doclink('link-277', 'JsonModel', 'link-22');">JsonModel</a></tt><tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
-<a name="L1448"></a><tt class="py-lineno">1448</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-278" class="py-name"><a title="googleapiclient.http.HttpRequestMock" class="py-name" href="#" onclick="return doclink('link-278', 'HttpRequestMock', 'link-274');">HttpRequestMock</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-string">'{}'</tt><tt class="py-op">,</tt> <tt id="link-279" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-279', 'model', 'link-21');">model</a></tt><tt class="py-op">.</tt><tt id="link-280" class="py-name"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-280', 'response', 'link-234');">response</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L1447"></a><tt class="py-lineno">1447</tt> <tt class="py-line"> <tt id="link-272" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-272', 'model', 'link-21');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-273" class="py-name"><a title="googleapiclient.model.JsonModel" class="py-name" href="#" onclick="return doclink('link-273', 'JsonModel', 'link-22');">JsonModel</a></tt><tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
+<a name="L1448"></a><tt class="py-lineno">1448</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-274" class="py-name"><a title="googleapiclient.http.HttpRequestMock" class="py-name" href="#" onclick="return doclink('link-274', 'HttpRequestMock', 'link-270');">HttpRequestMock</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-string">'{}'</tt><tt class="py-op">,</tt> <tt id="link-275" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-275', 'model', 'link-21');">model</a></tt><tt class="py-op">.</tt><tt id="link-276" class="py-name"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-276', 'response', 'link-230');">response</a></tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L1449"></a><tt class="py-lineno">1449</tt> <tt class="py-line"> </tt>
<a name="HttpMock"></a><div id="HttpMock-def"><a name="L1450"></a><tt class="py-lineno">1450</tt> <tt class="py-line"> </tt>
<a name="L1451"></a><tt class="py-lineno">1451</tt> <a class="py-toggle" href="#" id="HttpMock-toggle" onclick="return toggle('HttpMock');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.http.HttpMock-class.html">HttpMock</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
@@ -1804,10 +1801,10 @@
<a name="L1458"></a><tt class="py-lineno">1458</tt> <tt class="py-line"><tt class="py-docstring"> headers: dict, header to return with response</tt> </tt>
<a name="L1459"></a><tt class="py-lineno">1459</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1460"></a><tt class="py-lineno">1460</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">headers</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L1461"></a><tt class="py-lineno">1461</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'status'</tt><tt class="py-op">:</tt> <tt class="py-string">'200 OK'</tt><tt class="py-op">}</tt> </tt>
+<a name="L1461"></a><tt class="py-lineno">1461</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'status'</tt><tt class="py-op">:</tt> <tt class="py-string">'200'</tt><tt class="py-op">}</tt> </tt>
<a name="L1462"></a><tt class="py-lineno">1462</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">filename</tt><tt class="py-op">:</tt> </tt>
<a name="L1463"></a><tt class="py-lineno">1463</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">)</tt> </tt>
-<a name="L1464"></a><tt class="py-lineno">1464</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-281" class="py-name"><a title="googleapiclient.http._StreamSlice.read" class="py-name" href="#" onclick="return doclink('link-281', 'read', 'link-37');">read</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L1464"></a><tt class="py-lineno">1464</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-277" class="py-name"><a title="googleapiclient.http._StreamSlice.read" class="py-name" href="#" onclick="return doclink('link-277', 'read', 'link-37');">read</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1465"></a><tt class="py-lineno">1465</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1466"></a><tt class="py-lineno">1466</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1467"></a><tt class="py-lineno">1467</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
@@ -1815,7 +1812,7 @@
<a name="L1469"></a><tt class="py-lineno">1469</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1470"></a><tt class="py-lineno">1470</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1471"></a><tt class="py-lineno">1471</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
-<a name="L1472"></a><tt class="py-lineno">1472</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-282" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-282', 'body', 'link-54');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
+<a name="L1472"></a><tt class="py-lineno">1472</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-278" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-278', 'body', 'link-54');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1473"></a><tt class="py-lineno">1473</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L1474"></a><tt class="py-lineno">1474</tt> <tt class="py-line"> </tt>
<a name="L1475"></a><tt class="py-lineno">1475</tt> <tt class="py-line"> </tt>
@@ -1827,7 +1824,7 @@
<a name="L1481"></a><tt class="py-lineno">1481</tt> <tt class="py-line"> <tt class="py-param">connection_type</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="HttpMock.request-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpMock.request-expanded"><a name="L1482"></a><tt class="py-lineno">1482</tt> <tt class="py-line"> <tt class="py-name">self</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="L1483"></a><tt class="py-lineno">1483</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-name">method</tt> </tt>
-<a name="L1484"></a><tt class="py-lineno">1484</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-283" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-283', 'body', 'link-54');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-284" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-284', 'body', 'link-54');">body</a></tt> </tt>
+<a name="L1484"></a><tt class="py-lineno">1484</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-279" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-279', 'body', 'link-54');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-280" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-280', 'body', 'link-54');">body</a></tt> </tt>
<a name="L1485"></a><tt class="py-lineno">1485</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-name">headers</tt> </tt>
<a name="L1486"></a><tt class="py-lineno">1486</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Response</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">response_headers</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">data</tt> </tt>
</div></div><a name="L1487"></a><tt class="py-lineno">1487</tt> <tt class="py-line"> </tt>
@@ -1876,107 +1873,109 @@
<a name="L1530"></a><tt class="py-lineno">1530</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">content</tt> <tt class="py-op">==</tt> <tt class="py-string">'echo_request_headers_as_json'</tt><tt class="py-op">:</tt> </tt>
<a name="L1531"></a><tt class="py-lineno">1531</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">dumps</tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt>
<a name="L1532"></a><tt class="py-lineno">1532</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">content</tt> <tt class="py-op">==</tt> <tt class="py-string">'echo_request_body'</tt><tt class="py-op">:</tt> </tt>
-<a name="L1533"></a><tt class="py-lineno">1533</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-285" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-285', 'body', 'link-54');">body</a></tt><tt class="py-op">,</tt> <tt class="py-string">'read'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1534"></a><tt class="py-lineno">1534</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-286" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-286', 'body', 'link-54');">body</a></tt><tt class="py-op">.</tt><tt id="link-287" class="py-name"><a title="googleapiclient.http._StreamSlice.read" class="py-name" href="#" onclick="return doclink('link-287', 'read', 'link-37');">read</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L1533"></a><tt class="py-lineno">1533</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-281" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-281', 'body', 'link-54');">body</a></tt><tt class="py-op">,</tt> <tt class="py-string">'read'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1534"></a><tt class="py-lineno">1534</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-282" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-282', 'body', 'link-54');">body</a></tt><tt class="py-op">.</tt><tt id="link-283" class="py-name"><a title="googleapiclient.http._StreamSlice.read" class="py-name" href="#" onclick="return doclink('link-283', 'read', 'link-37');">read</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1535"></a><tt class="py-lineno">1535</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L1536"></a><tt class="py-lineno">1536</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-288" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-288', 'body', 'link-54');">body</a></tt> </tt>
+<a name="L1536"></a><tt class="py-lineno">1536</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-284" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-284', 'body', 'link-54');">body</a></tt> </tt>
<a name="L1537"></a><tt class="py-lineno">1537</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">content</tt> <tt class="py-op">==</tt> <tt class="py-string">'echo_request_uri'</tt><tt class="py-op">:</tt> </tt>
<a name="L1538"></a><tt class="py-lineno">1538</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">uri</tt> </tt>
-<a name="L1539"></a><tt class="py-lineno">1539</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Response</tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt>
-</div></div><a name="L1540"></a><tt class="py-lineno">1540</tt> <tt class="py-line"> </tt>
-<a name="set_user_agent"></a><div id="set_user_agent-def"><a name="L1541"></a><tt class="py-lineno">1541</tt> <tt class="py-line"> </tt>
-<a name="L1542"></a><tt class="py-lineno">1542</tt> <a class="py-toggle" href="#" id="set_user_agent-toggle" onclick="return toggle('set_user_agent');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http-module.html#set_user_agent">set_user_agent</a><tt class="py-op">(</tt><tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">user_agent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="set_user_agent-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_user_agent-expanded"><a name="L1543"></a><tt class="py-lineno">1543</tt> <tt class="py-line"> <tt class="py-docstring">"""Set the user-agent on every request.</tt> </tt>
-<a name="L1544"></a><tt class="py-lineno">1544</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1545"></a><tt class="py-lineno">1545</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L1546"></a><tt class="py-lineno">1546</tt> <tt class="py-line"><tt class="py-docstring"> http - An instance of httplib2.Http</tt> </tt>
-<a name="L1547"></a><tt class="py-lineno">1547</tt> <tt class="py-line"><tt class="py-docstring"> or something that acts like it.</tt> </tt>
-<a name="L1548"></a><tt class="py-lineno">1548</tt> <tt class="py-line"><tt class="py-docstring"> user_agent: string, the value for the user-agent header.</tt> </tt>
-<a name="L1549"></a><tt class="py-lineno">1549</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1550"></a><tt class="py-lineno">1550</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L1551"></a><tt class="py-lineno">1551</tt> <tt class="py-line"><tt class="py-docstring"> A modified instance of http that was passed in.</tt> </tt>
-<a name="L1552"></a><tt class="py-lineno">1552</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1553"></a><tt class="py-lineno">1553</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt>
+<a name="L1539"></a><tt class="py-lineno">1539</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">content</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">text_type</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1540"></a><tt class="py-lineno">1540</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">encode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt> </tt>
+<a name="L1541"></a><tt class="py-lineno">1541</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Response</tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt>
+</div></div><a name="L1542"></a><tt class="py-lineno">1542</tt> <tt class="py-line"> </tt>
+<a name="set_user_agent"></a><div id="set_user_agent-def"><a name="L1543"></a><tt class="py-lineno">1543</tt> <tt class="py-line"> </tt>
+<a name="L1544"></a><tt class="py-lineno">1544</tt> <a class="py-toggle" href="#" id="set_user_agent-toggle" onclick="return toggle('set_user_agent');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http-module.html#set_user_agent">set_user_agent</a><tt class="py-op">(</tt><tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">user_agent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="set_user_agent-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_user_agent-expanded"><a name="L1545"></a><tt class="py-lineno">1545</tt> <tt class="py-line"> <tt class="py-docstring">"""Set the user-agent on every request.</tt> </tt>
+<a name="L1546"></a><tt class="py-lineno">1546</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1547"></a><tt class="py-lineno">1547</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L1548"></a><tt class="py-lineno">1548</tt> <tt class="py-line"><tt class="py-docstring"> http - An instance of httplib2.Http</tt> </tt>
+<a name="L1549"></a><tt class="py-lineno">1549</tt> <tt class="py-line"><tt class="py-docstring"> or something that acts like it.</tt> </tt>
+<a name="L1550"></a><tt class="py-lineno">1550</tt> <tt class="py-line"><tt class="py-docstring"> user_agent: string, the value for the user-agent header.</tt> </tt>
+<a name="L1551"></a><tt class="py-lineno">1551</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1552"></a><tt class="py-lineno">1552</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L1553"></a><tt class="py-lineno">1553</tt> <tt class="py-line"><tt class="py-docstring"> A modified instance of http that was passed in.</tt> </tt>
<a name="L1554"></a><tt class="py-lineno">1554</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1555"></a><tt class="py-lineno">1555</tt> <tt class="py-line"><tt class="py-docstring"> h = httplib2.Http()</tt> </tt>
-<a name="L1556"></a><tt class="py-lineno">1556</tt> <tt class="py-line"><tt class="py-docstring"> h = set_user_agent(h, "my-app-name/6.0")</tt> </tt>
-<a name="L1557"></a><tt class="py-lineno">1557</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1558"></a><tt class="py-lineno">1558</tt> <tt class="py-line"><tt class="py-docstring"> Most of the time the user-agent will be set doing auth, this is for the rare</tt> </tt>
-<a name="L1559"></a><tt class="py-lineno">1559</tt> <tt class="py-line"><tt class="py-docstring"> cases where you are accessing an unauthenticated endpoint.</tt> </tt>
-<a name="L1560"></a><tt class="py-lineno">1560</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L1561"></a><tt class="py-lineno">1561</tt> <tt class="py-line"> <tt class="py-name">request_orig</tt> <tt class="py-op">=</tt> <tt id="link-289" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-289', 'http', 'link-66');">http</a></tt><tt class="py-op">.</tt><tt id="link-290" class="py-name"><a title="googleapiclient.http.HttpMock.request
+<a name="L1555"></a><tt class="py-lineno">1555</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt>
+<a name="L1556"></a><tt class="py-lineno">1556</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1557"></a><tt class="py-lineno">1557</tt> <tt class="py-line"><tt class="py-docstring"> h = httplib2.Http()</tt> </tt>
+<a name="L1558"></a><tt class="py-lineno">1558</tt> <tt class="py-line"><tt class="py-docstring"> h = set_user_agent(h, "my-app-name/6.0")</tt> </tt>
+<a name="L1559"></a><tt class="py-lineno">1559</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1560"></a><tt class="py-lineno">1560</tt> <tt class="py-line"><tt class="py-docstring"> Most of the time the user-agent will be set doing auth, this is for the rare</tt> </tt>
+<a name="L1561"></a><tt class="py-lineno">1561</tt> <tt class="py-line"><tt class="py-docstring"> cases where you are accessing an unauthenticated endpoint.</tt> </tt>
+<a name="L1562"></a><tt class="py-lineno">1562</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1563"></a><tt class="py-lineno">1563</tt> <tt class="py-line"> <tt class="py-name">request_orig</tt> <tt class="py-op">=</tt> <tt id="link-285" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-285', 'http', 'link-66');">http</a></tt><tt class="py-op">.</tt><tt id="link-286" 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-290', 'request', 'link-63');">request</a></tt> </tt>
-<a name="L1562"></a><tt class="py-lineno">1562</tt> <tt class="py-line"> </tt>
-<a name="L1563"></a><tt class="py-lineno">1563</tt> <tt class="py-line"> <tt class="py-comment"># The closure that will replace 'httplib2.Http.request'.</tt> </tt>
-<a name="L1564"></a><tt class="py-lineno">1564</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">new_request</tt><tt class="py-op">(</tt><tt class="py-param">uri</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">=</tt><tt class="py-string">'GET'</tt><tt class="py-op">,</tt> <tt class="py-param">body</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L1565"></a><tt class="py-lineno">1565</tt> <tt class="py-line"> <tt class="py-param">redirections</tt><tt class="py-op">=</tt><tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">DEFAULT_MAX_REDIRECTS</tt><tt class="py-op">,</tt> </tt>
-<a name="L1566"></a><tt class="py-lineno">1566</tt> <tt class="py-line"> <tt class="py-param">connection_type</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="L1567"></a><tt class="py-lineno">1567</tt> <tt class="py-line"> <tt class="py-docstring">"""Modify the request headers to add the user-agent."""</tt> </tt>
-<a name="L1568"></a><tt class="py-lineno">1568</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">headers</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L1569"></a><tt class="py-lineno">1569</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="L1570"></a><tt class="py-lineno">1570</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'user-agent'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">headers</tt><tt class="py-op">:</tt> </tt>
-<a name="L1571"></a><tt class="py-lineno">1571</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'user-agent'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">user_agent</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'user-agent'</tt><tt class="py-op">]</tt> </tt>
-<a name="L1572"></a><tt class="py-lineno">1572</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L1573"></a><tt class="py-lineno">1573</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'user-agent'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">user_agent</tt> </tt>
-<a name="L1574"></a><tt class="py-lineno">1574</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 class="py-name">request_orig</tt><tt class="py-op">(</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">,</tt> <tt id="link-291" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-291', 'body', 'link-54');">body</a></tt><tt class="py-op">,</tt> <tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt>
-<a name="L1575"></a><tt class="py-lineno">1575</tt> <tt class="py-line"> <tt class="py-name">redirections</tt><tt class="py-op">,</tt> <tt class="py-name">connection_type</tt><tt class="py-op">)</tt> </tt>
-<a name="L1576"></a><tt class="py-lineno">1576</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt>
-</div><a name="L1577"></a><tt class="py-lineno">1577</tt> <tt class="py-line"> </tt>
-<a name="L1578"></a><tt class="py-lineno">1578</tt> <tt class="py-line"> <tt id="link-292" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-292', 'http', 'link-66');">http</a></tt><tt class="py-op">.</tt><tt id="link-293" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-286', 'request', 'link-63');">request</a></tt> </tt>
+<a name="L1564"></a><tt class="py-lineno">1564</tt> <tt class="py-line"> </tt>
+<a name="L1565"></a><tt class="py-lineno">1565</tt> <tt class="py-line"> <tt class="py-comment"># The closure that will replace 'httplib2.Http.request'.</tt> </tt>
+<a name="L1566"></a><tt class="py-lineno">1566</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">new_request</tt><tt class="py-op">(</tt><tt class="py-param">uri</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">=</tt><tt class="py-string">'GET'</tt><tt class="py-op">,</tt> <tt class="py-param">body</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L1567"></a><tt class="py-lineno">1567</tt> <tt class="py-line"> <tt class="py-param">redirections</tt><tt class="py-op">=</tt><tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">DEFAULT_MAX_REDIRECTS</tt><tt class="py-op">,</tt> </tt>
+<a name="L1568"></a><tt class="py-lineno">1568</tt> <tt class="py-line"> <tt class="py-param">connection_type</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="L1569"></a><tt class="py-lineno">1569</tt> <tt class="py-line"> <tt class="py-docstring">"""Modify the request headers to add the user-agent."""</tt> </tt>
+<a name="L1570"></a><tt class="py-lineno">1570</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">headers</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L1571"></a><tt class="py-lineno">1571</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="L1572"></a><tt class="py-lineno">1572</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'user-agent'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">headers</tt><tt class="py-op">:</tt> </tt>
+<a name="L1573"></a><tt class="py-lineno">1573</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'user-agent'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">user_agent</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'user-agent'</tt><tt class="py-op">]</tt> </tt>
+<a name="L1574"></a><tt class="py-lineno">1574</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L1575"></a><tt class="py-lineno">1575</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'user-agent'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">user_agent</tt> </tt>
+<a name="L1576"></a><tt class="py-lineno">1576</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 class="py-name">request_orig</tt><tt class="py-op">(</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">,</tt> <tt id="link-287" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-287', 'body', 'link-54');">body</a></tt><tt class="py-op">,</tt> <tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt>
+<a name="L1577"></a><tt class="py-lineno">1577</tt> <tt class="py-line"> <tt class="py-name">redirections</tt><tt class="py-op">,</tt> <tt class="py-name">connection_type</tt><tt class="py-op">)</tt> </tt>
+<a name="L1578"></a><tt class="py-lineno">1578</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt>
+</div><a name="L1579"></a><tt class="py-lineno">1579</tt> <tt class="py-line"> </tt>
+<a name="L1580"></a><tt class="py-lineno">1580</tt> <tt class="py-line"> <tt id="link-288" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-288', 'http', 'link-66');">http</a></tt><tt class="py-op">.</tt><tt id="link-289" 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-293', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">new_request</tt> </tt>
-<a name="L1579"></a><tt class="py-lineno">1579</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-294" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-294', 'http', 'link-66');">http</a></tt> </tt>
-</div><a name="L1580"></a><tt class="py-lineno">1580</tt> <tt class="py-line"> </tt>
-<a name="tunnel_patch"></a><div id="tunnel_patch-def"><a name="L1581"></a><tt class="py-lineno">1581</tt> <tt class="py-line"> </tt>
-<a name="L1582"></a><tt class="py-lineno">1582</tt> <a class="py-toggle" href="#" id="tunnel_patch-toggle" onclick="return toggle('tunnel_patch');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http-module.html#tunnel_patch">tunnel_patch</a><tt class="py-op">(</tt><tt class="py-param">http</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="tunnel_patch-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="tunnel_patch-expanded"><a name="L1583"></a><tt class="py-lineno">1583</tt> <tt class="py-line"> <tt class="py-docstring">"""Tunnel PATCH requests over POST.</tt> </tt>
-<a name="L1584"></a><tt class="py-lineno">1584</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L1585"></a><tt class="py-lineno">1585</tt> <tt class="py-line"><tt class="py-docstring"> http - An instance of httplib2.Http</tt> </tt>
-<a name="L1586"></a><tt class="py-lineno">1586</tt> <tt class="py-line"><tt class="py-docstring"> or something that acts like it.</tt> </tt>
-<a name="L1587"></a><tt class="py-lineno">1587</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1588"></a><tt class="py-lineno">1588</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L1589"></a><tt class="py-lineno">1589</tt> <tt class="py-line"><tt class="py-docstring"> A modified instance of http that was passed in.</tt> </tt>
-<a name="L1590"></a><tt class="py-lineno">1590</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1591"></a><tt class="py-lineno">1591</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt>
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-289', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">new_request</tt> </tt>
+<a name="L1581"></a><tt class="py-lineno">1581</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-290" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-290', 'http', 'link-66');">http</a></tt> </tt>
+</div><a name="L1582"></a><tt class="py-lineno">1582</tt> <tt class="py-line"> </tt>
+<a name="tunnel_patch"></a><div id="tunnel_patch-def"><a name="L1583"></a><tt class="py-lineno">1583</tt> <tt class="py-line"> </tt>
+<a name="L1584"></a><tt class="py-lineno">1584</tt> <a class="py-toggle" href="#" id="tunnel_patch-toggle" onclick="return toggle('tunnel_patch');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.http-module.html#tunnel_patch">tunnel_patch</a><tt class="py-op">(</tt><tt class="py-param">http</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="tunnel_patch-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="tunnel_patch-expanded"><a name="L1585"></a><tt class="py-lineno">1585</tt> <tt class="py-line"> <tt class="py-docstring">"""Tunnel PATCH requests over POST.</tt> </tt>
+<a name="L1586"></a><tt class="py-lineno">1586</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L1587"></a><tt class="py-lineno">1587</tt> <tt class="py-line"><tt class="py-docstring"> http - An instance of httplib2.Http</tt> </tt>
+<a name="L1588"></a><tt class="py-lineno">1588</tt> <tt class="py-line"><tt class="py-docstring"> or something that acts like it.</tt> </tt>
+<a name="L1589"></a><tt class="py-lineno">1589</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1590"></a><tt class="py-lineno">1590</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L1591"></a><tt class="py-lineno">1591</tt> <tt class="py-line"><tt class="py-docstring"> A modified instance of http that was passed in.</tt> </tt>
<a name="L1592"></a><tt class="py-lineno">1592</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1593"></a><tt class="py-lineno">1593</tt> <tt class="py-line"><tt class="py-docstring"> h = httplib2.Http()</tt> </tt>
-<a name="L1594"></a><tt class="py-lineno">1594</tt> <tt class="py-line"><tt class="py-docstring"> h = tunnel_patch(h, "my-app-name/6.0")</tt> </tt>
-<a name="L1595"></a><tt class="py-lineno">1595</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1596"></a><tt class="py-lineno">1596</tt> <tt class="py-line"><tt class="py-docstring"> Useful if you are running on a platform that doesn't support PATCH.</tt> </tt>
-<a name="L1597"></a><tt class="py-lineno">1597</tt> <tt class="py-line"><tt class="py-docstring"> Apply this last if you are using OAuth 1.0, as changing the method</tt> </tt>
-<a name="L1598"></a><tt class="py-lineno">1598</tt> <tt class="py-line"><tt class="py-docstring"> will result in a different signature.</tt> </tt>
-<a name="L1599"></a><tt class="py-lineno">1599</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L1600"></a><tt class="py-lineno">1600</tt> <tt class="py-line"> <tt class="py-name">request_orig</tt> <tt class="py-op">=</tt> <tt id="link-295" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-295', 'http', 'link-66');">http</a></tt><tt class="py-op">.</tt><tt id="link-296" class="py-name"><a title="googleapiclient.http.HttpMock.request
+<a name="L1593"></a><tt class="py-lineno">1593</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt>
+<a name="L1594"></a><tt class="py-lineno">1594</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1595"></a><tt class="py-lineno">1595</tt> <tt class="py-line"><tt class="py-docstring"> h = httplib2.Http()</tt> </tt>
+<a name="L1596"></a><tt class="py-lineno">1596</tt> <tt class="py-line"><tt class="py-docstring"> h = tunnel_patch(h, "my-app-name/6.0")</tt> </tt>
+<a name="L1597"></a><tt class="py-lineno">1597</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1598"></a><tt class="py-lineno">1598</tt> <tt class="py-line"><tt class="py-docstring"> Useful if you are running on a platform that doesn't support PATCH.</tt> </tt>
+<a name="L1599"></a><tt class="py-lineno">1599</tt> <tt class="py-line"><tt class="py-docstring"> Apply this last if you are using OAuth 1.0, as changing the method</tt> </tt>
+<a name="L1600"></a><tt class="py-lineno">1600</tt> <tt class="py-line"><tt class="py-docstring"> will result in a different signature.</tt> </tt>
+<a name="L1601"></a><tt class="py-lineno">1601</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1602"></a><tt class="py-lineno">1602</tt> <tt class="py-line"> <tt class="py-name">request_orig</tt> <tt class="py-op">=</tt> <tt id="link-291" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-291', 'http', 'link-66');">http</a></tt><tt class="py-op">.</tt><tt id="link-292" 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-296', 'request', 'link-63');">request</a></tt> </tt>
-<a name="L1601"></a><tt class="py-lineno">1601</tt> <tt class="py-line"> </tt>
-<a name="L1602"></a><tt class="py-lineno">1602</tt> <tt class="py-line"> <tt class="py-comment"># The closure that will replace 'httplib2.Http.request'.</tt> </tt>
-<a name="L1603"></a><tt class="py-lineno">1603</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">new_request</tt><tt class="py-op">(</tt><tt class="py-param">uri</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">=</tt><tt class="py-string">'GET'</tt><tt class="py-op">,</tt> <tt class="py-param">body</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L1604"></a><tt class="py-lineno">1604</tt> <tt class="py-line"> <tt class="py-param">redirections</tt><tt class="py-op">=</tt><tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">DEFAULT_MAX_REDIRECTS</tt><tt class="py-op">,</tt> </tt>
-<a name="L1605"></a><tt class="py-lineno">1605</tt> <tt class="py-line"> <tt class="py-param">connection_type</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="L1606"></a><tt class="py-lineno">1606</tt> <tt class="py-line"> <tt class="py-docstring">"""Modify the request headers to add the user-agent."""</tt> </tt>
-<a name="L1607"></a><tt class="py-lineno">1607</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">headers</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L1608"></a><tt class="py-lineno">1608</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="L1609"></a><tt class="py-lineno">1609</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">method</tt> <tt class="py-op">==</tt> <tt class="py-string">'PATCH'</tt><tt class="py-op">:</tt> </tt>
-<a name="L1610"></a><tt class="py-lineno">1610</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'oauth_token'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">headers</tt><tt class="py-op">.</tt><tt id="link-297" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-297', 'get', 'link-83');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'authorization'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1611"></a><tt class="py-lineno">1611</tt> <tt class="py-line"> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">warning</tt><tt class="py-op">(</tt> </tt>
-<a name="L1612"></a><tt class="py-lineno">1612</tt> <tt class="py-line"> <tt class="py-string">'OAuth 1.0 request made with Credentials after tunnel_patch.'</tt><tt class="py-op">)</tt> </tt>
-<a name="L1613"></a><tt class="py-lineno">1613</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'x-http-method-override'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">"PATCH"</tt> </tt>
-<a name="L1614"></a><tt class="py-lineno">1614</tt> <tt class="py-line"> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-string">'POST'</tt> </tt>
-<a name="L1615"></a><tt class="py-lineno">1615</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 class="py-name">request_orig</tt><tt class="py-op">(</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">,</tt> <tt id="link-298" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-298', 'body', 'link-54');">body</a></tt><tt class="py-op">,</tt> <tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt>
-<a name="L1616"></a><tt class="py-lineno">1616</tt> <tt class="py-line"> <tt class="py-name">redirections</tt><tt class="py-op">,</tt> <tt class="py-name">connection_type</tt><tt class="py-op">)</tt> </tt>
-<a name="L1617"></a><tt class="py-lineno">1617</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt>
-</div><a name="L1618"></a><tt class="py-lineno">1618</tt> <tt class="py-line"> </tt>
-<a name="L1619"></a><tt class="py-lineno">1619</tt> <tt class="py-line"> <tt id="link-299" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-299', 'http', 'link-66');">http</a></tt><tt class="py-op">.</tt><tt id="link-300" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-292', 'request', 'link-63');">request</a></tt> </tt>
+<a name="L1603"></a><tt class="py-lineno">1603</tt> <tt class="py-line"> </tt>
+<a name="L1604"></a><tt class="py-lineno">1604</tt> <tt class="py-line"> <tt class="py-comment"># The closure that will replace 'httplib2.Http.request'.</tt> </tt>
+<a name="L1605"></a><tt class="py-lineno">1605</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">new_request</tt><tt class="py-op">(</tt><tt class="py-param">uri</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">=</tt><tt class="py-string">'GET'</tt><tt class="py-op">,</tt> <tt class="py-param">body</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L1606"></a><tt class="py-lineno">1606</tt> <tt class="py-line"> <tt class="py-param">redirections</tt><tt class="py-op">=</tt><tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">DEFAULT_MAX_REDIRECTS</tt><tt class="py-op">,</tt> </tt>
+<a name="L1607"></a><tt class="py-lineno">1607</tt> <tt class="py-line"> <tt class="py-param">connection_type</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="L1608"></a><tt class="py-lineno">1608</tt> <tt class="py-line"> <tt class="py-docstring">"""Modify the request headers to add the user-agent."""</tt> </tt>
+<a name="L1609"></a><tt class="py-lineno">1609</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">headers</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L1610"></a><tt class="py-lineno">1610</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="L1611"></a><tt class="py-lineno">1611</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">method</tt> <tt class="py-op">==</tt> <tt class="py-string">'PATCH'</tt><tt class="py-op">:</tt> </tt>
+<a name="L1612"></a><tt class="py-lineno">1612</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'oauth_token'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">headers</tt><tt class="py-op">.</tt><tt id="link-293" class="py-name"><a title="googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-293', 'get', 'link-83');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'authorization'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1613"></a><tt class="py-lineno">1613</tt> <tt class="py-line"> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">warning</tt><tt class="py-op">(</tt> </tt>
+<a name="L1614"></a><tt class="py-lineno">1614</tt> <tt class="py-line"> <tt class="py-string">'OAuth 1.0 request made with Credentials after tunnel_patch.'</tt><tt class="py-op">)</tt> </tt>
+<a name="L1615"></a><tt class="py-lineno">1615</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'x-http-method-override'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">"PATCH"</tt> </tt>
+<a name="L1616"></a><tt class="py-lineno">1616</tt> <tt class="py-line"> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-string">'POST'</tt> </tt>
+<a name="L1617"></a><tt class="py-lineno">1617</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 class="py-name">request_orig</tt><tt class="py-op">(</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">,</tt> <tt id="link-294" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-294', 'body', 'link-54');">body</a></tt><tt class="py-op">,</tt> <tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt>
+<a name="L1618"></a><tt class="py-lineno">1618</tt> <tt class="py-line"> <tt class="py-name">redirections</tt><tt class="py-op">,</tt> <tt class="py-name">connection_type</tt><tt class="py-op">)</tt> </tt>
+<a name="L1619"></a><tt class="py-lineno">1619</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt>
+</div><a name="L1620"></a><tt class="py-lineno">1620</tt> <tt class="py-line"> </tt>
+<a name="L1621"></a><tt class="py-lineno">1621</tt> <tt class="py-line"> <tt id="link-295" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-295', 'http', 'link-66');">http</a></tt><tt class="py-op">.</tt><tt id="link-296" 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-300', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">new_request</tt> </tt>
-<a name="L1620"></a><tt class="py-lineno">1620</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-301" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-301', 'http', 'link-66');">http</a></tt> </tt>
-</div><a name="L1621"></a><tt class="py-lineno">1621</tt> <tt class="py-line"> </tt><script type="text/javascript">
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-296', 'request', 'link-63');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">new_request</tt> </tt>
+<a name="L1622"></a><tt class="py-lineno">1622</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-297" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-297', 'http', 'link-66');">http</a></tt> </tt>
+</div><a name="L1623"></a><tt class="py-lineno">1623</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
@@ -2009,7 +2008,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 a6b7235..0d367ad 100644
--- a/docs/epy/googleapiclient.http.BatchHttpRequest-class.html
+++ b/docs/epy/googleapiclient.http.BatchHttpRequest-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 ec8811d..584707d 100644
--- a/docs/epy/googleapiclient.http.HttpMock-class.html
+++ b/docs/epy/googleapiclient.http.HttpMock-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 a3057e1..1732cd9 100644
--- a/docs/epy/googleapiclient.http.HttpMockSequence-class.html
+++ b/docs/epy/googleapiclient.http.HttpMockSequence-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 bdb4797..0e2baf9 100644
--- a/docs/epy/googleapiclient.http.HttpRequest-class.html
+++ b/docs/epy/googleapiclient.http.HttpRequest-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 ecd9c69..c332074 100644
--- a/docs/epy/googleapiclient.http.HttpRequestMock-class.html
+++ b/docs/epy/googleapiclient.http.HttpRequestMock-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 da1480f..f05849f 100644
--- a/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html
+++ b/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html
@@ -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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 3af190f..05b5ebb 100644
--- a/docs/epy/googleapiclient.http.MediaFileUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaFileUpload-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 530ec00..693b282 100644
--- a/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 77cc996..9fd77cc 100644
--- a/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html
+++ b/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 bd3f9b8..41f4b57 100644
--- a/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 889c83a..b66c5ba 100644
--- a/docs/epy/googleapiclient.http.MediaUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaUpload-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 55ee1c0..8380174 100644
--- a/docs/epy/googleapiclient.http.MediaUploadProgress-class.html
+++ b/docs/epy/googleapiclient.http.MediaUploadProgress-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 05e4fb6..eaa0c42 100644
--- a/docs/epy/googleapiclient.http.RequestMockBuilder-class.html
+++ b/docs/epy/googleapiclient.http.RequestMockBuilder-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 38017ae..e41782c 100644
--- a/docs/epy/googleapiclient.http._StreamSlice-class.html
+++ b/docs/epy/googleapiclient.http._StreamSlice-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 20c0099..62826c0 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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 f53ffb7..554dc61 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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 16b33a7..469c9d5 100644
--- a/docs/epy/googleapiclient.model-module.html
+++ b/docs/epy/googleapiclient.model-module.html
@@ -299,7 +299,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 0cd05b6..3019bf4 100644
--- a/docs/epy/googleapiclient.model-pysrc.html
+++ b/docs/epy/googleapiclient.model-pysrc.html
@@ -566,7 +566,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 fd34283..0b03e36 100644
--- a/docs/epy/googleapiclient.model.BaseModel-class.html
+++ b/docs/epy/googleapiclient.model.BaseModel-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 ca0cb45..414c3d2 100644
--- a/docs/epy/googleapiclient.model.JsonModel-class.html
+++ b/docs/epy/googleapiclient.model.JsonModel-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 7bb1f98..57204d7 100644
--- a/docs/epy/googleapiclient.model.MediaModel-class.html
+++ b/docs/epy/googleapiclient.model.MediaModel-class.html
@@ -68,10 +68,10 @@
<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_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="node3_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="node3" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,69,409,149"/>
-<area shape="rect" id="node4" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="177,5,239,51"/>
+<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_35.gif" alt='' usemap="#uml_class_diagram_for_googleap_35" 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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 e529778..cae8bb6 100644
--- a/docs/epy/googleapiclient.model.Model-class.html
+++ b/docs/epy/googleapiclient.model.Model-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 f0fd467..185e3fe 100644
--- a/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html
+++ b/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 353d251..ae593be 100644
--- a/docs/epy/googleapiclient.model.RawModel-class.html
+++ b/docs/epy/googleapiclient.model.RawModel-class.html
@@ -68,10 +68,10 @@
<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_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="node3_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="node3" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,69,409,149"/>
-<area shape="rect" id="node4" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="177,5,239,51"/>
+<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_38.gif" alt='' usemap="#uml_class_diagram_for_googleap_38" 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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 d5a37d2..9c33e33 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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 40d252e..d98f162 100644
--- a/docs/epy/googleapiclient.sample_tools-pysrc.html
+++ b/docs/epy/googleapiclient.sample_tools-pysrc.html
@@ -192,7 +192,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 6dda4f0..3881bfc 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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 7b9a12f..0b3731f 100644
--- a/docs/epy/googleapiclient.schema-pysrc.html
+++ b/docs/epy/googleapiclient.schema-pysrc.html
@@ -402,7 +402,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 cdeb2e1..6556ab5 100644
--- a/docs/epy/googleapiclient.schema.Schemas-class.html
+++ b/docs/epy/googleapiclient.schema.Schemas-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 4dbe3b4..cb5043c 100644
--- a/docs/epy/googleapiclient.schema._SchemaToStruct-class.html
+++ b/docs/epy/googleapiclient.schema._SchemaToStruct-class.html
@@ -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 Tue Mar 10 23:27:51 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:26 2015
</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 aa82a7e..23e78ac 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 Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 a313149..f55094b 100644
--- a/docs/epy/identifier-index.html
+++ b/docs/epy/identifier-index.html
@@ -879,7 +879,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</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 f194867..31e7282 100644
--- a/docs/epy/module-tree.html
+++ b/docs/epy/module-tree.html
@@ -94,7 +94,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Mar 10 23:27:50 2015
+ Generated by Epydoc 3.0.1 on Mon Jun 15 16:43:25 2015
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"