View Source GoogleApi.Content.V21.Api.Returnpolicy (google_api_content v0.71.0)

API calls for all endpoints tagged Returnpolicy.

Summary

Functions

content_returnpolicy_custombatch(connection, optional_params \\ [], opts \\ [])

Batches multiple return policy related calls in a single request.

content_returnpolicy_delete(connection, merchant_id, return_policy_id, optional_params \\ [], opts \\ [])

Deletes a return policy for the given Merchant Center account.

content_returnpolicy_get(connection, merchant_id, return_policy_id, optional_params \\ [], opts \\ [])

Gets a return policy of the Merchant Center account.

content_returnpolicy_insert(connection, merchant_id, optional_params \\ [], opts \\ [])

Inserts a return policy for the Merchant Center account.

content_returnpolicy_list(connection, merchant_id, optional_params \\ [], opts \\ [])

Lists the return policies of the Merchant Center account.

Functions

Link to this function

content_returnpolicy_custombatch(connection, optional_params \\ [], opts \\ [])

View Source 
@spec content_returnpolicy_custombatch(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnpolicyCustomBatchResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Batches multiple return policy 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.ReturnpolicyCustomBatchRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Content.V21.Model.ReturnpolicyCustomBatchResponse{}} on success
  • {:error, info} on failure
Link to this function

content_returnpolicy_delete(connection, merchant_id, return_policy_id, optional_params \\ [], opts \\ [])

View Source 
@spec content_returnpolicy_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes a return policy 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 policy.
  • return_policy_id (type: String.t) - Return policy 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_returnpolicy_get(connection, merchant_id, return_policy_id, optional_params \\ [], opts \\ [])

View Source 
@spec content_returnpolicy_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a return policy 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 policy for.
  • return_policy_id (type: String.t) - Return policy 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.ReturnPolicy{}} on success
  • {:error, info} on failure
Link to this function

content_returnpolicy_insert(connection, merchant_id, optional_params \\ [], opts \\ [])

View Source 
@spec content_returnpolicy_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts a return policy 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 policy 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.ReturnPolicy.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Content.V21.Model.ReturnPolicy{}} on success
  • {:error, info} on failure
Link to this function

content_returnpolicy_list(connection, merchant_id, optional_params \\ [], opts \\ [])

View Source 
@spec content_returnpolicy_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnpolicyListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the return policies 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 policies 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Content.V21.Model.ReturnpolicyListResponse{}} on success
  • {:error, info} on failure