Method: exchanges.publishers.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*}/publishers
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent resource name. Example: "exchanges/123".
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of items to return. Max allowed value is 50. If unspecified or more than 50, will use 50 as page size.
|
pageToken |
string
Optional. The nextPageToken value returned from a previous List request, if any.
|
filter |
string
Optional. Allows filtering by product properties. Supported syntax:
- Filter expressions are made up of one or more restrictions.
- Restrictions can be combined by
AND or OR logical operators. A sequence of restrictions implicitly uses AND.
- A restriction has the form of
<field> <operator> <value>.
- The operator must be
EQUALS (=).
- Supported fields:
ExternalPublisherIdDisplayNameStatus
Examples:
The length of this field should be no more than 500 characters.
|
Request body
The request body must be empty.
Response body
Response to list publishers.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"publishers": [
{
object (Publisher)
}
],
"nextPageToken": string
} |
| Fields |
publishers[] |
object (Publisher)
Listed publishers. There will be a maximum number of items returned based on the pageSize field in the request.
|
nextPageToken |
string
Token to retrieve the next page of results, or empty if there are no more results in the list.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/doubleclickbidmanager
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-05-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eLists publishers associated with a given exchange using the \u003ccode\u003eGET\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of publishers by \u003ccode\u003eExternalPublisherId\u003c/code\u003e, \u003ccode\u003eDisplayName\u003c/code\u003e, and \u003ccode\u003eStatus\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e to retrieve large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/doubleclickbidmanager\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes an array of publishers and a token for retrieving the next page of results.\u003c/p\u003e\n"]]],["This document outlines the process for listing publishers via an API. It uses a `GET` HTTP request to a specified URL, including a required `parent` path parameter. Optional query parameters include `pageSize`, `pageToken`, and a `filter` for refining results. The request body must be empty. The successful response is a JSON object containing a list of `publishers` and a `nextPageToken` for pagination. This requires `https://www.googleapis.com/auth/doubleclickbidmanager` authorization scope.\n"],null,["# Method: exchanges.publishers.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.ListPublishersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nLists publishers.\n\n### HTTP request\n\n`GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*}/publishers`\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 parent resource name. Example: \"exchanges/123\". |\n\n### Query parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of items to return. Max allowed value is 50. If unspecified or more than 50, will use 50 as page size. |\n| `pageToken` | `string` Optional. The nextPageToken value returned from a previous List request, if any. |\n| `filter` | `string` Optional. Allows filtering by product properties. Supported syntax: - Filter expressions are made up of one or more restrictions. - Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. - A restriction has the form of `\u003cfield\u003e \u003coperator\u003e \u003cvalue\u003e`. - The operator must be `EQUALS (=)`. - Supported fields: - `ExternalPublisherId` - `DisplayName` - `Status` Examples: - Get Publishers with status set to Active `status=DISCOVERY_OBJECT_STATUS_ACTIVE` - Get Orders with display name of \"display name\" `displayName=\"display name\"` The length of this field should be no more than 500 characters. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse to list publishers.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"publishers\": [ { object (/display-video/seller/reference/rest/v1beta1/exchanges.publishers#Publisher) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `publishers[]` | `object (`[Publisher](/display-video/seller/reference/rest/v1beta1/exchanges.publishers#Publisher)`)` Listed publishers. There will be a maximum number of items returned based on the pageSize field in the request. |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/doubleclickbidmanager`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
