diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index b3f0cd0c7f9..4453de8937e 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -10,4 +10,10 @@ # The python-samples-reviewers team is the default owner for samples changes /samples/ @googleapis/python-samples-owners +# For more information, see https://github.com/googleapis/repo-automation-bots/blob/master/packages/auto-approve/README.md .github/auto-approve.yml @googleapis/github-automation @googleapis/yoshi-python + +# The following is needed to auto-approve changes to static discovery artifacts and generated documentation. +/docs/dyn/*.html @yoshi-approver @googleapis/yoshi-python +/googleapiclient/discovery_cache/documents/*.json @yoshi-approver @googleapis/yoshi-python +/googleapiclient/discovery_cache/documents/index.md @yoshi-approver @googleapis/yoshi-python diff --git a/.repo-metadata.json b/.repo-metadata.json index 1b810b0be5a..83a8540be81 100644 --- a/.repo-metadata.json +++ b/.repo-metadata.json @@ -1,4 +1,4 @@ - + { "name": "google-api-python-client", "name_pretty": "Google API Python Client", @@ -6,6 +6,7 @@ "issue_tracker": "https://github.com/googleapis/google-api-python-client/issues", "release_level": "ga", "language": "python", + "library_type": "REST", "repo": "googleapis/google-api-python-client", "distribution_name": "google-api-python-client" - } \ No newline at end of file + } diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c6a6f4ef8f..80528742c8a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,34 @@ # Changelog +## [2.5.0](https://www.github.com/googleapis/google-api-python-client/compare/v2.4.0...v2.5.0) (2021-05-20) + + +### Features + +* **adexchangebuyer:** update the api https://github.com/googleapis/google-api-python-client/commit/46d87cb3e1f85ec9201134402b3c3afd2eb55770 ([7700bbf](https://www.github.com/googleapis/google-api-python-client/commit/7700bbffda386345cc4426ef413fc643f6368ef4)) +* **analyticsadmin:** update the api https://github.com/googleapis/google-api-python-client/commit/9648bae09873a132e7b4627096c153043911be6e ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **analyticsadmin:** update the api https://github.com/googleapis/google-api-python-client/commit/adaafffbdeab31f05f9ad62d0f58846313bb3858 ([7700bbf](https://www.github.com/googleapis/google-api-python-client/commit/7700bbffda386345cc4426ef413fc643f6368ef4)) +* **artifactregistry:** update the api https://github.com/googleapis/google-api-python-client/commit/7dd722fe8b0ae822f4847219c442aa67a1aae7fd ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **assuredworkloads:** update the api https://github.com/googleapis/google-api-python-client/commit/9b84ffce415133e860cc55bfbd3b9c15c3d46a24 ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **cloudasset:** update the api https://github.com/googleapis/google-api-python-client/commit/a8228db5ef31724493f0f62bf8062aca9adc44aa ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **cloudbuild:** update the api https://github.com/googleapis/google-api-python-client/commit/c9d8208c0f9579d958224566af369b809e13016a ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **compute:** update the api https://github.com/googleapis/google-api-python-client/commit/685c19d4b5262d27a2b1016e01186188afe610fd ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **container:** update the api https://github.com/googleapis/google-api-python-client/commit/c5cd244f996b1dfb605ef28eb22f8b0e76bffa1b ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **content:** update the api https://github.com/googleapis/google-api-python-client/commit/3b3e9be7e17c4efa89b45ac671a7c7f627a34cd7 ([7700bbf](https://www.github.com/googleapis/google-api-python-client/commit/7700bbffda386345cc4426ef413fc643f6368ef4)) +* **dialogflow:** update the api https://github.com/googleapis/google-api-python-client/commit/0c6b31fd2deb75ca1c023fed36903b638f5e74f8 ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **dialogflow:** update the api https://github.com/googleapis/google-api-python-client/commit/254b9413a2ede306917031a2117f7af2df28a103 ([7700bbf](https://www.github.com/googleapis/google-api-python-client/commit/7700bbffda386345cc4426ef413fc643f6368ef4)) +* **documentai:** update the api https://github.com/googleapis/google-api-python-client/commit/6dcec9fd8c0f803d37b4c8355870208e5a8c61ce ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **drive:** update the api https://github.com/googleapis/google-api-python-client/commit/8788823461610f31eebd655915e07def9690da48 ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **genomics:** update the api https://github.com/googleapis/google-api-python-client/commit/d0e6cc48df2d0a00d91ce6fbab83aa82146f3573 ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **logging:** update the api https://github.com/googleapis/google-api-python-client/commit/7f5fa161fd3db9ca6f2df23f5c8bd41ba01e9b9c ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **manufacturers:** update the api https://github.com/googleapis/google-api-python-client/commit/25bf19f14a09428ab3fc6e51b0f6812867f99b04 ([7700bbf](https://www.github.com/googleapis/google-api-python-client/commit/7700bbffda386345cc4426ef413fc643f6368ef4)) +* **privateca:** update the api https://github.com/googleapis/google-api-python-client/commit/0a5c31d74f788444640c174c413b12d494a00f1a ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **prod_tt_sasportal:** update the api https://github.com/googleapis/google-api-python-client/commit/af243b57a7039f4e01259fb085c7b07a66106fcf ([7700bbf](https://www.github.com/googleapis/google-api-python-client/commit/7700bbffda386345cc4426ef413fc643f6368ef4)) +* **pubsublite:** update the api https://github.com/googleapis/google-api-python-client/commit/dd67e9b117fdc8d0d0ecff6ade657003a95c12f7 ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **recommender:** update the api https://github.com/googleapis/google-api-python-client/commit/4b261d97bea2a8bc042a274c2d904be09da2d82c ([c2cd326](https://www.github.com/googleapis/google-api-python-client/commit/c2cd326ef156fc2652d23e4c64fd06e2d66e3a80)) +* **redis:** update the api https://github.com/googleapis/google-api-python-client/commit/5228389cbd5fceb1bf8c2d36086faa147d91e50f ([7700bbf](https://www.github.com/googleapis/google-api-python-client/commit/7700bbffda386345cc4426ef413fc643f6368ef4)) +* **remotebuildexecution:** update the api https://github.com/googleapis/google-api-python-client/commit/7c8b314e5508dda81cfb673039ea032f593fa97d ([7700bbf](https://www.github.com/googleapis/google-api-python-client/commit/7700bbffda386345cc4426ef413fc643f6368ef4)) + ## [2.4.0](https://www.github.com/googleapis/google-api-python-client/compare/v2.3.0...v2.4.0) (2021-05-11) diff --git a/docs/dyn/accessapproval_v1.folders.html b/docs/dyn/accessapproval_v1.folders.html index 883351922aa..bca1e5f5bb2 100644 --- a/docs/dyn/accessapproval_v1.folders.html +++ b/docs/dyn/accessapproval_v1.folders.html @@ -133,7 +133,7 @@
+ measurementProtocolSecrets()
+
Returns the measurementProtocolSecrets Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.measurementProtocolSecrets.html b/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.measurementProtocolSecrets.html new file mode 100644 index 00000000000..81314d2e279 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.measurementProtocolSecrets.html @@ -0,0 +1,246 @@ + + + +
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a measurement protocol secret.
+ +Deletes target MeasurementProtocolSecret.
+ +Lookup for a single "GA4" MeasurementProtocolSecret.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns child MeasurementProtocolSecrets under the specified parent Property.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a measurement protocol secret.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a measurement protocol secret.
+
+Args:
+ parent: string, Required. The parent resource where this secret will be created. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A secret value used for sending hits to Measurement Protocol.
+ "displayName": "A String", # Required. Human-readable display name for this secret.
+ "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+ "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A secret value used for sending hits to Measurement Protocol.
+ "displayName": "A String", # Required. Human-readable display name for this secret.
+ "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+ "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+}
+delete(name, x__xgafv=None)
+ Deletes target MeasurementProtocolSecret.
+
+Args:
+ name: string, Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+get(name, x__xgafv=None)
+ Lookup for a single "GA4" MeasurementProtocolSecret.
+
+Args:
+ name: string, Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A secret value used for sending hits to Measurement Protocol.
+ "displayName": "A String", # Required. Human-readable display name for this secret.
+ "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+ "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Returns child MeasurementProtocolSecrets under the specified parent Property.
+
+Args:
+ parent: string, Required. The resource name of the parent stream. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets (required)
+ pageSize: integer, The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum.
+ pageToken: string, A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ListMeasurementProtocolSecret RPC
+ "measurementProtocolSecrets": [ # A list of secrets for the parent stream specified in the request.
+ { # A secret value used for sending hits to Measurement Protocol.
+ "displayName": "A String", # Required. Human-readable display name for this secret.
+ "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+ "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a measurement protocol secret.
+
+Args:
+ name: string, Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A secret value used for sending hits to Measurement Protocol.
+ "displayName": "A String", # Required. Human-readable display name for this secret.
+ "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+ "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+}
+
+ updateMask: string, The list of fields to be updated. Omitted fields will not be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A secret value used for sending hits to Measurement Protocol.
+ "displayName": "A String", # Required. Human-readable display name for this secret.
+ "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+ "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a conversion event with the specified attributes.
+ +Deletes a conversion event in a property.
+ +Retrieve a single conversion event.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a conversion event with the specified attributes.
+
+Args:
+ parent: string, Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A conversion event in a Google Analytics property.
+ "createTime": "A String", # Output only. Time when this conversion event was created in the property.
+ "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
+ "isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+ "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A conversion event in a Google Analytics property.
+ "createTime": "A String", # Output only. Time when this conversion event was created in the property.
+ "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
+ "isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+ "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
+}
+delete(name, x__xgafv=None)
+ Deletes a conversion event in a property.
+
+Args:
+ name: string, Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+get(name, x__xgafv=None)
+ Retrieve a single conversion event.
+
+Args:
+ name: string, Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A conversion event in a Google Analytics property.
+ "createTime": "A String", # Output only. Time when this conversion event was created in the property.
+ "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
+ "isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+ "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+
+Args:
+ parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required)
+ pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
+ pageToken: string, A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ListConversionEvents RPC.
+ "conversionEvents": [ # The requested conversion events
+ { # A conversion event in a Google Analytics property.
+ "createTime": "A String", # Output only. Time when this conversion event was created in the property.
+ "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
+ "isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+ "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ archive(name, body=None, x__xgafv=None)
Archives a CustomDimension on a property.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a CustomDimension.
+ +Lookup for a single CustomDimension.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists CustomDimensions on a property.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a CustomDimension on a property.
+archive(name, body=None, x__xgafv=None)
+ Archives a CustomDimension on a property.
+
+Args:
+ name: string, Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678 (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ArchiveCustomDimension RPC.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a CustomDimension.
+
+Args:
+ parent: string, Required. Example format: properties/1234 (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A definition for a CustomDimension.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+ "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+ "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+ "scope": "A String", # Required. Immutable. The scope of this dimension.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A definition for a CustomDimension.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+ "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+ "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+ "scope": "A String", # Required. Immutable. The scope of this dimension.
+}
+get(name, x__xgafv=None)
+ Lookup for a single CustomDimension.
+
+Args:
+ name: string, Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678 (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A definition for a CustomDimension.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+ "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+ "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+ "scope": "A String", # Required. Immutable. The scope of this dimension.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists CustomDimensions on a property.
+
+Args:
+ parent: string, Required. Example format: properties/1234 (required)
+ pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
+ pageToken: string, A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ListCustomDimensions RPC.
+ "customDimensions": [ # List of CustomDimensions.
+ { # A definition for a CustomDimension.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+ "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+ "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+ "scope": "A String", # Required. Immutable. The scope of this dimension.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a CustomDimension on a property.
+
+Args:
+ name: string, Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A definition for a CustomDimension.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+ "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+ "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+ "scope": "A String", # Required. Immutable. The scope of this dimension.
+}
+
+ updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A definition for a CustomDimension.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+ "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+ "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+ "scope": "A String", # Required. Immutable. The scope of this dimension.
+}
+
+ archive(name, body=None, x__xgafv=None)
Archives a CustomMetric on a property.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a CustomMetric.
+ +Lookup for a single CustomMetric.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists CustomMetrics on a property.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a CustomMetric on a property.
+archive(name, body=None, x__xgafv=None)
+ Archives a CustomMetric on a property.
+
+Args:
+ name: string, Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678 (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ArchiveCustomMetric RPC.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a CustomMetric.
+
+Args:
+ parent: string, Required. Example format: properties/1234 (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A definition for a custom metric.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "measurementUnit": "A String", # Required. Immutable. The type for the custom metric's value.
+ "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+ "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+ "scope": "A String", # Required. Immutable. The scope of this custom metric.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A definition for a custom metric.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "measurementUnit": "A String", # Required. Immutable. The type for the custom metric's value.
+ "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+ "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+ "scope": "A String", # Required. Immutable. The scope of this custom metric.
+}
+get(name, x__xgafv=None)
+ Lookup for a single CustomMetric.
+
+Args:
+ name: string, Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678 (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A definition for a custom metric.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "measurementUnit": "A String", # Required. Immutable. The type for the custom metric's value.
+ "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+ "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+ "scope": "A String", # Required. Immutable. The scope of this custom metric.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists CustomMetrics on a property.
+
+Args:
+ parent: string, Required. Example format: properties/1234 (required)
+ pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
+ pageToken: string, A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomMetrics` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ListCustomMetrics RPC.
+ "customMetrics": [ # List of CustomMetrics.
+ { # A definition for a custom metric.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "measurementUnit": "A String", # Required. Immutable. The type for the custom metric's value.
+ "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+ "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+ "scope": "A String", # Required. Immutable. The scope of this custom metric.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a CustomMetric on a property.
+
+Args:
+ name: string, Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A definition for a custom metric.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "measurementUnit": "A String", # Required. Immutable. The type for the custom metric's value.
+ "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+ "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+ "scope": "A String", # Required. Immutable. The scope of this custom metric.
+}
+
+ updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A definition for a custom metric.
+ "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+ "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+ "measurementUnit": "A String", # Required. Immutable. The type for the custom metric's value.
+ "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+ "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+ "scope": "A String", # Required. Immutable. The scope of this custom metric.
+}
+Returns the androidAppDataStreams Resource.
+ +Returns the conversionEvents Resource.
+ + +Returns the customDimensions Resource.
+ +
+ customMetrics()
+
Returns the customMetrics Resource.
+ @@ -116,6 +131,9 @@Lookup for a single "GA4" Property.
+
+ getGoogleSignalsSettings(name, x__xgafv=None)
Lookup for Google Signals settings for a property.
list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
@@ -125,6 +143,9 @@
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a property.
+
+ updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)
Updates Google Signals settings for a property.
close()
@@ -230,6 +251,27 @@ getGoogleSignalsSettings(name, x__xgafv=None)
+ Lookup for Google Signals settings for a property.
+
+Args:
+ name: string, Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Settings values for Google Signals. This is a singleton resource.
+ "consent": "A String", # Output only. Terms of Service acceptance.
+ "name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
+ "state": "A String", # Status of this setting.
+}
+list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found. @@ -325,4 +367,35 @@Method Details
}
updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)
+ Updates Google Signals settings for a property.
+
+Args:
+ name: string, Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings" (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Settings values for Google Signals. This is a singleton resource.
+ "consent": "A String", # Output only. Terms of Service acceptance.
+ "name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
+ "state": "A String", # Status of this setting.
+}
+
+ updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Settings values for Google Signals. This is a singleton resource.
+ "consent": "A String", # Output only. Terms of Service acceptance.
+ "name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
+ "state": "A String", # Status of this setting.
+}
+