View Source GoogleApi.Content.V21.Api.Returnaddress (google_api_content v0.66.0)
API calls for all endpoints tagged Returnaddress
.
Summary
Functions
Batches multiple return address related calls in a single request.
Deletes a return address for the given Merchant Center account.
Gets a return address of the Merchant Center account.
Inserts a return address for the Merchant Center account.
Lists the return addresses of the Merchant Center account.
Functions
Link to this function
content_returnaddress_custombatch(connection, optional_params \\ [], opts \\ [])
View Source@spec content_returnaddress_custombatch(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Content.V21.Model.ReturnaddressCustomBatchResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Batches multiple return address related calls in a single request.
Parameters
-
connection
(type:GoogleApi.Content.V21.Connection.t
) - Connection to server -
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.ReturnaddressCustomBatchRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Content.V21.Model.ReturnaddressCustomBatchResponse{}}
on success -
{:error, info}
on failure
Link to this function
content_returnaddress_delete(connection, merchant_id, return_address_id, optional_params \\ [], opts \\ [])
View Source@spec content_returnaddress_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a return address for the given Merchant Center account.
Parameters
-
connection
(type:GoogleApi.Content.V21.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - The Merchant Center account from which to delete the given return address. -
return_address_id
(type:String.t
) - Return address ID generated by Google. -
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, %{}}
on success -
{:error, info}
on failure
Link to this function
content_returnaddress_get(connection, merchant_id, return_address_id, optional_params \\ [], opts \\ [])
View Source@spec content_returnaddress_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.ReturnAddress.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a return address of the Merchant Center account.
Parameters
-
connection
(type:GoogleApi.Content.V21.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - The Merchant Center account to get a return address for. -
return_address_id
(type:String.t
) - Return address ID generated by Google. -
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.ReturnAddress{}}
on success -
{:error, info}
on failure
Link to this function
content_returnaddress_insert(connection, merchant_id, optional_params \\ [], opts \\ [])
View Source@spec content_returnaddress_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.ReturnAddress.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Inserts a return address for the Merchant Center account.
Parameters
-
connection
(type:GoogleApi.Content.V21.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - The Merchant Center account to insert a return address for. -
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.ReturnAddress.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Content.V21.Model.ReturnAddress{}}
on success -
{:error, info}
on failure
Link to this function
content_returnaddress_list(connection, merchant_id, optional_params \\ [], opts \\ [])
View Source@spec content_returnaddress_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Content.V21.Model.ReturnaddressListResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the return addresses of the Merchant Center account.
Parameters
-
connection
(type:GoogleApi.Content.V21.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - The Merchant Center account to list return addresses for. -
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"). -
:country
(type:String.t
) - List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed. -
:maxResults
(type:integer()
) - The maximum number of addresses in the response, used for paging. -
:pageToken
(type:String.t
) - The token returned by the previous request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Content.V21.Model.ReturnaddressListResponse{}}
on success -
{:error, info}
on failure