Method: accounts.link

AI-generated Key Takeaways

• Links two Merchant Center accounts, allowing for actions like approving, removing, or requesting a link.

• Requires the managing account ID and the ID of the account to be linked.

• Supports different link types such as channelPartner, eCommercePlatform, and paymentServiceProvider, each with specific requirements.

• Uses HTTP POST request to https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/accounts/{accountId}/link to manage links.

• Needs authorization with the https://www.googleapis.com/auth/content scope.

• HTTP request
• Path parameters
• Request body
• Response body
  • JSON representation
• Authorization scopes
• AccountsLinkRequest
  • JSON representation
• PaymentServiceProviderLinkInfo
  • JSON representation
• ECommercePlatformLinkInfo
  • JSON representation
• Try it!

Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/accounts/{accountId}/link

Path parameters

Parameters
merchantId	string 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.
accountId	string The ID of the account that should be linked.

Request body

The request body contains an instance of AccountsLinkRequest.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{ "kind": string }

Fields
kind	string Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse".

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

AccountsLinkRequest

JSON representation
{ "action": string, "linkedAccountId": string, "linkType": string, "services": [ string ], "paymentServiceProviderLinkInfo": { object (PaymentServiceProviderLinkInfo) }, "eCommercePlatformLinkInfo": { object (ECommercePlatformLinkInfo) } }

Fields
action	string Action to perform for this link. The "request" action is only available to select merchants. Acceptable values are: "approve" "remove" "request"
linkedAccountId	string The ID of the linked account.
linkType	string Type of the link between the two accounts. Acceptable values are: "channelPartner" "eCommercePlatform" "paymentServiceProvider"
services[]	string Acceptable values are: "shoppingAdsProductManagement" "shoppingActionsProductManagement" "shoppingActionsOrderManagement" "paymentProcessing"
paymentServiceProviderLinkInfo	object (PaymentServiceProviderLinkInfo) Additional information required for paymentServiceProvider link type.
eCommercePlatformLinkInfo	object (ECommercePlatformLinkInfo) Additional information required for eCommercePlatform link type.

PaymentServiceProviderLinkInfo

Additional information required for PAYMENT_SERVICE_PROVIDER link type.

JSON representation
{ "externalAccountId": string, "externalAccountBusinessCountry": string }

Fields
externalAccountId	string The id used by the third party service provider to identify the merchant.
externalAccountBusinessCountry	string The business country of the merchant account as identified by the third party service provider.

ECommercePlatformLinkInfo

Additional information required for E_COMMERCE_PLATFORM link type.

JSON representation
{ "externalAccountId": string }

Fields
externalAccountId	string The id used by the third party service provider to identify the merchant.