Method: advertisers.creatives.list

Muestra las creatividades de un anunciante.

El orden se define con el parámetro orderBy. Si no se especifica un filter por entityStatus, las creatividades con ENTITY_STATUS_ARCHIVED no se incluirán en los resultados.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/creatives

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 para el que se enumerarán las creatividades.

Parámetros de consulta

Parámetros
pageSize

integer

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

pageToken

string

Un token que identifica una página de resultados que el servidor debe mostrar. Por lo general, este es el valor de nextPageToken que se muestra de la llamada anterior al método creatives.list. Si no se especifica, se mostrará la primera página de resultados.

orderBy

string

Campo según el cual se ordenan los resultados. Los valores aceptables son:

  • creativeId (predeterminada)
  • createTime
  • mediaDuration
  • dimensions (ordena primero por ancho y, luego, por altura)

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: createTime desc.

filter

string

Permite filtrar por campos de creatividad.

Sintaxis admitida:

  • Las expresiones de filtro se componen de una o más restricciones.
  • Las restricciones se pueden combinar con operadores lógicos AND o OR. Una secuencia de restricciones usa AND de forma implícita.
  • Una restricción tiene el formato {field} {operator} {value}.
  • El campo lineItemIds debe usar el operador HAS (:).
  • El campo updateTime debe usar los operadores GREATER THAN OR EQUAL TO (>=) o LESS THAN OR EQUAL TO (<=).
  • Todos los demás campos deben usar el operador EQUALS (=).
  • Para los campos entityStatus, minDuration, maxDuration, updateTime y dynamic, puede haber una restricción como máximo.

Campos admitidos:

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions (entrada en forma de {width}x{height})
  • dynamic
  • entityStatus
  • exchangeReviewStatus (entrada en forma de {exchange}-{reviewStatus})
  • lineItemIds
  • maxDuration (entrada en forma de {duration}s. Solo se admiten segundos).
  • minDuration (ingresa con el formato {duration}s. Solo se admiten segundos).
  • updateTime (entrada en formato ISO 8601 o YYYY-MM-DDTHH:MM:SSZ)

Notas:

  • En el caso de updateTime, el valor del campo de un recurso de creatividad refleja la última vez que se actualizó una creatividad, lo que incluye las actualizaciones realizadas por el sistema (p. ej., actualizaciones de revisión de creatividades).

Ejemplos:

  • Todas las creatividades nativas: creativeType="CREATIVE_TYPE_NATIVE"
  • Todas las creatividades activas con dimensiones de 300 x 400 o 50 x 100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • Todas las creatividades dinámicas aprobadas por AdX o AppNexus, con una duración mínima de 5 segundos y 200 ms: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • Todas las creatividades de video asociadas con el ID de la línea de pedido 1 o 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Buscar creatividades por varios ID: creativeId=1 OR creativeId=2
  • Todas las creatividades con una hora de actualización superior o igual a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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
{
  "creatives": [
    {
      object (Creative)
    }
  ],
  "nextPageToken": string
}
Campos
creatives[]

object (Creative)

Es la lista de creatividades.

Esta lista no se mostrará 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 ListCreativesRequest para recuperar la siguiente página de resultados. Si este campo es nulo, significa que esta es la última página.

Alcances 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.