A partir de 8 de setembro de 2025, todos os novos itens de linha precisarão declarar se vão veicular anúncios políticos da União Europeia (UE). As APIs do Display & Video 360 e os uploads de SDF que não fornecem declarações vão falhar. Consulte nossa página de suspensões de uso para mais detalhes sobre como atualizar sua integração e fazer essa declaração.
Tamanho da página solicitada. O valor precisa estar entre 1 e 200. Se não for especificado, 100 será usado como padrão.
pageToken
string
Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado da chamada anterior para o método partners.list. Se não for especificado, a primeira página de resultados será retornada.
orderBy
string
Campo que classifica a lista. Os valores aceitáveis são:
displayName
A ordem de classificação padrão é crescente. Para especificar a ordem decrescente de um campo, adicione o sufixo "desc" ao nome dele. Por exemplo, displayName desc.
filter
string
Permite filtrar por campos do parceiro.
Sintaxe aceita:
As expressões de filtro são compostas por uma ou mais restrições.
As restrições podem ser combinadas por operadores lógicos AND ou OR. Uma sequência de restrições usa AND implicitamente.
Uma restrição tem o formato {field} {operator} {value}.
Todos os campos precisam usar o operador EQUALS (=).
Campos compatíveis:
entityStatus
Exemplos:
Todos os parceiros ativos: entityStatus="ENTITY_STATUS_ACTIVE"
O comprimento deste campo não pode exceder 500 caracteres.
Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada subsequente para o método partners.list para recuperar a próxima página de resultados.
[null,null,["Última atualização 2025-07-25 UTC."],[[["\u003cp\u003eLists partners accessible to the current user, ordered by the \u003ccode\u003eorderBy\u003c/code\u003e parameter and filterable by fields like \u003ccode\u003eentityStatus\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters for retrieving results in manageable chunks.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of \u003ccode\u003ePartner\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e for accessing subsequent pages, if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/display-video\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eSends an empty request body and expects a JSON response containing partner data.\u003c/p\u003e\n"]]],[],null,["# Method: partners.list\n\n| Display \\& Video 360 API is deprecated and will sunset on **October 7, 2025** . Migrate to [Display \\& Video 360 API v4](/display-video/api/reference/rest/v4) before sunset to avoid an interruption in service.\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListPartnersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists partners that are accessible to the current user.\n\nThe order is defined by the [orderBy](/display-video/api/reference/rest/v3/partners/list#body.QUERY_PARAMETERS.order_by) parameter.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v3/partners`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v3/partners/list#body.ListPartnersResponse.FIELDS.next_page_token) returned from the previous call to `partners.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Field by which to sort the list. Acceptable values are: - `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`. |\n| `filter` | `string` Allows filtering by partner fields. 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}`. - All fields must use the `EQUALS (=)` operator. Supported fields: - `entityStatus` Examples: - All active partners: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |\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| ``` { \"partners\": [ { object (/display-video/api/reference/rest/v3/partners#Partner) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `partners[]` | `object (`[Partner](/display-video/api/reference/rest/v3/partners#Partner)`)` The list of partners. This list will be absent if empty. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/api/reference/rest/v3/partners/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `partners.list` method to retrieve the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
