Method: advertisers.youtubeAdGroupAds.list

Muestra una lista de anuncios del grupo de anuncios de YouTube.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroupAds

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
advertiserId

string (int64 format)

Obligatorio. El ID del anunciante al que pertenecen los grupos de anuncios.

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. El valor debe estar entre 1 y 100. Si no se especifica, el valor predeterminado será 100. Muestra el código de error INVALID_ARGUMENT si se especifica un valor no válido.
pageToken

string

Es un token que identifica una página de resultados que el servidor debería mostrar. Por lo general, es el valor de nextPageToken que muestra la llamada anterior al método youtubeAdGroupAds.list. Si no se especifica, se mostrará la primera página de resultados.
orderBy

string

Campo por el que se ordenará la lista. Los valores aceptables son:

  • displayName (predeterminada)
  • entityStatus

El orden predeterminado es ascendente. Para especificar el orden descendente para un campo, se debe agregar el sufijo "desc" al nombre del campo. Ejemplo: displayName desc.
filter

string

Permite filtrar por campos de anuncios de grupos de anuncios personalizados de YouTube.

Sintaxis compatible:

  • Las expresiones de filtro constan de una o más restricciones.
  • Las restricciones se pueden combinar con AND y OR. Una secuencia de restricciones usa AND de manera implícita.
  • Una restricción tiene el formato {field} {operator} {value}.
  • Todos los campos deben usar el operador EQUALS (=).

Campos admitidos:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

Ejemplos:

  • Todos los anuncios del grupo de anuncios en un grupo de anuncios: adGroupId="1234"
  • Todos los anuncios de un grupo de anuncios con el valorentityStatus de ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

La longitud de este campo no debe superar los 500 caracteres.

Consulta nuestra guía sobre solicitudes de filtro LIST 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 
{
  "youtubeAdGroupAds": [
    {
      object (YoutubeAdGroupAd)
    }
  ],
  "nextPageToken": string
}
Campos
youtubeAdGroupAds[]

object (YoutubeAdGroupAd)

La lista de anuncios del grupo 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 youtubeAdGroupAds.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 la Descripción general de OAuth 2.0.