GoogleApi.AdSensePlatform.V1alpha.Api.Accounts (google_api_ad_sense_platform v0.4.0)

View Source

API calls for all endpoints tagged Accounts.

Summary

Functions

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

@spec adsenseplatform_accounts_platforms_child_accounts_sites_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdSensePlatform.V1alpha.Model.ListPlatformChildSitesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists Platform Child Sites for a specified Platform Child Account.

Parameters

  • connection (type: GoogleApi.AdSensePlatform.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the child account under the given platform which owns the platform child sites. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}
  • 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 children to include in the response, used for paging. If unspecified, at most 10000 platforms will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListPlatformChildren call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPlatformChildren must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

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

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

@spec adsenseplatform_accounts_platforms_child_accounts_sites_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.PlatformChildSite.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update a Platform Child Site.

Parameters

  • connection (type: GoogleApi.AdSensePlatform.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site}
  • 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) - Optional. The list of fields to update - currently only supports updating the platform_group field.
    • :body (type: GoogleApi.AdSensePlatform.V1alpha.Model.PlatformChildSite.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

@spec adsenseplatform_accounts_platforms_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.Platform.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a platform.

Parameters

  • connection (type: GoogleApi.AdSensePlatform.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the platform to retrieve. Format: accounts/{account}/platforms/{platform}
  • 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.AdSensePlatform.V1alpha.Model.Platform{}} on success
  • {:error, info} on failure

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

@spec adsenseplatform_accounts_platforms_groups_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.ListPlatformGroupsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists Platform Groups for a specified Platform.

Parameters

  • connection (type: GoogleApi.AdSensePlatform.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the platform to retrieve. Format: accounts/{account}/platforms/{platform}
  • 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 groups to include in the response, used for paging. If unspecified, at most 10000 groups will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListPlatformGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPlatformGroups must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

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

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

@spec adsenseplatform_accounts_platforms_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.ListPlatformsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists platforms for a specified account.

Parameters

  • connection (type: GoogleApi.AdSensePlatform.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The account which owns the platforms. Format: accounts/{account}
  • 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 platforms to include in the response, used for paging. If unspecified, at most 10000 platforms will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListPlatforms call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPlatforms must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

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