GoogleApi.Content.V21.Api.Buyongoogleprograms (google_api_content v0.51.0) View Source
API calls for all endpoints tagged Buyongoogleprograms
.
Link to this section Summary
Functions
Retrieves a status of BoG program for your Merchant Center account.
Onboards BoG in your Merchant Center account. By using this method, you agree to the Terms of Service.
Link to this section Functions
Link to this function
content_buyongoogleprograms_get(connection, merchant_id, region_code, optional_params \\ [], opts \\ [])
View SourceSpecs
content_buyongoogleprograms_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.BuyOnGoogleProgramStatus.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a status of BoG program for your Merchant Center account.
Parameters
-
connection
(type:GoogleApi.Content.V21.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - Required. The ID of the account. -
region_code
(type:String.t
) - The Program region code ISO 3166-1 alpha-2. Currently only US is available. -
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.Content.V21.Model.BuyOnGoogleProgramStatus{}}
on success -
{:error, info}
on failure
Link to this function
content_buyongoogleprograms_onboard(connection, merchant_id, region_code, optional_params \\ [], opts \\ [])
View SourceSpecs
content_buyongoogleprograms_onboard( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Onboards BoG in your Merchant Center account. By using this method, you agree to the Terms of Service.
Parameters
-
connection
(type:GoogleApi.Content.V21.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - Required. The ID of the account. -
region_code
(type:String.t
) - The program region code ISO 3166-1 alpha-2. Currently only US is available. -
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.Content.V21.Model.OnboardBuyOnGoogleProgramRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure