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.

Functions

Link to this function

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