docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/analytics_v3.management.customDimensions.html b/docs/dyn/analytics_v3.management.customDimensions.html
index be63e19..fee1c2f 100644
--- a/docs/dyn/analytics_v3.management.customDimensions.html
+++ b/docs/dyn/analytics_v3.management.customDimensions.html
@@ -103,21 +103,21 @@
An object of the form:
{ # JSON template for Analytics Custom Dimension.
- "index": 42, # Index of the custom dimension.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "name": "A String", # Name of the custom dimension.
- "created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
- "webPropertyId": "A String", # Property ID.
- "active": True or False, # Boolean indicating whether the custom dimension is active.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
- "href": "A String", # Link to the property to which the custom dimension belongs.
- "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
+ "created": "A String", # Time the custom dimension was created.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
+ "active": True or False, # Boolean indicating whether the custom dimension is active.
+ "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
+ "href": "A String", # Link to the property to which the custom dimension belongs.
+ "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
},
- "id": "A String", # Custom dimension ID.
- "selfLink": "A String", # Link for the custom dimension
- "accountId": "A String", # Account ID.
+ "name": "A String", # Name of the custom dimension.
+ "accountId": "A String", # Account ID.
+ "id": "A String", # Custom dimension ID.
+ "webPropertyId": "A String", # Property ID.
+ "selfLink": "A String", # Link for the custom dimension
+ "updated": "A String", # Time the custom dimension was last modified.
+ "index": 42, # Index of the custom dimension.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
}</pre>
</div>
@@ -132,21 +132,21 @@
The object takes the form of:
{ # JSON template for Analytics Custom Dimension.
- "index": 42, # Index of the custom dimension.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "name": "A String", # Name of the custom dimension.
- "created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
- "webPropertyId": "A String", # Property ID.
- "active": True or False, # Boolean indicating whether the custom dimension is active.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
- "href": "A String", # Link to the property to which the custom dimension belongs.
- "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
+ "created": "A String", # Time the custom dimension was created.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
+ "active": True or False, # Boolean indicating whether the custom dimension is active.
+ "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
+ "href": "A String", # Link to the property to which the custom dimension belongs.
+ "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
},
- "id": "A String", # Custom dimension ID.
- "selfLink": "A String", # Link for the custom dimension
- "accountId": "A String", # Account ID.
+ "name": "A String", # Name of the custom dimension.
+ "accountId": "A String", # Account ID.
+ "id": "A String", # Custom dimension ID.
+ "webPropertyId": "A String", # Property ID.
+ "selfLink": "A String", # Link for the custom dimension
+ "updated": "A String", # Time the custom dimension was last modified.
+ "index": 42, # Index of the custom dimension.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
}
@@ -154,21 +154,21 @@
An object of the form:
{ # JSON template for Analytics Custom Dimension.
- "index": 42, # Index of the custom dimension.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "name": "A String", # Name of the custom dimension.
- "created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
- "webPropertyId": "A String", # Property ID.
- "active": True or False, # Boolean indicating whether the custom dimension is active.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
- "href": "A String", # Link to the property to which the custom dimension belongs.
- "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
+ "created": "A String", # Time the custom dimension was created.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
+ "active": True or False, # Boolean indicating whether the custom dimension is active.
+ "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
+ "href": "A String", # Link to the property to which the custom dimension belongs.
+ "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
},
- "id": "A String", # Custom dimension ID.
- "selfLink": "A String", # Link for the custom dimension
- "accountId": "A String", # Account ID.
+ "name": "A String", # Name of the custom dimension.
+ "accountId": "A String", # Account ID.
+ "id": "A String", # Custom dimension ID.
+ "webPropertyId": "A String", # Property ID.
+ "selfLink": "A String", # Link for the custom dimension
+ "updated": "A String", # Time the custom dimension was last modified.
+ "index": 42, # Index of the custom dimension.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
}</pre>
</div>
@@ -186,32 +186,32 @@
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.
- "username": "A String", # Email ID of the authenticated user
- "kind": "analytics#customDimensions", # Collection type.
- "items": [ # Collection of custom dimensions.
+ "nextLink": "A String", # Link to next page for this custom dimension collection.
+ "previousLink": "A String", # Link to previous 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.
+ "items": [ # Collection of custom dimensions.
{ # JSON template for Analytics Custom Dimension.
- "index": 42, # Index of the custom dimension.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "name": "A String", # Name of the custom dimension.
- "created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
- "webPropertyId": "A String", # Property ID.
- "active": True or False, # Boolean indicating whether the custom dimension is active.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
- "href": "A String", # Link to the property to which the custom dimension belongs.
- "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
+ "created": "A String", # Time the custom dimension was created.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
+ "active": True or False, # Boolean indicating whether the custom dimension is active.
+ "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
+ "href": "A String", # Link to the property to which the custom dimension belongs.
+ "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
},
- "id": "A String", # Custom dimension ID.
- "selfLink": "A String", # Link for the custom dimension
- "accountId": "A String", # Account ID.
+ "name": "A String", # Name of the custom dimension.
+ "accountId": "A String", # Account ID.
+ "id": "A String", # Custom dimension ID.
+ "webPropertyId": "A String", # Property ID.
+ "selfLink": "A String", # Link for the custom dimension
+ "updated": "A String", # Time the custom dimension was last modified.
+ "index": 42, # Index of the custom dimension.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
},
],
- "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.
- "nextLink": "A String", # Link to next page for this custom dimension collection.
- "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.
- "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
+ "username": "A String", # Email ID of the authenticated user
+ "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.
+ "kind": "analytics#customDimensions", # Collection type.
}</pre>
</div>
@@ -227,21 +227,21 @@
The object takes the form of:
{ # JSON template for Analytics Custom Dimension.
- "index": 42, # Index of the custom dimension.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "name": "A String", # Name of the custom dimension.
- "created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
- "webPropertyId": "A String", # Property ID.
- "active": True or False, # Boolean indicating whether the custom dimension is active.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
- "href": "A String", # Link to the property to which the custom dimension belongs.
- "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
+ "created": "A String", # Time the custom dimension was created.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
+ "active": True or False, # Boolean indicating whether the custom dimension is active.
+ "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
+ "href": "A String", # Link to the property to which the custom dimension belongs.
+ "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
},
- "id": "A String", # Custom dimension ID.
- "selfLink": "A String", # Link for the custom dimension
- "accountId": "A String", # Account ID.
+ "name": "A String", # Name of the custom dimension.
+ "accountId": "A String", # Account ID.
+ "id": "A String", # Custom dimension ID.
+ "webPropertyId": "A String", # Property ID.
+ "selfLink": "A String", # Link for the custom dimension
+ "updated": "A String", # Time the custom dimension was last modified.
+ "index": 42, # Index of the custom dimension.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
}
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 +250,21 @@
An object of the form:
{ # JSON template for Analytics Custom Dimension.
- "index": 42, # Index of the custom dimension.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "name": "A String", # Name of the custom dimension.
- "created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
- "webPropertyId": "A String", # Property ID.
- "active": True or False, # Boolean indicating whether the custom dimension is active.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
- "href": "A String", # Link to the property to which the custom dimension belongs.
- "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
+ "created": "A String", # Time the custom dimension was created.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
+ "active": True or False, # Boolean indicating whether the custom dimension is active.
+ "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
+ "href": "A String", # Link to the property to which the custom dimension belongs.
+ "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
},
- "id": "A String", # Custom dimension ID.
- "selfLink": "A String", # Link for the custom dimension
- "accountId": "A String", # Account ID.
+ "name": "A String", # Name of the custom dimension.
+ "accountId": "A String", # Account ID.
+ "id": "A String", # Custom dimension ID.
+ "webPropertyId": "A String", # Property ID.
+ "selfLink": "A String", # Link for the custom dimension
+ "updated": "A String", # Time the custom dimension was last modified.
+ "index": 42, # Index of the custom dimension.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
}</pre>
</div>
@@ -280,21 +280,21 @@
The object takes the form of:
{ # JSON template for Analytics Custom Dimension.
- "index": 42, # Index of the custom dimension.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "name": "A String", # Name of the custom dimension.
- "created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
- "webPropertyId": "A String", # Property ID.
- "active": True or False, # Boolean indicating whether the custom dimension is active.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
- "href": "A String", # Link to the property to which the custom dimension belongs.
- "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
+ "created": "A String", # Time the custom dimension was created.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
+ "active": True or False, # Boolean indicating whether the custom dimension is active.
+ "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
+ "href": "A String", # Link to the property to which the custom dimension belongs.
+ "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
},
- "id": "A String", # Custom dimension ID.
- "selfLink": "A String", # Link for the custom dimension
- "accountId": "A String", # Account ID.
+ "name": "A String", # Name of the custom dimension.
+ "accountId": "A String", # Account ID.
+ "id": "A String", # Custom dimension ID.
+ "webPropertyId": "A String", # Property ID.
+ "selfLink": "A String", # Link for the custom dimension
+ "updated": "A String", # Time the custom dimension was last modified.
+ "index": 42, # Index of the custom dimension.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
}
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 +303,21 @@
An object of the form:
{ # JSON template for Analytics Custom Dimension.
- "index": 42, # Index of the custom dimension.
- "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
- "name": "A String", # Name of the custom dimension.
- "created": "A String", # Time the custom dimension was created.
- "updated": "A String", # Time the custom dimension was last modified.
- "webPropertyId": "A String", # Property ID.
- "active": True or False, # Boolean indicating whether the custom dimension is active.
- "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
- "href": "A String", # Link to the property to which the custom dimension belongs.
- "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
+ "created": "A String", # Time the custom dimension was created.
+ "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
+ "active": True or False, # Boolean indicating whether the custom dimension is active.
+ "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
+ "href": "A String", # Link to the property to which the custom dimension belongs.
+ "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
},
- "id": "A String", # Custom dimension ID.
- "selfLink": "A String", # Link for the custom dimension
- "accountId": "A String", # Account ID.
+ "name": "A String", # Name of the custom dimension.
+ "accountId": "A String", # Account ID.
+ "id": "A String", # Custom dimension ID.
+ "webPropertyId": "A String", # Property ID.
+ "selfLink": "A String", # Link for the custom dimension
+ "updated": "A String", # Time the custom dimension was last modified.
+ "index": 42, # Index of the custom dimension.
+ "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
}</pre>
</div>