View Source GoogleApi.MarketingPlatformAdmin.V1alpha.Api.Organizations (google_api_marketing_platform_admin v0.3.0)
API calls for all endpoints tagged Organizations
.
Summary
Functions
Creates the link between the Analytics account and the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account to create the link. If the account is already linked to an organization, user needs to unlink the account from the current organization, then try link again.
Deletes the AnalyticsAccountLink, which detaches the Analytics account from the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account in order to delete the link.
Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.
Updates the service level for an Analytics property.
Lookup for a single organization.
Functions
marketingplatformadmin_organizations_analytics_account_links_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec marketingplatformadmin_organizations_analytics_account_links_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MarketingPlatformAdmin.V1alpha.Model.AnalyticsAccountLink.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates the link between the Analytics account and the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account to create the link. If the account is already linked to an organization, user needs to unlink the account from the current organization, then try link again.
Parameters
-
connection
(type:GoogleApi.MarketingPlatformAdmin.V1alpha.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id} -
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.MarketingPlatformAdmin.V1alpha.Model.AnalyticsAccountLink.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MarketingPlatformAdmin.V1alpha.Model.AnalyticsAccountLink{}}
on success -
{:error, info}
on failure
marketingplatformadmin_organizations_analytics_account_links_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec marketingplatformadmin_organizations_analytics_account_links_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MarketingPlatformAdmin.V1alpha.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the AnalyticsAccountLink, which detaches the Analytics account from the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account in order to delete the link.
Parameters
-
connection
(type:GoogleApi.MarketingPlatformAdmin.V1alpha.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} -
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.MarketingPlatformAdmin.V1alpha.Model.Empty{}}
on success -
{:error, info}
on failure
marketingplatformadmin_organizations_analytics_account_links_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec marketingplatformadmin_organizations_analytics_account_links_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MarketingPlatformAdmin.V1alpha.Model.ListAnalyticsAccountLinksResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.
Parameters
-
connection
(type:GoogleApi.MarketingPlatformAdmin.V1alpha.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent organization, which owns this collection of Analytics account links. Format: organizations/{org_id} -
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()
) - Optional. The maximum number of Analytics account links to return in one call. The service may return fewer than this value. If unspecified, at most 50 Analytics account links will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken
(type:String.t
) - Optional. A page token, received from a previous ListAnalyticsAccountLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListAnalyticsAccountLinks
must match the call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MarketingPlatformAdmin.V1alpha.Model.ListAnalyticsAccountLinksResponse{}}
on success -
{:error, info}
on failure
marketingplatformadmin_organizations_analytics_account_links_set_property_service_level(connection, analytics_account_link, optional_params \\ [], opts \\ [])
View Source@spec marketingplatformadmin_organizations_analytics_account_links_set_property_service_level( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MarketingPlatformAdmin.V1alpha.Model.SetPropertyServiceLevelResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the service level for an Analytics property.
Parameters
-
connection
(type:GoogleApi.MarketingPlatformAdmin.V1alpha.Connection.t
) - Connection to server -
analytics_account_link
(type:String.t
) - Required. The parent AnalyticsAccountLink scope where this property is in. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} -
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.MarketingPlatformAdmin.V1alpha.Model.SetPropertyServiceLevelRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MarketingPlatformAdmin.V1alpha.Model.SetPropertyServiceLevelResponse{}}
on success -
{:error, info}
on failure
marketingplatformadmin_organizations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec marketingplatformadmin_organizations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MarketingPlatformAdmin.V1alpha.Model.Organization.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lookup for a single organization.
Parameters
-
connection
(type:GoogleApi.MarketingPlatformAdmin.V1alpha.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the Organization to retrieve. Format: organizations/{org_id} -
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.MarketingPlatformAdmin.V1alpha.Model.Organization{}}
on success -
{:error, info}
on failure