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

API calls for all endpoints tagged Regions.

Summary

Functions

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

Creates a region definition in your Merchant Center account.

content_regions_delete(connection, merchant_id, region_id, optional_params \\ [], opts \\ [])

Deletes a region definition from your Merchant Center account.

content_regions_get(connection, merchant_id, region_id, optional_params \\ [], opts \\ [])

Retrieves a region defined in your Merchant Center account.

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

Lists the regions in your Merchant Center account.

content_regions_patch(connection, merchant_id, region_id, optional_params \\ [], opts \\ [])

Updates a region definition in your Merchant Center account.

Functions

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

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

Creates a region definition in 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 merchant for which to create region definition.
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").
- :regionId (type: String.t) - Required. The id of the region to create.
- :body (type: GoogleApi.Content.V21.Model.Region.t) -
opts (type: keyword()) - Call options

Returns

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

content_regions_delete(connection, merchant_id, region_id, optional_params \\ [], opts \\ [])

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

Deletes a region definition from 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 merchant for which to delete region definition.
region_id (type: String.t) - Required. The id of the region to delete.
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

content_regions_get(connection, merchant_id, region_id, optional_params \\ [], opts \\ [])

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

Retrieves a region defined in 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 merchant for which to retrieve region definition.
region_id (type: String.t) - Required. The id of the region to retrieve.
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.Region{}} on success
{:error, info} on failure

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

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

Lists the regions in 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 merchant for which to list region definitions.
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").
- :pageSize (type: integer()) - The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
- :pageToken (type: String.t) - A page token, received from a previous ListRegions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRegions must match the call that provided the page token.
opts (type: keyword()) - Call options

Returns

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

content_regions_patch(connection, merchant_id, region_id, optional_params \\ [], opts \\ [])

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

Updates a region definition in 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 merchant for which to update region definition.
region_id (type: String.t) - Required. The id of the region to update.
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").
- :updateMask (type: String.t) - Optional. The comma-separated field mask indicating the fields to update. Example: "displayName,postalCodeArea.regionCode".
- :body (type: GoogleApi.Content.V21.Model.Region.t) -
opts (type: keyword()) - Call options

Returns

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