AI-generated Key Takeaways
-
Retrieves a list of accounts linked to your Merchant Center account, including details about the services they provide.
-
Supports pagination to handle large result sets, allowing you to specify the maximum number of links per page and retrieve subsequent pages using tokens.
-
Provides information about the status and type of service for each linked account, such as shopping actions order management or payment processing.
-
Requires authorization using OAuth 2.0 with the
https://www.googleapis.com/auth/contentscope. -
Uses a simple HTTP GET request with path and query parameters to specify the managing account, target account, and pagination options.
- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- LinkedAccount
- LinkService
- Try it!
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 |
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 |
The ID of the account for which to list links. |
Query parameters
| Parameters | |
|---|---|
maxResults |
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 |
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 ( |
| Fields | |
|---|---|
nextPageToken |
The token for the retrieval of the next page of links. |
links[] |
The list of available links. |
kind |
Identifies what kind of resource this is. Value: the fixed string " |
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 ( |
| Fields | |
|---|---|
linkedAccountId |
The ID of the linked account. |
services[] |
accounts.list of provided services. |
LinkService
| JSON representation |
|---|
{ "service": string, "status": string } |
| Fields | |
|---|---|
service |
Service provided to or by the linked account. Acceptable values are:
|
status |
Status of the link Acceptable values are:
|