google_api_content v0.25.0 GoogleApi.Content.V2.Api.Accounts View Source
API calls for all endpoints tagged Accounts
.
Link to this section Summary
Functions
Returns information about the authenticated user.
Claims the website of a Merchant Center sub-account.
Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
Deletes a Merchant Center sub-account.
Retrieves a Merchant Center account.
Creates a Merchant Center sub-account.
Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
Lists the sub-accounts in your Merchant Center account.
Updates a Merchant Center account.
Link to this section Functions
content_accounts_authinfo(connection, optional_params \\ [], opts \\ [])
View Sourcecontent_accounts_authinfo(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Content.V2.Model.AccountsAuthInfoResponse.t()} | {:error, Tesla.Env.t()}
Returns information about the authenticated user.
Parameters
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to serveroptional_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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V2.Model.AccountsAuthInfoResponse{}}
on success{:error, info}
on failure
content_accounts_claimwebsite(connection, merchant_id, account_id, optional_params \\ [], opts \\ [])
View Sourcecontent_accounts_claimwebsite( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.AccountsClaimWebsiteResponse.t()} | {:error, Tesla.Env.t()}
Claims the website of a Merchant Center sub-account.
Parameters
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to servermerchant_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 whose website is claimed.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.:overwrite
(type: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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V2.Model.AccountsClaimWebsiteResponse{}}
on success{:error, info}
on failure
content_accounts_custombatch(connection, optional_params \\ [], opts \\ [])
View Sourcecontent_accounts_custombatch(Tesla.Env.client(), keyword(), 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
(type:GoogleApi.Content.V2.Connection.t
) - Connection to serveroptional_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.:dryRun
(type:boolean()
) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).:body
(type:GoogleApi.Content.V2.Model.AccountsCustomBatchRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V2.Model.AccountsCustomBatchResponse{}}
on success{:error, info}
on failure
content_accounts_delete(connection, merchant_id, account_id, optional_params \\ [], opts \\ [])
View Sourcecontent_accounts_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Deletes a Merchant Center sub-account.
Parameters
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to servermerchant_id
(type: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
(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.:dryRun
(type:boolean()
) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).:force
(type:boolean()
) - Flag to delete sub-accounts with products. The default value is false.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
content_accounts_get(connection, merchant_id, account_id, optional_params \\ [], opts \\ [])
View Sourcecontent_accounts_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.Account.t()} | {:error, Tesla.Env.t()}
Retrieves a Merchant Center account.
Parameters
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to servermerchant_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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V2.Model.Account{}}
on success{:error, info}
on failure
content_accounts_insert(connection, merchant_id, optional_params \\ [], opts \\ [])
View Sourcecontent_accounts_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Content.V2.Model.Account.t()} | {:error, Tesla.Env.t()}
Creates a Merchant Center sub-account.
Parameters
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to servermerchant_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.:dryRun
(type:boolean()
) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).:body
(type:GoogleApi.Content.V2.Model.Account.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V2.Model.Account{}}
on success{:error, info}
on failure
content_accounts_link(connection, merchant_id, account_id, optional_params \\ [], opts \\ [])
View Sourcecontent_accounts_link( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.AccountsLinkResponse.t()} | {:error, Tesla.Env.t()}
Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
Parameters
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to servermerchant_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 that should be linked.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.AccountsLinkRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V2.Model.AccountsLinkResponse{}}
on success{:error, info}
on failure
content_accounts_list(connection, merchant_id, optional_params \\ [], opts \\ [])
View Sourcecontent_accounts_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Content.V2.Model.AccountsListResponse.t()} | {:error, Tesla.Env.t()}
Lists the sub-accounts in your Merchant Center account.
Parameters
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to servermerchant_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.:maxResults
(type:integer()
) - The maximum number of accounts 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.AccountsListResponse{}}
on success{:error, info}
on failure
content_accounts_update(connection, merchant_id, account_id, optional_params \\ [], opts \\ [])
View Sourcecontent_accounts_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.Account.t()} | {:error, Tesla.Env.t()}
Updates a Merchant Center account.
Parameters
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to servermerchant_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.:dryRun
(type:boolean()
) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).:body
(type:GoogleApi.Content.V2.Model.Account.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V2.Model.Account{}}
on success{:error, info}
on failure