+ measurementProtocolSecrets()
+
Returns the measurementProtocolSecrets Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.measurementProtocolSecrets.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.measurementProtocolSecrets.html new file mode 100644 index 00000000000..5c7f29eae8a --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.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. Format: properties/{property}/dataStreams/{dataStream} (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}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (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}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (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. Format: properties/{property}/dataStreams/{dataStream}/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.
+}
+Returns the androidAppDataStreams Resource.
- @@ -119,11 +114,6 @@Returns the googleAdsLinks Resource.
- -Returns the iosAppDataStreams Resource.
- @@ -355,7 +345,7 @@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. Args: - filter: string, Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ``` + filter: string, Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ``` pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. 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 `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html index 1ffbe9b1b4b..adaa0cf5ad3 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html @@ -74,122 +74,18 @@Google Analytics Admin API . properties . webDataStreams
Instance Methods
--
-measurementProtocolSecrets()-Returns the measurementProtocolSecrets Resource.
-Close httplib2 connections.
--
-create(parent, body=None, x__xgafv=None)Creates a web stream with the specified location and attributes.
- -Deletes a web stream on a property.
- -Lookup for a single WebDataStream
getGlobalSiteTag(name, x__xgafv=None)Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
--
-list(parent, pageSize=None, pageToken=None, x__xgafv=None)Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.
--
-list_next(previous_request, previous_response)Retrieves the next page of results.
--
-patch(name, body=None, updateMask=None, x__xgafv=None)Updates a web stream on a property.
Method Details
-close()Close httplib2 connections.-- -create(parent, body=None, x__xgafv=None)-Creates a web stream with the specified location and attributes. - -Args: - parent: string, Required. The parent resource where this web data stream will be created. Format: properties/123 (required) - body: object, The request body. - The object takes the form of: - -{ # A resource message representing a Google Analytics web stream. - "createTime": "A String", # Output only. Time when this stream was originally created. - "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" - "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. - "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. - "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" - "updateTime": "A String", # Output only. Time when stream payload fields were last updated. -} - - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # A resource message representing a Google Analytics web stream. - "createTime": "A String", # Output only. Time when this stream was originally created. - "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" - "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. - "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. - "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" - "updateTime": "A String", # Output only. Time when stream payload fields were last updated. -}--- -delete(name, x__xgafv=None)-Deletes a web stream on a property. - -Args: - name: string, Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/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)-Lookup for a single WebDataStream - -Args: - name: string, Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/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 resource message representing a Google Analytics web stream. - "createTime": "A String", # Output only. Time when this stream was originally created. - "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" - "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. - "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. - "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" - "updateTime": "A String", # Output only. Time when stream payload fields were last updated. -}--getGlobalSiteTag(name, x__xgafv=None)Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. @@ -210,89 +106,4 @@Method Details
}-- -list(parent, pageSize=None, pageToken=None, x__xgafv=None)-Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found. - -Args: - parent: string, Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: "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 `ListWebDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebDataStreams` 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: - - { # Request message for ListWebDataStreams RPC. - "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. - "webDataStreams": [ # Results that matched the filter criteria and were accessible to the caller. - { # A resource message representing a Google Analytics web stream. - "createTime": "A String", # Output only. Time when this stream was originally created. - "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" - "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. - "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. - "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" - "updateTime": "A String", # Output only. Time when stream payload fields were last updated. - }, - ], -}--- -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 web stream on a property. - -Args: - name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" (required) - body: object, The request body. - The object takes the form of: - -{ # A resource message representing a Google Analytics web stream. - "createTime": "A String", # Output only. Time when this stream was originally created. - "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" - "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. - "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. - "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" - "updateTime": "A String", # Output only. Time when stream payload fields were last updated. -} - - 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: - - { # A resource message representing a Google Analytics web stream. - "createTime": "A String", # Output only. Time when this stream was originally created. - "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" - "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. - "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. - "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" - "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" - "updateTime": "A String", # Output only. Time when stream payload fields were last updated. -}-