google_api_analytics_admin v0.5.0

GoogleApi.AnalyticsAdmin.V1alpha.Api.Properties (google_api_analytics_admin v0.5.0) View Source

API calls for all endpoints tagged Properties.

Link to this section Summary

Functions

analyticsadmin_properties_android_app_data_streams_create(connection, parent, optional_params \\ [], opts \\ [])

Creates an android app stream with the specified location and attributes.

analyticsadmin_properties_android_app_data_streams_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes an android app stream on a property.

analyticsadmin_properties_android_app_data_streams_get(connection, name, optional_params \\ [], opts \\ [])

Lookup for a single AndroidAppDataStream

analyticsadmin_properties_android_app_data_streams_list(connection, parent, optional_params \\ [], opts \\ [])

Returns child android app streams under the specified parent property. Android app streams will be excluded if the caller does not have access. Returns an empty list if no relevant android app streams are found.

analyticsadmin_properties_android_app_data_streams_patch(connection, name, optional_params \\ [], opts \\ [])

Updates an android app stream on a property.

analyticsadmin_properties_create(connection, optional_params \\ [], opts \\ [])

Creates an "GA4" property with the specified location and attributes.

analyticsadmin_properties_delete(connection, name, optional_params \\ [], opts \\ [])

Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.

analyticsadmin_properties_firebase_links_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a FirebaseLink. Properties can have at most one FirebaseLink.

analyticsadmin_properties_firebase_links_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a FirebaseLink on a property

analyticsadmin_properties_firebase_links_list(connection, parent, optional_params \\ [], opts \\ [])

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

analyticsadmin_properties_firebase_links_patch(connection, name, optional_params \\ [], opts \\ [])

Updates a FirebaseLink on a property

analyticsadmin_properties_get(connection, name, optional_params \\ [], opts \\ [])

Lookup for a single "GA4" Property.

analyticsadmin_properties_google_ads_links_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a GoogleAdsLink.

analyticsadmin_properties_google_ads_links_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a GoogleAdsLink on a property

analyticsadmin_properties_google_ads_links_list(connection, parent, optional_params \\ [], opts \\ [])

Lists GoogleAdsLinks on a property.

analyticsadmin_properties_google_ads_links_patch(connection, name, optional_params \\ [], opts \\ [])

Updates a GoogleAdsLink on a property

analyticsadmin_properties_ios_app_data_streams_create(connection, parent, optional_params \\ [], opts \\ [])

Creates an iOS app data stream with the specified location and attributes.

analyticsadmin_properties_ios_app_data_streams_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes an iOS app stream on a property.

analyticsadmin_properties_ios_app_data_streams_get(connection, name, optional_params \\ [], opts \\ [])

Lookup for a single IosAppDataStream

analyticsadmin_properties_ios_app_data_streams_list(connection, parent, optional_params \\ [], opts \\ [])

Returns child iOS app data streams under the specified parent property. iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.

analyticsadmin_properties_ios_app_data_streams_patch(connection, name, optional_params \\ [], opts \\ [])

Updates an iOS app stream on a property.

analyticsadmin_properties_list(connection, optional_params \\ [], opts \\ [])

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.

analyticsadmin_properties_patch(connection, name, optional_params \\ [], opts \\ [])

Updates a property.

analyticsadmin_properties_user_links_audit(connection, parent, optional_params \\ [], opts \\ [])

Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.

analyticsadmin_properties_user_links_batch_create(connection, parent, optional_params \\ [], opts \\ [])

Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.

analyticsadmin_properties_user_links_batch_delete(connection, parent, optional_params \\ [], opts \\ [])

Deletes information about multiple users' links to an account or property.

analyticsadmin_properties_user_links_batch_get(connection, parent, optional_params \\ [], opts \\ [])

Gets information about multiple users' links to an account or property.

analyticsadmin_properties_user_links_batch_update(connection, parent, optional_params \\ [], opts \\ [])

Updates information about multiple users' links to an account or property.

analyticsadmin_properties_user_links_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.

analyticsadmin_properties_user_links_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a user link on an account or property.

analyticsadmin_properties_user_links_get(connection, name, optional_params \\ [], opts \\ [])

Gets information about a user's link to an account or property.

analyticsadmin_properties_user_links_list(connection, parent, optional_params \\ [], opts \\ [])

Lists all user links on an account or property.

analyticsadmin_properties_user_links_patch(connection, name, optional_params \\ [], opts \\ [])

Updates a user link on an account or property.

analyticsadmin_properties_web_data_streams_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a web stream with the specified location and attributes.

analyticsadmin_properties_web_data_streams_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a web stream on a property.

analyticsadmin_properties_web_data_streams_get(connection, name, optional_params \\ [], opts \\ [])

Lookup for a single WebDataStream

analyticsadmin_properties_web_data_streams_get_enhanced_measurement_settings(connection, name, optional_params \\ [], opts \\ [])

Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

analyticsadmin_properties_web_data_streams_get_global_site_tag(connection, name, optional_params \\ [], opts \\ [])

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

analyticsadmin_properties_web_data_streams_list(connection, parent, optional_params \\ [], opts \\ [])

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.

analyticsadmin_properties_web_data_streams_patch(connection, name, optional_params \\ [], opts \\ [])

Updates a web stream on a property.

analyticsadmin_properties_web_data_streams_update_enhanced_measurement_settings(connection, name, optional_params \\ [], opts \\ [])

Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Link to this section Functions

Link to this function

analyticsadmin_properties_android_app_data_streams_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_android_app_data_streams_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAndroidAppDataStream.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates an android app stream with the specified location and attributes.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource where this android app data stream will be created. Format: properties/123
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAndroidAppDataStream.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAndroidAppDataStream{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_android_app_data_streams_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_android_app_data_streams_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes an android app stream on a property.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the android app data stream to delete. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/123/androidAppDataStreams/456"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_android_app_data_streams_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_android_app_data_streams_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAndroidAppDataStream.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lookup for a single AndroidAppDataStream

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the android app data stream to lookup. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/123/androidAppDataStreams/456"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAndroidAppDataStream{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_android_app_data_streams_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_android_app_data_streams_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns child android app streams under the specified parent property. Android app streams will be excluded if the caller does not have access. Returns an empty list if no relevant android app streams are found.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the parent property. For example, to limit results to app streams under the property with Id 123: "properties/123"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: 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 (type: String.t) - A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAndroidAppDataStreams must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_android_app_data_streams_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_android_app_data_streams_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAndroidAppDataStream.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an android app stream on a property.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/1000/androidAppDataStreams/2000"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - 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.
    • :body (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAndroidAppDataStream.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAndroidAppDataStream{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_create(connection, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaProperty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates an "GA4" property with the specified location and attributes.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaProperty.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaProperty{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaProperty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lookup for a single "GA4" Property.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaProperty{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_ios_app_data_streams_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_ios_app_data_streams_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaIosAppDataStream.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates an iOS app data stream with the specified location and attributes.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource where this ios app data stream will be created. Format: properties/123
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaIosAppDataStream.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaIosAppDataStream{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_ios_app_data_streams_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_ios_app_data_streams_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes an iOS app stream on a property.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the iOS app data stream to delete. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/123/iosAppDataStreams/456"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_ios_app_data_streams_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_ios_app_data_streams_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaIosAppDataStream.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lookup for a single IosAppDataStream

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the iOS app data stream to lookup. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/123/iosAppDataStreams/456"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaIosAppDataStream{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_ios_app_data_streams_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_ios_app_data_streams_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns child iOS app data streams under the specified parent property. iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the parent property. For example, to list results of app streams under the property with Id 123: "properties/123"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: 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 (type: String.t) - A page token, received from a previous ListIosAppDataStreams call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIosAppDataStreams must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_ios_app_data_streams_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_ios_app_data_streams_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaIosAppDataStream.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an iOS app stream on a property.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/1000/iosAppDataStreams/2000"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - 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.
    • :body (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaIosAppDataStream.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaIosAppDataStream{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaListPropertiesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - 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. |
    • :pageSize (type: 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 (type: String.t) - 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 (type: boolean()) - Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaListPropertiesResponse{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaProperty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a property.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - 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.
    • :body (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaProperty.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaProperty{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_web_data_streams_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_web_data_streams_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaWebDataStream.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a web stream with the specified location and attributes.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource where this web data stream will be created. Format: properties/123
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaWebDataStream.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaWebDataStream{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_web_data_streams_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_web_data_streams_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes a web stream on a property.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_web_data_streams_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_web_data_streams_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaWebDataStream.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lookup for a single WebDataStream

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaWebDataStream{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_web_data_streams_get_enhanced_measurement_settings(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_web_data_streams_get_enhanced_measurement_settings(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the settings to lookup. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_web_data_streams_get_global_site_tag(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_web_data_streams_get_global_site_tag(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaGlobalSiteTag.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/webDataStreams/{stream_id}/globalSiteTag Example: "properties/123/webDataStreams/456/globalSiteTag"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaGlobalSiteTag{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_web_data_streams_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_web_data_streams_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: "properties/123"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: 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 (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_web_data_streams_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_web_data_streams_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaWebDataStream.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a web stream on a property.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - 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.
    • :body (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaWebDataStream.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaWebDataStream{}} on success
  • {:error, info} on failure
Link to this function

analyticsadmin_properties_web_data_streams_update_enhanced_measurement_settings(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsadmin_properties_web_data_streams_update_enhanced_measurement_settings(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Parameters

  • connection (type: GoogleApi.AnalyticsAdmin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - 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.
    • :body (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings{}} on success
  • {:error, info} on failure