View Source GoogleApi.AdSensePlatform.V1alpha.Api.Platforms (google_api_ad_sense_platform v0.3.1)
API calls for all endpoints tagged Platforms
.
Summary
Functions
Closes a sub-account.
Creates a sub-account.
Creates an account event.
Gets information about the selected sub-account.
Lists a partial view of sub-accounts for a specific parent account.
Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
Creates a site for a specified account.
Deletes a site from a specified account.
Gets a site from a specified sub-account.
Lists sites for a specific account.
Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an ad tag on your site before requesting a review.
Functions
@spec adsenseplatform_platforms_accounts_close( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.CloseAccountResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Closes a sub-account.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Account to close. Format: platforms/{platform}/accounts/{account_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.AdSensePlatform.V1alpha.Model.CloseAccountRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSensePlatform.V1alpha.Model.CloseAccountResponse{}}
on success -
{:error, info}
on failure
@spec adsenseplatform_platforms_accounts_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.Account.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a sub-account.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Platform to create an account for. Format: 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"). -
:body
(type:GoogleApi.AdSensePlatform.V1alpha.Model.Account.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSensePlatform.V1alpha.Model.Account{}}
on success -
{:error, info}
on failure
adsenseplatform_platforms_accounts_events_create(connection, parent, optional_params \\ [], opts \\ [])
@spec adsenseplatform_platforms_accounts_events_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.Event.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an account event.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Account to log events about. Format: platforms/{platform}/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"). -
:body
(type:GoogleApi.AdSensePlatform.V1alpha.Model.Event.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSensePlatform.V1alpha.Model.Event{}}
on success -
{:error, info}
on failure
@spec adsenseplatform_platforms_accounts_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.Account.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about the selected sub-account.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Account to get information about. Format: platforms/{platform}/accounts/{account_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.AdSensePlatform.V1alpha.Model.Account{}}
on success -
{:error, info}
on failure
@spec adsenseplatform_platforms_accounts_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.ListAccountsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists a partial view of sub-accounts for a specific parent account.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Platform who parents the accounts. Format: 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 accounts to include in the response, used for paging. If unspecified, at most 10000 accounts 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 previousListAccounts
call. Provide this to retrieve the subsequent page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSensePlatform.V1alpha.Model.ListAccountsResponse{}}
on success -
{:error, info}
on failure
@spec adsenseplatform_platforms_accounts_lookup( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.LookupAccountResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Platform who parents the account. Format: 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"). -
:creationRequestId
(type:String.t
) - Optional. The creation_request_id provided when calling createAccount.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSensePlatform.V1alpha.Model.LookupAccountResponse{}}
on success -
{:error, info}
on failure
adsenseplatform_platforms_accounts_sites_create(connection, parent, optional_params \\ [], opts \\ [])
@spec adsenseplatform_platforms_accounts_sites_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.Site.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a site for a specified account.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Account to create site. Format: platforms/{platform}/accounts/{account_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.AdSensePlatform.V1alpha.Model.Site.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSensePlatform.V1alpha.Model.Site{}}
on success -
{:error, info}
on failure
adsenseplatform_platforms_accounts_sites_delete(connection, name, optional_params \\ [], opts \\ [])
@spec adsenseplatform_platforms_accounts_sites_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a site from a specified account.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSensePlatform.V1alpha.Model.Empty{}}
on success -
{:error, info}
on failure
@spec adsenseplatform_platforms_accounts_sites_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.Site.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a site from a specified sub-account.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSensePlatform.V1alpha.Model.Site{}}
on success -
{:error, info}
on failure
adsenseplatform_platforms_accounts_sites_list(connection, parent, optional_params \\ [], opts \\ [])
@spec adsenseplatform_platforms_accounts_sites_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.ListSitesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists sites for a specific account.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The account which owns the sites. Format: platforms/{platform}/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()
) - The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. -
:pageToken
(type:String.t
) - A page token, received from a previousListSites
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListSites
must match the call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSensePlatform.V1alpha.Model.ListSitesResponse{}}
on success -
{:error, info}
on failure
adsenseplatform_platforms_accounts_sites_request_review(connection, name, optional_params \\ [], opts \\ [])
@spec adsenseplatform_platforms_accounts_sites_request_review( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSensePlatform.V1alpha.Model.RequestSiteReviewResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an ad tag on your site before requesting a review.
Parameters
-
connection
(type:GoogleApi.AdSensePlatform.V1alpha.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSensePlatform.V1alpha.Model.RequestSiteReviewResponse{}}
on success -
{:error, info}
on failure