google_api_content v0.30.0 GoogleApi.Content.V2.Api.Accountstatuses View Source

API calls for all endpoints tagged Accountstatuses.

Link to this section Summary

Functions

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

Retrieves multiple Merchant Center account statuses in a single request.

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

Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.

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

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

Link to this section Functions

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

content_accountstatuses_custombatch(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.AccountstatusesCustomBatchResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Retrieves multiple Merchant Center account statuses in a single request.

Parameters

connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.Content.V2.Model.AccountstatusesCustomBatchRequest.t) -
opts (type: keyword()) - Call options

Returns

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

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

content_accountstatuses_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.AccountStatus.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.

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.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :destinations (type: list(String.t)) - If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
opts (type: keyword()) - Call options

Returns

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

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

content_accountstatuses_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.AccountstatusesListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Lists the statuses 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
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :destinations (type: list(String.t)) - If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
- :maxResults (type: integer()) - The maximum number of account statuses 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.AccountstatusesListResponse{}} on success
{:error, info} on failure