rocket
Meet
Merchant API
- the official successor to Content API for Shopping.
update
Get the latest
on new Merchant API features, bug fixes, and updates.
add_alert
Note: Content API for Shopping will be sunset on August 18, 2026.
Method: accounts.listlinks
Stay organized with collections
Save and categorize content based on your preferences.
Returns the list of accounts linked to your Merchant Center account.
HTTP request
GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/accounts/{accountId}/listlinks
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 for which to list links.
|
Query parameters
Parameters |
maxResults |
integer (uint32 format)
The maximum number of links to return in the response, used for pagination. The minimum allowed value is 5 results per page. If provided value is lower than 5, it will be automatically increased to 5.
|
pageToken |
string
The token returned by the previous request.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
{
"nextPageToken": string,
"links": [
{
object (LinkedAccount )
}
],
"kind": string
} |
Fields |
nextPageToken |
string
The token for the retrieval of the next page of links.
|
links[] |
object (LinkedAccount )
The list of available links.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string "content#accountsListLinksResponse ".
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
LinkedAccount
JSON representation |
{
"linkedAccountId": string,
"services": [
{
object (LinkService )
}
]
} |
Fields |
linkedAccountId |
string
The ID of the linked account.
|
services[] |
object (LinkService )
accounts.list of provided services.
|
LinkService
JSON representation |
{
"service": string,
"status": string
} |
Fields |
service |
string
Service provided to or by the linked account. Acceptable values are: - "
shoppingActionsOrderManagement " - "
shoppingActionsProductManagement " - "
shoppingAdsProductManagement " - "
paymentProcessing "
|
status |
string
Status of the link Acceptable values are: - "
active " - "
inactive " - "
pending "
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["\u003cp\u003eRetrieves a list of accounts linked to your Merchant Center account, including details about the services they provide.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to handle large result sets, allowing you to specify the maximum number of links per page and retrieve subsequent pages using tokens.\u003c/p\u003e\n"],["\u003cp\u003eProvides information about the status and type of service for each linked account, such as shopping actions order management or payment processing.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization using OAuth 2.0 with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUses a simple HTTP GET request with path and query parameters to specify the managing account, target account, and pagination options.\u003c/p\u003e\n"]]],["This document outlines how to retrieve a list of accounts linked to a Merchant Center account using a `GET` request. The request URL requires `merchantId` and `accountId` path parameters. Optional query parameters include `maxResults` and `pageToken` for pagination. The request body must be empty. The successful response includes a `nextPageToken`, a list of `links` (each a `LinkedAccount`), and a `kind` field. Each `LinkedAccount` contains `linkedAccountId` and an array of `services` with service type and link `status`.\n"],null,["# Method: accounts.listlinks\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.AccountsListLinksResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [LinkedAccount](#LinkedAccount)\n - [JSON representation](#LinkedAccount.SCHEMA_REPRESENTATION)\n- [LinkService](#LinkService)\n - [JSON representation](#LinkService.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nReturns the list of accounts linked to your Merchant Center account.\n\n### HTTP request\n\n`GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/accounts/{accountId}/listlinks`\n\n### Path parameters\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `merchantId` | `string` The ID of the managing account. If this parameter is not the same as [accountId](#accountId), then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. |\n| `accountId` | `string` The ID of the account for which to list links. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` The maximum number of links to return in the response, used for pagination. The minimum allowed value is 5 results per page. If provided value is lower than 5, it will be automatically increased to 5. |\n| `pageToken` | `string` The token returned by the previous request. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"nextPageToken\": string, \"links\": [ { object (/shopping-content/reference/rest/v2.1/accounts/listlinks#LinkedAccount) } ], \"kind\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `nextPageToken` | `string` The token for the retrieval of the next page of links. |\n| `links[]` | `object (`[LinkedAccount](/shopping-content/reference/rest/v2.1/accounts/listlinks#LinkedAccount)`)` The list of available links. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#accountsListLinksResponse`\". |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nLinkedAccount\n-------------\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"linkedAccountId\": string, \"services\": [ { object (/shopping-content/reference/rest/v2.1/accounts/listlinks#LinkService) } ] } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `linkedAccountId` | `string` The ID of the linked account. |\n| `services[]` | `object (`[LinkService](/shopping-content/reference/rest/v2.1/accounts/listlinks#LinkService)`)` accounts.list of provided services. |\n\nLinkService\n-----------\n\n| JSON representation |\n|-------------------------------------------------|\n| ``` { \"service\": string, \"status\": string } ``` |\n\n| Fields ||\n|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `service` | `string` Service provided to or by the linked account. Acceptable values are: - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingAdsProductManagement`\" - \"`paymentProcessing`\" \u003cbr /\u003e |\n| `status` | `string` Status of the link Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" \u003cbr /\u003e |"]]