google_api_content

v0.1.0

google_api_content v0.1.0 GoogleApi.Content.V2.Api.Accounts View Source

API calls for all endpoints tagged Accounts.

Link to this section Summary

Functions

content_accounts_authinfo(connection, opts \\ [])

Returns information about the authenticated user

content_accounts_claimwebsite(connection, merchant_id, account_id, opts \\ [])

Claims the website of a Merchant Center sub-account

content_accounts_custombatch(connection, opts \\ [])

Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request

content_accounts_delete(connection, merchant_id, account_id, opts \\ [])

Deletes a Merchant Center sub-account

content_accounts_get(connection, merchant_id, account_id, opts \\ [])

Retrieves a Merchant Center account

content_accounts_insert(connection, merchant_id, opts \\ [])

Creates a Merchant Center sub-account

content_accounts_link(connection, merchant_id, account_id, opts \\ [])

Performs an action on a link between a Merchant Center account and another account

content_accounts_list(connection, merchant_id, opts \\ [])

Lists the sub-accounts in your Merchant Center account

content_accounts_patch(connection, merchant_id, account_id, opts \\ [])

Updates a Merchant Center account. This method supports patch semantics

content_accounts_update(connection, merchant_id, account_id, opts \\ [])

Updates a Merchant Center account

Link to this section Functions

Link to this function content_accounts_authinfo(connection, opts \\ []) View Source 
content_accounts_authinfo(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.AccountsAuthInfoResponse.t()}
  | {:error, Tesla.Env.t()}

Returns information about the authenticated user.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server

  • opts (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.AccountsAuthInfoResponse{}} on success {:error, info} on failure

Link to this function content_accounts_claimwebsite(connection, merchant_id, account_id, opts \\ []) View Source 
content_accounts_claimwebsite(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.AccountsClaimWebsiteResponse.t()}
  | {:error, Tesla.Env.t()}

Claims the website of a Merchant Center sub-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 whose website is claimed.

  • opts (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.
    • :overwrite (boolean()): Only available to selected merchants. When set to True, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account.

Returns

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

Link to this function content_accounts_custombatch(connection, opts \\ []) View Source 
content_accounts_custombatch(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.AccountsCustomBatchResponse.t()}
  | {:error, Tesla.Env.t()}

Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server

  • opts (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 (AccountsCustomBatchRequest):

Returns

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

Link to this function content_accounts_delete(connection, merchant_id, account_id, opts \\ []) View Source 
content_accounts_delete(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Deletes a Merchant Center sub-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, and accountId must be the ID of a sub-account of this account.
  • account_id (String.t): The ID of the account.

  • opts (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.
    • :force (boolean()): Flag to delete sub-accounts with products. The default value is false.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function content_accounts_get(connection, merchant_id, account_id, opts \\ []) View Source 
content_accounts_get(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.Account.t()} | {:error, Tesla.Env.t()}

Retrieves a Merchant Center 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.

  • opts (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.Account{}} on success {:error, info} on failure

Link to this function content_accounts_insert(connection, merchant_id, opts \\ []) View Source 
content_accounts_insert(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.Account.t()} | {:error, Tesla.Env.t()}

Creates a Merchant Center sub-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.

  • opts (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 (Account):

Returns

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

Link to this function content_accounts_link(connection, merchant_id, account_id, opts \\ []) View Source 
content_accounts_link(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.AccountsLinkResponse.t()}
  | {:error, Tesla.Env.t()}

Performs an action on a link between a Merchant Center account and another 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 that should be linked.

  • opts (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 (AccountsLinkRequest):

Returns

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

Link to this function content_accounts_list(connection, merchant_id, opts \\ []) View Source 
content_accounts_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.AccountsListResponse.t()}
  | {:error, Tesla.Env.t()}

Lists 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.

  • opts (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 accounts to return in the response, used for paging.
    • :pageToken (String.t): The token returned by the previous request.

Returns

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

Link to this function content_accounts_patch(connection, merchant_id, account_id, opts \\ []) View Source 
content_accounts_patch(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.Account.t()} | {:error, Tesla.Env.t()}

Updates a Merchant Center 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.

  • opts (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 (Account):

Returns

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

Link to this function content_accounts_update(connection, merchant_id, account_id, opts \\ []) View Source 
content_accounts_update(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.Account.t()} | {:error, Tesla.Env.t()}

Updates a Merchant Center 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.

  • opts (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 (Account):

Returns

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