diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index 8db650a587a..8c4db719ef1 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -393,6 +393,11 @@

Method Details

"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. }, + "googleSignalsSettings": { # Settings values for Google Signals. This is a singleton resource. # A snapshot of a GoogleSignalsSettings resource in change history. + "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. + }, "iosAppDataStream": { # A resource message representing a Google Analytics IOS app stream. # A snapshot of an IosAppDataStream resource in change history. "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "createTime": "A String", # Output only. Time when this stream was originally created. @@ -401,6 +406,11 @@

Method Details

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/1000/iosAppDataStreams/2000" "updateTime": "A String", # Output only. Time when stream payload fields were last updated. }, + "measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history. + "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. + }, "property": { # A resource message representing a Google Analytics GA4 property. # A snapshot of a Property resource in change history. "createTime": "A String", # Output only. Time when the entity was originally created. "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY" @@ -477,6 +487,11 @@

Method Details

"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. "updateTime": "A String", # Output only. Time when this link was last updated. }, + "googleSignalsSettings": { # Settings values for Google Signals. This is a singleton resource. # A snapshot of a GoogleSignalsSettings resource in change history. + "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. + }, "iosAppDataStream": { # A resource message representing a Google Analytics IOS app stream. # A snapshot of an IosAppDataStream resource in change history. "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" "createTime": "A String", # Output only. Time when this stream was originally created. @@ -485,6 +500,11 @@

Method Details

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/1000/iosAppDataStreams/2000" "updateTime": "A String", # Output only. Time when stream payload fields were last updated. }, + "measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history. + "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. + }, "property": { # A resource message representing a Google Analytics GA4 property. # A snapshot of a Property resource in change history. "createTime": "A String", # Output only. Time when the entity was originally created. "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY" diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.html index ebb7cf95e97..2828401cdcb 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.html @@ -74,6 +74,11 @@

Google Analytics Admin API . properties . androidAppDataStreams

Instance Methods

+

+ measurementProtocolSecrets() +

+

Returns the measurementProtocolSecrets Resource.

+

close()

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 @@ + + + +

Google Analytics Admin API . properties . androidAppDataStreams . measurementProtocolSecrets

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a measurement protocol secret.

+

+ delete(name, x__xgafv=None)

+

Deletes target MeasurementProtocolSecret.

+

+ get(name, x__xgafv=None)

+

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.

+

Method Details

+
+ 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.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html index 2aad7fe5f15..73fedf18463 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.html @@ -131,6 +131,9 @@

Instance Methods

get(name, x__xgafv=None)

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.

@@ -140,6 +143,9 @@

Instance Methods

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.

Method Details

close() @@ -245,6 +251,27 @@

Method Details

}
+
+ 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.
@@ -340,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.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html index d6c735946d5..15b88c59791 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html @@ -74,6 +74,11 @@

Google Analytics Admin API . properties . iosAppDataStreams

Instance Methods

+

+ measurementProtocolSecrets() +

+

Returns the measurementProtocolSecrets Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.measurementProtocolSecrets.html b/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.measurementProtocolSecrets.html new file mode 100644 index 00000000000..b2c5b1d8522 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.measurementProtocolSecrets.html @@ -0,0 +1,246 @@ + + + +

Google Analytics Admin API . properties . iosAppDataStreams . measurementProtocolSecrets

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a measurement protocol secret.

+

+ delete(name, x__xgafv=None)

+

Deletes target MeasurementProtocolSecret.

+

+ get(name, x__xgafv=None)

+

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.

+

Method Details

+
+ 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.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html index 5a158cd886f..29642f2663b 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html @@ -74,6 +74,11 @@

Google Analytics Admin API . properties . webDataStreams

Instance Methods

+

+ measurementProtocolSecrets() +

+

Returns the measurementProtocolSecrets Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.measurementProtocolSecrets.html b/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.measurementProtocolSecrets.html new file mode 100644 index 00000000000..f626b7300b4 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.measurementProtocolSecrets.html @@ -0,0 +1,246 @@ + + + +

Google Analytics Admin API . properties . webDataStreams . measurementProtocolSecrets

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a measurement protocol secret.

+

+ delete(name, x__xgafv=None)

+

Deletes target MeasurementProtocolSecret.

+

+ get(name, x__xgafv=None)

+

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.

+

Method Details

+
+ 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.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 6e9462c5345..7f9483baa7b 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -711,6 +711,32 @@ "https://www.googleapis.com/auth/analytics.readonly" ] }, + "getGoogleSignalsSettings": { + "description": "Lookup for Google Signals settings for a property.", + "flatPath": "v1alpha/properties/{propertiesId}/googleSignalsSettings", + "httpMethod": "GET", + "id": "analyticsadmin.properties.getGoogleSignalsSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings", + "location": "path", + "pattern": "^properties/[^/]+/googleSignalsSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, "list": { "description": "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.", "flatPath": "v1alpha/properties", @@ -782,6 +808,40 @@ "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ] + }, + "updateGoogleSignalsSettings": { + "description": "Updates Google Signals settings for a property.", + "flatPath": "v1alpha/properties/{propertiesId}/googleSignalsSettings", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.updateGoogleSignalsSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: \"properties/1000/googleSignalsSettings\"", + "location": "path", + "pattern": "^properties/[^/]+/googleSignalsSettings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] } }, "resources": { @@ -909,6 +969,162 @@ "https://www.googleapis.com/auth/analytics.edit" ] } + }, + "resources": { + "measurementProtocolSecrets": { + "methods": { + "create": { + "description": "Creates a measurement protocol secret.", + "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}/measurementProtocolSecrets", + "httpMethod": "POST", + "id": "analyticsadmin.properties.androidAppDataStreams.measurementProtocolSecrets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "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}", + "location": "path", + "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/measurementProtocolSecrets", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes target MeasurementProtocolSecret.", + "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.androidAppDataStreams.measurementProtocolSecrets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "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.", + "location": "path", + "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single \"GA4\" MeasurementProtocolSecret.", + "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.androidAppDataStreams.measurementProtocolSecrets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "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.", + "location": "path", + "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns child MeasurementProtocolSecrets under the specified parent Property.", + "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}/measurementProtocolSecrets", + "httpMethod": "GET", + "id": "analyticsadmin.properties.androidAppDataStreams.measurementProtocolSecrets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "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", + "location": "path", + "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/measurementProtocolSecrets", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a measurement protocol secret.", + "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.androidAppDataStreams.measurementProtocolSecrets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "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}", + "location": "path", + "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated. Omitted fields will not be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + } } }, "conversionEvents": { @@ -1725,6 +1941,162 @@ "https://www.googleapis.com/auth/analytics.edit" ] } + }, + "resources": { + "measurementProtocolSecrets": { + "methods": { + "create": { + "description": "Creates a measurement protocol secret.", + "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}/measurementProtocolSecrets", + "httpMethod": "POST", + "id": "analyticsadmin.properties.iosAppDataStreams.measurementProtocolSecrets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "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}", + "location": "path", + "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/measurementProtocolSecrets", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes target MeasurementProtocolSecret.", + "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.iosAppDataStreams.measurementProtocolSecrets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "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.", + "location": "path", + "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single \"GA4\" MeasurementProtocolSecret.", + "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.iosAppDataStreams.measurementProtocolSecrets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "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.", + "location": "path", + "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns child MeasurementProtocolSecrets under the specified parent Property.", + "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}/measurementProtocolSecrets", + "httpMethod": "GET", + "id": "analyticsadmin.properties.iosAppDataStreams.measurementProtocolSecrets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "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", + "location": "path", + "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/measurementProtocolSecrets", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a measurement protocol secret.", + "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.iosAppDataStreams.measurementProtocolSecrets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "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}", + "location": "path", + "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated. Omitted fields will not be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + } } }, "userLinks": { @@ -2263,12 +2635,168 @@ "https://www.googleapis.com/auth/analytics.edit" ] } + }, + "resources": { + "measurementProtocolSecrets": { + "methods": { + "create": { + "description": "Creates a measurement protocol secret.", + "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/measurementProtocolSecrets", + "httpMethod": "POST", + "id": "analyticsadmin.properties.webDataStreams.measurementProtocolSecrets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "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}", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/measurementProtocolSecrets", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes target MeasurementProtocolSecret.", + "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.webDataStreams.measurementProtocolSecrets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "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.", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single \"GA4\" MeasurementProtocolSecret.", + "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.webDataStreams.measurementProtocolSecrets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "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.", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns child MeasurementProtocolSecrets under the specified parent Property.", + "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/measurementProtocolSecrets", + "httpMethod": "GET", + "id": "analyticsadmin.properties.webDataStreams.measurementProtocolSecrets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "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", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/measurementProtocolSecrets", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a measurement protocol secret.", + "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.webDataStreams.measurementProtocolSecrets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "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}", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated. Omitted fields will not be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + } } } } } }, - "revision": "20210513", + "revision": "20210518", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccount": { @@ -2601,10 +3129,18 @@ "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink", "description": "A snapshot of a GoogleAdsLink resource in change history." }, + "googleSignalsSettings": { + "$ref": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings", + "description": "A snapshot of a GoogleSignalsSettings resource in change history." + }, "iosAppDataStream": { "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream", "description": "A snapshot of an IosAppDataStream resource in change history." }, + "measurementProtocolSecret": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret", + "description": "A snapshot of a MeasurementProtocolSecret resource in change history." + }, "property": { "$ref": "GoogleAnalyticsAdminV1alphaProperty", "description": "A snapshot of a Property resource in change history." @@ -3016,6 +3552,47 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings": { + "description": "Settings values for Google Signals. This is a singleton resource.", + "id": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings", + "properties": { + "consent": { + "description": "Output only. Terms of Service acceptance.", + "enum": [ + "GOOGLE_SIGNALS_CONSENT_UNSPECIFIED", + "GOOGLE_SIGNALS_CONSENT_CONSENTED", + "GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED" + ], + "enumDescriptions": [ + "Google Signals consent value defaults to GOOGLE_SIGNALS_CONSENT_UNSPECIFIED. This will be treated as GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED.", + "Terms of service have been accepted", + "Terms of service have not been accepted" + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: \"properties/1000/googleSignalsSettings\"", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Status of this setting.", + "enum": [ + "GOOGLE_SIGNALS_STATE_UNSPECIFIED", + "GOOGLE_SIGNALS_ENABLED", + "GOOGLE_SIGNALS_DISABLED" + ], + "enumDescriptions": [ + "Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to represent that the user has not made an explicit choice.", + "Google Signals is enabled.", + "Google Signals is disabled." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaIosAppDataStream": { "description": "A resource message representing a Google Analytics IOS app stream.", "id": "GoogleAnalyticsAdminV1alphaIosAppDataStream", @@ -3215,6 +3792,24 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse": { + "description": "Response message for ListMeasurementProtocolSecret RPC", + "id": "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse", + "properties": { + "measurementProtocolSecrets": { + "description": "A list of secrets for the parent stream specified in the request.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaListPropertiesResponse": { "description": "Response message for ListProperties RPC.", "id": "GoogleAnalyticsAdminV1alphaListPropertiesResponse", @@ -3269,6 +3864,27 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret": { + "description": "A secret value used for sending hits to Measurement Protocol.", + "id": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret", + "properties": { + "displayName": { + "description": "Required. Human-readable display name for this secret.", + "type": "string" + }, + "name": { + "description": "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}", + "readOnly": true, + "type": "string" + }, + "secretValue": { + "description": "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.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaProperty": { "description": "A resource message representing a Google Analytics GA4 property.", "id": "GoogleAnalyticsAdminV1alphaProperty", @@ -3489,7 +4105,9 @@ "IOS_APP_DATA_STREAM", "FIREBASE_LINK", "GOOGLE_ADS_LINK", + "GOOGLE_SIGNALS_SETTINGS", "CONVERSION_EVENT", + "MEASUREMENT_PROTOCOL_SECRET", "CUSTOM_DIMENSION", "CUSTOM_METRIC" ], @@ -3502,7 +4120,9 @@ "IosAppDataStream resource", "FirebaseLink resource", "GoogleAdsLink resource", + "GoogleSignalsSettings resource", "ConversionEvent resource", + "MeasurementProtocolSecret resource", "CustomDimension resource", "CustomMetric resource" ],