google_api_content v0.4.0 GoogleApi.Content.V2.Api.Shippingsettings View Source
API calls for all endpoints tagged Shippingsettings
.
Link to this section Summary
Functions
Retrieves and updates the shipping settings of multiple accounts in a single request
Retrieves the shipping settings of the account
Retrieves supported carriers and carrier services for an account
Retrieves supported holidays for an account
Lists the shipping settings of the sub-accounts in your Merchant Center account
Updates the shipping settings of the account. This method supports patch semantics
Updates the shipping settings of the account
Link to this section Functions
content_shippingsettings_custombatch(connection, optional_params \\ [], opts \\ []) View Source
Retrieves and updates the shipping settings of multiple accounts in a single request.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :dryRun (boolean()): Flag to run the request in dry-run mode.
- :body (ShippingsettingsCustomBatchRequest):
Returns
{:ok, %GoogleApi.Content.V2.Model.ShippingsettingsCustomBatchResponse{}} on success {:error, info} on failure
content_shippingsettings_get(connection, merchant_id, account_id, optional_params \\ [], opts \\ []) View Source
Retrieves the shipping settings of the account.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (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 (String.t): The ID of the account for which to get/update shipping settings.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.Content.V2.Model.ShippingSettings{}} on success {:error, info} on failure
content_shippingsettings_getsupportedcarriers(connection, merchant_id, optional_params \\ [], opts \\ []) View Source
Retrieves supported carriers and carrier services for an account.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (String.t): The ID of the account for which to retrieve the supported carriers.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.Content.V2.Model.ShippingsettingsGetSupportedCarriersResponse{}} on success {:error, info} on failure
content_shippingsettings_getsupportedholidays(connection, merchant_id, optional_params \\ [], opts \\ []) View Source
Retrieves supported holidays for an account.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (String.t): The ID of the account for which to retrieve the supported holidays.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.Content.V2.Model.ShippingsettingsGetSupportedHolidaysResponse{}} on success {:error, info} on failure
content_shippingsettings_list(connection, merchant_id, optional_params \\ [], opts \\ []) View Source
Lists the shipping settings of the sub-accounts in your Merchant Center account.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (String.t): The ID of the managing account. This must be a multi-client account.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :maxResults (integer()): The maximum number of shipping settings to return in the response, used for paging.
- :pageToken (String.t): The token returned by the previous request.
Returns
{:ok, %GoogleApi.Content.V2.Model.ShippingsettingsListResponse{}} on success {:error, info} on failure
content_shippingsettings_patch(connection, merchant_id, account_id, optional_params \\ [], opts \\ []) View Source
Updates the shipping settings of the account. This method supports patch semantics.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (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 (String.t): The ID of the account for which to get/update shipping settings.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :dryRun (boolean()): Flag to run the request in dry-run mode.
- :body (ShippingSettings):
Returns
{:ok, %GoogleApi.Content.V2.Model.ShippingSettings{}} on success {:error, info} on failure
content_shippingsettings_update(connection, merchant_id, account_id, optional_params \\ [], opts \\ []) View Source
Updates the shipping settings of the account.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (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 (String.t): The ID of the account for which to get/update shipping settings.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :dryRun (boolean()): Flag to run the request in dry-run mode.
- :body (ShippingSettings):
Returns
{:ok, %GoogleApi.Content.V2.Model.ShippingSettings{}} on success {:error, info} on failure