google_api_content v0.4.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 a Merchant Center account and another account
Lists the sub-accounts in your Merchant Center account
Updates a Merchant Center account. This method supports patch semantics
Updates a Merchant Center account
Link to this section Functions
content_accounts_authinfo(connection, optional_params \\ [], opts \\ []) View Source
Returns information about the authenticated user.
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.
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 Source
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.
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.
- :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
content_accounts_custombatch(connection, optional_params \\ [], opts \\ []) View Source
Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
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.
- :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
content_accounts_delete(connection, merchant_id, account_id, optional_params \\ [], opts \\ []) View Source
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.
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.
- :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
content_accounts_get(connection, merchant_id, account_id, optional_params \\ [], opts \\ []) View Source
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.
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.
Returns
{:ok, %GoogleApi.Content.V2.Model.Account{}} on success {:error, info} on failure
content_accounts_insert(connection, merchant_id, optional_params \\ [], opts \\ []) View Source
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.
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.
- :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
content_accounts_link(connection, merchant_id, account_id, optional_params \\ [], opts \\ []) View Source
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.
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 (AccountsLinkRequest):
Returns
{:ok, %GoogleApi.Content.V2.Model.AccountsLinkResponse{}} on success {:error, info} on failure
content_accounts_list(connection, merchant_id, optional_params \\ [], opts \\ []) View Source
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.
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.
- :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
content_accounts_patch(connection, merchant_id, account_id, optional_params \\ [], opts \\ []) View Source
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.
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.
- :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
content_accounts_update(connection, merchant_id, account_id, optional_params \\ [], opts \\ []) View Source
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.
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.
- :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