docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/analytics_v3.management.customDimensions.html b/docs/dyn/analytics_v3.management.customDimensions.html
index 0e5d3f0..ea86ee4 100644
--- a/docs/dyn/analytics_v3.management.customDimensions.html
+++ b/docs/dyn/analytics_v3.management.customDimensions.html
@@ -75,13 +75,16 @@
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.customDimensions.html">customDimensions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#get">get(accountId, webPropertyId, customDimensionId)</a></code></p>
<p class="firstline">Get a custom dimension to which the user has access.</p>
<p class="toc_element">
<code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p>
<p class="firstline">Create a new custom dimension.</p>
<p class="toc_element">
- <code><a href="#list">list(accountId, webPropertyId, start_index=None, max_results=None)</a></code></p>
+ <code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists custom dimensions to which the user has access.</p>
<p class="toc_element">
<code><a href="#patch">patch(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p>
@@ -91,6 +94,11 @@
<p class="firstline">Updates an existing custom dimension.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(accountId, webPropertyId, customDimensionId)</code>
<pre>Get a custom dimension to which the user has access.
@@ -103,21 +111,21 @@
An object of the form:
{ # JSON template for Analytics Custom Dimension.
- "name": "A String", # Name of the custom dimension.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "webPropertyId": "A String", # Property ID.
"created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
+ "webPropertyId": "A String", # Property ID.
+ "name": "A String", # Name of the custom dimension.
"active": True or False, # Boolean indicating whether the custom dimension is active.
- "accountId": "A String", # Account ID.
+ "updated": "A String", # Time the custom dimension was last modified.
"selfLink": "A String", # Link for the custom dimension
- "id": "A String", # Custom dimension ID.
"index": 42, # Index of the custom dimension.
+ "id": "A String", # Custom dimension ID.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
"parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
"href": "A String", # Link to the property to which the custom dimension belongs.
},
+ "accountId": "A String", # Account ID.
}</pre>
</div>
@@ -132,21 +140,21 @@
The object takes the form of:
{ # JSON template for Analytics Custom Dimension.
- "name": "A String", # Name of the custom dimension.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "webPropertyId": "A String", # Property ID.
"created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
+ "webPropertyId": "A String", # Property ID.
+ "name": "A String", # Name of the custom dimension.
"active": True or False, # Boolean indicating whether the custom dimension is active.
- "accountId": "A String", # Account ID.
+ "updated": "A String", # Time the custom dimension was last modified.
"selfLink": "A String", # Link for the custom dimension
- "id": "A String", # Custom dimension ID.
"index": 42, # Index of the custom dimension.
+ "id": "A String", # Custom dimension ID.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
"parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
"href": "A String", # Link to the property to which the custom dimension belongs.
},
+ "accountId": "A String", # Account ID.
}
@@ -154,64 +162,64 @@
An object of the form:
{ # JSON template for Analytics Custom Dimension.
- "name": "A String", # Name of the custom dimension.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "webPropertyId": "A String", # Property ID.
"created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
+ "webPropertyId": "A String", # Property ID.
+ "name": "A String", # Name of the custom dimension.
"active": True or False, # Boolean indicating whether the custom dimension is active.
- "accountId": "A String", # Account ID.
+ "updated": "A String", # Time the custom dimension was last modified.
"selfLink": "A String", # Link for the custom dimension
- "id": "A String", # Custom dimension ID.
"index": 42, # Index of the custom dimension.
+ "id": "A String", # Custom dimension ID.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
"parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
"href": "A String", # Link to the property to which the custom dimension belongs.
},
+ "accountId": "A String", # Account ID.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(accountId, webPropertyId, start_index=None, max_results=None)</code>
+ <code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>
<pre>Lists custom dimensions to which the user has access.
Args:
accountId: string, Account ID for the custom dimensions to retrieve. (required)
webPropertyId: string, Web property ID for the custom dimensions to retrieve. (required)
- start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
max_results: integer, The maximum number of custom dimensions to include in this response.
+ start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension.
- "kind": "analytics#customDimensions", # Collection type.
- "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
+ "username": "A String", # Email ID of the authenticated user
"items": [ # Collection of custom dimensions.
{ # JSON template for Analytics Custom Dimension.
- "name": "A String", # Name of the custom dimension.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "webPropertyId": "A String", # Property ID.
"created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
+ "webPropertyId": "A String", # Property ID.
+ "name": "A String", # Name of the custom dimension.
"active": True or False, # Boolean indicating whether the custom dimension is active.
- "accountId": "A String", # Account ID.
+ "updated": "A String", # Time the custom dimension was last modified.
"selfLink": "A String", # Link for the custom dimension
- "id": "A String", # Custom dimension ID.
"index": 42, # Index of the custom dimension.
+ "id": "A String", # Custom dimension ID.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
"parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
"href": "A String", # Link to the property to which the custom dimension belongs.
},
+ "accountId": "A String", # Account ID.
},
],
- "username": "A String", # Email ID of the authenticated user
- "nextLink": "A String", # Link to next page for this custom dimension collection.
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
+ "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
+ "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"previousLink": "A String", # Link to previous page for this custom dimension collection.
+ "kind": "analytics#customDimensions", # Collection type.
+ "nextLink": "A String", # Link to next page for this custom dimension collection.
}</pre>
</div>
@@ -227,21 +235,21 @@
The object takes the form of:
{ # JSON template for Analytics Custom Dimension.
- "name": "A String", # Name of the custom dimension.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "webPropertyId": "A String", # Property ID.
"created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
+ "webPropertyId": "A String", # Property ID.
+ "name": "A String", # Name of the custom dimension.
"active": True or False, # Boolean indicating whether the custom dimension is active.
- "accountId": "A String", # Account ID.
+ "updated": "A String", # Time the custom dimension was last modified.
"selfLink": "A String", # Link for the custom dimension
- "id": "A String", # Custom dimension ID.
"index": 42, # Index of the custom dimension.
+ "id": "A String", # Custom dimension ID.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
"parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
"href": "A String", # Link to the property to which the custom dimension belongs.
},
+ "accountId": "A String", # Account ID.
}
ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
@@ -250,21 +258,21 @@
An object of the form:
{ # JSON template for Analytics Custom Dimension.
- "name": "A String", # Name of the custom dimension.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "webPropertyId": "A String", # Property ID.
"created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
+ "webPropertyId": "A String", # Property ID.
+ "name": "A String", # Name of the custom dimension.
"active": True or False, # Boolean indicating whether the custom dimension is active.
- "accountId": "A String", # Account ID.
+ "updated": "A String", # Time the custom dimension was last modified.
"selfLink": "A String", # Link for the custom dimension
- "id": "A String", # Custom dimension ID.
"index": 42, # Index of the custom dimension.
+ "id": "A String", # Custom dimension ID.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
"parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
"href": "A String", # Link to the property to which the custom dimension belongs.
},
+ "accountId": "A String", # Account ID.
}</pre>
</div>
@@ -280,21 +288,21 @@
The object takes the form of:
{ # JSON template for Analytics Custom Dimension.
- "name": "A String", # Name of the custom dimension.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "webPropertyId": "A String", # Property ID.
"created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
+ "webPropertyId": "A String", # Property ID.
+ "name": "A String", # Name of the custom dimension.
"active": True or False, # Boolean indicating whether the custom dimension is active.
- "accountId": "A String", # Account ID.
+ "updated": "A String", # Time the custom dimension was last modified.
"selfLink": "A String", # Link for the custom dimension
- "id": "A String", # Custom dimension ID.
"index": 42, # Index of the custom dimension.
+ "id": "A String", # Custom dimension ID.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
"parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
"href": "A String", # Link to the property to which the custom dimension belongs.
},
+ "accountId": "A String", # Account ID.
}
ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
@@ -303,21 +311,21 @@
An object of the form:
{ # JSON template for Analytics Custom Dimension.
- "name": "A String", # Name of the custom dimension.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "webPropertyId": "A String", # Property ID.
"created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
+ "webPropertyId": "A String", # Property ID.
+ "name": "A String", # Name of the custom dimension.
"active": True or False, # Boolean indicating whether the custom dimension is active.
- "accountId": "A String", # Account ID.
+ "updated": "A String", # Time the custom dimension was last modified.
"selfLink": "A String", # Link for the custom dimension
- "id": "A String", # Custom dimension ID.
"index": 42, # Index of the custom dimension.
+ "id": "A String", # Custom dimension ID.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
"parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
"href": "A String", # Link to the property to which the custom dimension belongs.
},
+ "accountId": "A String", # Account ID.
}</pre>
</div>