A partir del
8 de septiembre de 2025, cada elemento de la línea nuevo deberá declarar si publicará anuncios políticos de la Unión Europea (UE). Las cargas de la API de Display & Video 360 y del SDF que no proporcionen declaraciones fallarán. Consulta nuestra
página de bajas para obtener más detalles sobre cómo actualizar tu integración y realizar esta declaración.
Method: advertisers.adGroups.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Muestra una lista de los grupos de anuncios.
Solicitud HTTP
GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroups
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
advertiserId |
string (int64 format)
Obligatorio. Es el ID del anunciante al que pertenecen los grupos de anuncios.
|
Parámetros de consulta
| Parámetros |
pageSize |
integer
Opcional. Indica el tamaño de la página solicitada. Debe estar entre 1 y 200. Si no se especifica, se establecerá de forma predeterminada como 100. Muestra el código de error INVALID_ARGUMENT si se especifica un valor no válido.
|
pageToken |
string
Opcional. Un token que identifica una página de resultados que debe mostrar el servidor. Por lo general, este es el valor de nextPageToken que se muestra de la llamada anterior al método adGroups.list. Si no se especifica, se mostrará la primera página de resultados.
|
orderBy |
string
Opcional. Campo según el cual se ordenan los resultados. Los valores aceptables son:
displayName (predeterminada)entityStatus El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente de un campo, se debe agregar un sufijo "desc" al nombre del campo. Ejemplo: displayName desc.
|
filter |
string
Opcional. Permite filtrar por campos de grupos de anuncios personalizados. Sintaxis admitida:
- Las expresiones de filtro se componen de una o más restricciones.
- Las restricciones se pueden combinar con
AND y OR. Una secuencia de restricciones usa AND de forma implícita.
- Una restricción tiene el formato
{field} {operator} {value}.
- Todos los campos deben usar el operador
EQUALS (=).
Propiedades admitidas:
adGroupIddisplayNameentityStatuslineItemIdadGroupFormat Ejemplos:
- Todos los grupos de anuncios de una línea de pedido:
lineItemId="1234"
- Todos los grupos de anuncios
AD_GROUP_FORMAT_IN_STREAM de ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED de un anunciante: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"
La longitud de este campo no debe superar los 500 caracteres. Consulta nuestra guía de solicitudes de LIST de filtro para obtener más información.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:
| Representación JSON |
{
"adGroups": [
{
object (AdGroup)
}
],
"nextPageToken": string
} |
| Campos |
adGroups[] |
object (AdGroup)
La lista de grupos de anuncios Esta lista no aparecerá si está vacía.
|
nextPageToken |
string
Un token para recuperar los resultados de la página siguiente. Pasa este valor en el campo pageToken en la llamada posterior al método adGroups.list para recuperar la siguiente página de resultados.
|
Permisos de autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/display-video
Para obtener más información, consulta OAuth 2.0 Overview.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[],["This document outlines the `adGroups.list` method in the Display & Video 360 API v4. It details how to retrieve a list of ad groups associated with a specific advertiser. Key actions include sending a GET request to a specified URL, using the `advertiserId` as a path parameter. Optional query parameters like `pageSize`, `pageToken`, `orderBy`, and `filter` enable result customization. The response returns a list of `adGroups` and a `nextPageToken` for pagination. The request body should be empty, and specific OAuth scopes are needed for authorization.\n"],null,["# Method: advertisers.adGroups.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.ListAdGroupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists ad groups.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the advertiser the ad groups belongs to. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. 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/advertisers.adGroups/list#body.ListAdGroupsResponse.FIELDS.next_page_token) returned from the previous call to `adGroups.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: - `displayName` (default) - `entityStatus` 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 custom ad group fields. Supported syntax: - Filter expressions are made up of one or more restrictions. - Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. - A restriction has the form of `{field} {operator} {value}`. - All fields must use the `EQUALS (=)` operator. Supported properties: - `adGroupId` - `displayName` - `entityStatus` - `lineItemId` - `adGroupFormat` Examples: - All ad groups under an line item: `lineItemId=\"1234\"` - All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupFormat=\"AD_GROUP_FORMAT_IN_STREAM\"` 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| ``` { \"adGroups\": [ { object (/display-video/api/reference/rest/v4/advertisers.adGroups#AdGroup) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adGroups[]` | `object (`[AdGroup](/display-video/api/reference/rest/v4/advertisers.adGroups#AdGroup)`)` The list of ad groups. 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/advertisers.adGroups/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `adGroups.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)."]]
