Method: accounts.programs.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves all programs for the account.
HTTP request
GET https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/programs
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The name of the account for which to retrieve all programs. Format: accounts/{account}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string
Optional. A continuation token, received from a previous programs.list call. Provide this to retrieve the next page.
|
Request body
The request body must be empty.
Response body
Response message for the programs.list method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"programs": [
{
object (Program)
}
],
"nextPageToken": string
} |
| Fields |
programs[] |
object (Program)
The programs for the given account.
|
nextPageToken |
string
A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
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 all programs associated with a specified Merchant Center account.\u003c/p\u003e\n"],["\u003cp\u003eUses a GET request with path and query parameters to filter and paginate results.\u003c/p\u003e\n"],["\u003cp\u003eResponse provides a list of programs and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details retrieving programs associated with an account. The core action is a `GET` HTTP request to `https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/programs`. It uses a required `parent` path parameter (account name) and optional query parameters `pageSize` (max 1000) and `pageToken` for pagination. The request body is empty. The response contains a list of `programs` and an optional `nextPageToken` for subsequent pages. Authorization requires the `https://www.googleapis.com/auth/content` OAuth scope.\n"],null,["# Method: accounts.programs.list\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.ListProgramsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves all programs for the account.\n\n### HTTP request\n\n`GET https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/programs`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The name of the account for which to retrieve all programs. Format: `accounts/{account}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000. |\n| `pageToken` | `string` Optional. A continuation token, received from a previous `programs.list` call. Provide this to retrieve the next page. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for the programs.list method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"programs\": [ { object (/merchant/api/reference/rest/accounts_v1beta/accounts.programs#Program) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `programs[]` | `object (`[Program](/merchant/api/reference/rest/accounts_v1beta/accounts.programs#Program)`)` The programs for the given account. |\n| `nextPageToken` | `string` A token that can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
