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

API calls for all endpoints tagged Accountstatuses.

Link to this section Summary

Functions

Retrieves the status of a Merchant Center account. Multi-client accounts can only call this method for sub-accounts

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

Link to this section Functions

Link to this function content_accountstatuses_custombatch(connection, optional_params \\ [], opts \\ []) View Source

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.
    • :body (AccountstatusesCustomBatchRequest):

Returns

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

Link to this function content_accountstatuses_get(connection, merchant_id, account_id, optional_params \\ [], opts \\ []) View Source

Retrieves the status of a Merchant Center account. Multi-client accounts can only call this method for sub-accounts.

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.
  • 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.
    • :destinations ([String.t]): If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.

Returns

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

Link to this function content_accountstatuses_list(connection, merchant_id, optional_params \\ [], opts \\ []) View Source

Lists the statuses 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.
    • :destinations ([String.t]): If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
    • :maxResults (integer()): The maximum number of account statuses to return in the response, used for paging.
    • :pageToken (String.t): The token returned by the previous request.

Returns

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