View Source GoogleApi.Content.V2.Api.Shippingsettings (google_api_content v0.66.0)

API calls for all endpoints tagged Shippingsettings.

Summary

Functions

Retrieves and updates the shipping settings of multiple accounts in a single request.

Lists the shipping settings of the sub-accounts in your Merchant Center account.

Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.

Functions

Link to this function

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

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

Retrieves and updates the shipping settings of multiple accounts in a single request.

Parameters

  • connection (type: GoogleApi.Content.V2.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").
    • :dryRun (type: boolean()) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
    • :body (type: GoogleApi.Content.V2.Model.ShippingsettingsCustomBatchRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_shippingsettings_get(connection, merchant_id, account_id, optional_params \\ [], opts \\ [])

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

Retrieves the shipping settings of the account.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.
  • account_id (type: String.t) - The ID of the account for which to get/update shipping settings.
  • 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.V2.Model.ShippingSettings{}} on success
  • {:error, info} on failure
Link to this function

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

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

Retrieves supported carriers and carrier services for an account.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account for which to retrieve the supported carriers.
  • 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.V2.Model.ShippingsettingsGetSupportedCarriersResponse{}} on success
  • {:error, info} on failure
Link to this function

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

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

Retrieves supported holidays for an account.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account for which to retrieve the supported holidays.
  • 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.V2.Model.ShippingsettingsGetSupportedHolidaysResponse{}} on success
  • {:error, info} on failure
Link to this function

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

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

Retrieves supported pickup services for an account.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account for which to retrieve the supported pickup services.
  • 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.V2.Model.ShippingsettingsGetSupportedPickupServicesResponse{}} on success
  • {:error, info} on failure
Link to this function

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

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

Lists the shipping settings of the sub-accounts in your Merchant Center account.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the managing account. This must be a multi-client 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").
    • :maxResults (type: integer()) - The maximum number of shipping settings to return 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.V2.Model.ShippingsettingsListResponse{}} on success
  • {:error, info} on failure
Link to this function

content_shippingsettings_update(connection, merchant_id, account_id, optional_params \\ [], opts \\ [])

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

Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.
  • account_id (type: String.t) - The ID of the account for which to get/update shipping settings.
  • 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").
    • :dryRun (type: boolean()) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
    • :body (type: GoogleApi.Content.V2.Model.ShippingSettings.t) -
  • opts (type: keyword()) - Call options

Returns

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