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.
Method: firstPartyAndPartnerAudiences.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Lista os públicos-alvo próprios e de parceiros.
A ordem é definida pelo parâmetro orderBy.
Solicitação HTTP
GET https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
| Parâmetros |
pageSize |
integer
Opcional. Tamanho da página solicitada. O valor precisa estar entre 1 e 5000. Se não for especificado, o valor padrão será 5000. Retorna o código de erro INVALID_ARGUMENT se um valor inválido for especificado.
|
pageToken |
string
Opcional. 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 firstPartyAndPartnerAudiences.list. Se não for especificado, a primeira página de resultados será retornada.
|
orderBy |
string
Opcional. Campo que classifica a lista. Os valores aceitáveis são:
FirstPartyAndPartnerAudienceId (padrã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. Exemplo: displayName desc.
|
filter |
string
Opcional. Permite filtrar por campos de público-alvo próprio e de parceiros. Sintaxe aceita:
- As expressões de filtro para públicos-alvo próprios e de parceiros só podem conter, no máximo, uma restrição.
- Uma restrição tem o formato
{field} {operator} {value}.
- Todos os campos precisam usar o operador
HAS (:).
Campos compatíveis:
Exemplos:
- Todos os públicos-alvo próprios e de parceiros em que o nome de exibição contém "Google":
displayName:"Google".
O comprimento deste campo não pode exceder 500 caracteres. Consulte nosso guia de filtragem de solicitações LIST para mais informações.
|
Parâmetro de união accessor. Obrigatório. Identifica a entidade do DV360 em que a solicitação está sendo feita. A solicitação LIST só vai retornar entidades de público-alvo próprias e de parceiros que são acessíveis à entidade do DV360 identificada no accessor. accessor pode ser apenas de um dos tipos a seguir: |
partnerId |
string (int64 format)
O ID do parceiro que tem acesso aos públicos-alvo próprios e de parceiros buscados.
|
advertiserId |
string (int64 format)
O ID do anunciante que tem acesso aos públicos-alvo próprios e de parceiros buscados.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:
| Campos |
firstPartyAndPartnerAudiences[] |
object (FirstPartyAndPartnerAudience)
A lista de públicos-alvo próprios e de parceiros. As propriedades de tamanho do público-alvo não serão incluídas. Essa lista não será exibida se estiver vazia.
|
nextPageToken |
string
Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada subsequente para o método firstPartyAndPartnerAudiences.list para recuperar a próxima página de resultados.
|
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/display-video
Para mais informações, consulte OAuth 2.0 Overview.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# Method: firstPartyAndPartnerAudiences.list\n\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.ListFirstPartyAndPartnerAudiencesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists first party and partner audiences.\n\nThe order is defined by the [orderBy](/display-video/api/reference/rest/v4/firstPartyAndPartnerAudiences/list#body.QUERY_PARAMETERS.order_by) parameter.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |\n| `pageToken` | `string` Optional. A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v4/firstPartyAndPartnerAudiences/list#body.ListFirstPartyAndPartnerAudiencesResponse.FIELDS.next_page_token) returned from the previous call to `firstPartyAndPartnerAudiences.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Optional. Field by which to sort the list. Acceptable values are: - `FirstPartyAndPartnerAudienceId` (default) - `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`. |\n| `filter` | `string` Optional. Allows filtering by first party and partner audience fields. Supported syntax: - Filter expressions for first party and partner audiences can only contain at most one restriction. - A restriction has the form of `{field} {operator} {value}`. - All fields must use the `HAS (:)` operator. Supported fields: - `displayName` Examples: - All first party and partner audiences for which the display name contains \"Google\": `displayName:\"Google\"`. 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| Union parameter `accessor`. Required. Identifies which DV360 entity the request is being made within. The LIST request will only return first party and partner audience entities that are accessible to the DV360 entity identified within the `accessor`. `accessor` can be only one of the following: ||\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the partner that has access to the fetched first party and partner audiences. |\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the advertiser that has access to the fetched first party and partner audiences. |\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| ``` { \"firstPartyAndPartnerAudiences\": [ { object (/display-video/api/reference/rest/v4/firstPartyAndPartnerAudiences#FirstPartyAndPartnerAudience) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `firstPartyAndPartnerAudiences[]` | `object (`[FirstPartyAndPartnerAudience](/display-video/api/reference/rest/v4/firstPartyAndPartnerAudiences#FirstPartyAndPartnerAudience)`)` The list of first party and partner audiences. Audience size properties will not be included. 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/v4/firstPartyAndPartnerAudiences/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `firstPartyAndPartnerAudiences.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)."]]
