Compartir a través de


Servicio vasto creativo

Puede usar Creative Vast Service para agregar creatividades de vídeo o audio a Xandr. Todas las creatividades deben estar asociadas a un anunciante o editor.

  • Puede ver su id. de anunciante llamando al Servicio de anunciantes.
  • Puede ver el identificador del publicador llamando al servicio publisher.
  • Puede adjuntar una creatividad a un publicador para usarla como creatividad predeterminada para una ubicación. A continuación, adjuntaría la creatividad a una ubicación a través de su identificador mediante el servicio de selección de ubicación.

Nota:

video_attribute siempre es necesario en el punto de creative-vastconexión.

Auditoría

Xandr trabaja con miembros que se preocupan profundamente por la marca y la reputación. Por esta razón, nos encargamos de asegurarnos de que los anuncios (creativos) que pasan por nuestro sistema sean aceptables para todas las partes. Para garantizar la calidad, todas las creatividades que sirven en el inventario de terceros deben registrarse previamente mediante creative service.

  • Las creatividades se identifican por su media_url (una dirección URL de adserver de terceros o una dirección URL de content delivery network para un archivo Flash o de vídeo).
  • Xandr comprueba media_urls periódicamente. Si un archivo desaparece, la creatividad se tratará como no auditada.
  • Una vez que una creatividad ha superado la auditoría de Xandr, ciertos cambios en la creatividad hacen que se vuelva a enviar para la auditoría. Para obtener más información, vea Los cambios que provocan una nueva auditoría a continuación.
  • Para obtener más información sobre la auditoría, consulte Creative Standards and Auditing(Estándares creativos y auditoría).

API de REST

Http (método) Endpoint Description
POST https://api.appnexus.com/creative-vast?advertiser_id=ADVERTISER_ID
(JSON creativo)
Agrega un nuevo contenido de audio o vídeo hospedado a uno de tus anunciantes.
POST https://api.appnexus.com/creative-vast?publisher_id=PUBLISHER_ID
(JSON creativo)
Agregue un nuevo contenido de audio o vídeo hospedado a uno de los publicadores.
PUT - https://api.appnexus.com/creative-vast?id=CREATIVE_ID& advertiser_id=ADVERTISER_ID
- https://api.appnexus.com/creative-vast?id=CREATIVE_ID&p ublisher_id=PUBLISHER_ID
(JSON creativo)
Modifique una creatividad de audio o vídeo hospedada existente.
GET https://api.appnexus.com/creative-vast Ver todas las creatividades de vídeo o audio hospedadas.
GET - https://api.appnexus.com/creative-vast?advertiser_id=ADVERTISER_ID
- https://api.appnexus.com/creative-vast?advertiser_code=ADVERTISER_CODE
- https://api.appnexus.com/creative-vast?publisher_id=PUBLISHER_ID
- https://api.appnexus.com/creative-vast?publisher_code=PUBLISHER_CODE
Ver todas las creatividades de vídeo o audio hospedadas para un anunciante o editor.
GET - https://api.appnexus.com/creative-vast?id=CREATIVE_ID
- https://api.appnexus.com/creative-vast?code=CREATIVE_CODE
Ver una creatividad específica.
GET https://api.appnexus.com/creative-vast?id=1,2,3 Vea varias creatividades por identificador mediante una lista separada por comas.
GET https://api.appnexus.com/creative-vast?audit_stats=true Ver estadísticas de auditoría creativas.
DELETE - https://api.appnexus.com/creative-vast?id=CREATIVE_ID& advertiser_id=ADVERTISER_ID
- https://api.appnexus.com/creative-vast?id=CREATIVE_ID&p ublisher_id=PUBLISHER_ID
Eliminar una creatividad.

Nota:

Puede filtrar las creatividades en función de cuándo se atienden por primera y última vez. Esto resulta especialmente útil cuando se está aproximando al límite de objetos y es necesario identificar las creatividades que se pueden eliminar del sistema. Para obtener más información, consulte Primera ejecución o última ejecución a continuación.

Sugerencia

La respuesta indica el número de creatividades con cada estado de auditoría de Xandr, Microsoft y Google. Para obtener el formato de respuesta, consulte los ejemplos siguientes.

No se puede eliminar una creatividad que se usa como la creatividad predeterminada para un miembro o ubicación. Las creatividades predeterminadas se pueden eliminar una vez que se desasocie de una ubicación.

Campos JSON

Campo Tipo Descripción
id Entero Identificador interno asociado a la creatividad.
- Predeterminado: Número generado automáticamente.
- Obligatorio On:PUT, en la cadena de consulta.
code string (100) Código personalizado para la creatividad.
code2 string (100) Código personalizado adicional para la creatividad.
name string (100) Nombre de la creatividad.
type enumeración Tipo de creatividad. Posibles valores:
- "standard"
- "html"
- "video"

Nota:Aviso alfa-beta
Este campo o característica forma parte de la funcionalidad actualmente en la fase Alfa o Beta. Por lo tanto, está sujeto a cambios.
Solo lectura.
advertiser_id Entero Id. del anunciante al que se adjunta la creatividad.
Obligatorio On:POST/PUT, en la cadena de consulta, si la creatividad está asociada a un anunciante.
publisher_id Entero Identificador de la compra del publicador o medio al que se adjunta la creatividad.
Obligatorio On:POST/PUT, en la cadena de consulta, si la creatividad está asociada a un anunciante.
brand_id Entero El id. de la marca de la empresa que anuncia la creatividad. Si se incluye, el equipo de auditoría de Xandr lo comprobará. Si no se incluye, el equipo de auditoría lo asignará. Para recuperar una lista completa de marcas, consulte el Servicio de marca.
state enumeración El estado de la creatividad. Valores posibles: "active" o "inactive".
Solo lectura.
status objeto Estado de la creatividad que describe si la creatividad está lista para servir. Para obtener más información, consulte Estado a continuación.
click_track_result enumeración Resultado de la prueba de seguimiento de clics, una característica que solo está disponible en la interfaz de usuario de la consola.
Valores posibles: "not_tested", "passed"o "failed".
Obligatorio On:POST/PUT, en la cadena de consulta, si la creatividad está asociada a un publicador.
campaigns matriz de objetos Lista de campañas a las que está asociado el creativo. Para obtener más información, consulta Campañas a continuación.

Propina: Este campo solo se devolverá si se especifica en advertiser_id la cadena de consulta.
template objeto La plantilla creativa (ejemplo: template_id 6439) para el formato y el tipo de medio de la creatividad. La plantilla incluye código para controlar cómo se representa la creatividad en las páginas web.
Posibles valores:
- Creativos de vídeo: 6439
- Creatividades de audio: 38745
Obligatorio activado:POST
media_url string (1000) La dirección URL de la creatividad : puede ser flash, HTML, javascript (ver formato). La dirección URL debe existir y debe apuntar a un archivo XML VAST hospedado en la red CDN.
Este campo solo se aplica a creatividades de terceros.
Predeterminado:"not_tested"
media_url_secure string (1000) La dirección URL de la creatividad segura (HTTPS): puede ser flash, HTML, javascript (ver formato) para que se sirva en una llamada de anuncio segura. La dirección URL debe existir y debe apuntar a un archivo XML VAST hospedado en la red CDN.
Este campo solo se aplica a creatividades de terceros.
click_url string (2000) Dirección URL de la página de aterrizaje (opcional) para imágenes de terceros y creatividades flash.

Nota: Este valor debe comenzar por "http://" o "https://"
Obligatorio en:POST si no se usa contenido.
file_name string (1000) Este campo no se aplica a las creatividades de vídeo hospedadas.
audit_status enumeración Estado de auditoría de la creatividad. Valores posibles: "no_audit", "pending", "rejected"o "audited".

Nota:
- Si allow_audit es false, este campo debe ser "no_audit".
- Si una creatividad ha expirado, puede volver a crearla cambiando este campo. Si se establece en "pending" , se volverá a enviar para la auditoría. Para ver los cambios que reenvía automáticamente la creatividad para la auditoría, consulte Los cambios que provocan la nueva auditoría a continuación.
Obligatorio en:POST, si la plantilla es para el "image" formato .
audit_feedback string El equipo de auditoría creativa puede pasar mensajes sobre una creatividad en este campo.
Solo lectura.
allow_audit Booleano Si truees , la creatividad se enviará para la auditoría. Si falsees , no se enviará la creatividad. Las creatividades no auditadas solo se pueden ejecutar en el inventario administrado de una red.

Nota:
- Si audit_status es "no_audit", este campo debe ser "false".
- Si su miembro aún no está activo, puede agregar creatividades, pero no se enviarán para la auditoría (allow_audit será false). Una vez que se ha activado el miembro, si desea auditar estas creatividades, debe actualizar las creatividades y establecer en allow_audittrue.
Predeterminado:"pending"
ssl_status enumeración Estado ssl (HTTPS) de la creatividad. Solo los creativos con ssl_status = aprobado serán aptos para servir en un inventario seguro.

Nota:
Si una creatividad produce un error en la auditoría de Ssl Sherlock, puede enviarla para una nueva prueba (una vez que haya corregido el contenido no seguro de bajada) cambiando este campo a "pending". Valores permitidos:
- "disabled"
- "pending"
- "approved"
- "failed"
Predeterminado:"disabled"
allow_ssl_audit Booleano Si truees , la creatividad se enviará para la auditoría segura (HTTPS). Si falsees , no se enviará la creatividad. Si truees , media_url_secure o content_secure también es necesario.
Predeterminado:"disabled"
google_audit_status enumeración Obsoleto. Vea adx_audit en su lugar.
google_audit_feedback string Obsoleto. Vea adx_audit en su lugar.
msft_audit_status enumeración Obsolescente.
msft_audit_feedback string Obsolescente.
is_self_audited Booleano Si truees , la creatividad se audita por sí misma y, por tanto, no pasará por la auditoría de la plataforma (Xandr). La creatividad solo puede servir en el inventario que acepta su creatividad auto-clasificada o en el inventario que acepta creatividades no auditadas.
Predeterminado:false
is_expired Booleano Si la creatividad (1) no se ha ejecutado y (2) no se ha modificado en 45 días, se marcará automáticamente como expirada y no servirá en ningún inventario.
- Las creatividades expiradas se deben volver a auditar para ejecutarse en el inventario de terceros. Para anular la expresión de una creatividad para el inventario de terceros, establezca en audit_status"pending".
- No es necesario volver a auditar las creatividades expiradas para ejecutarse en el inventario directo. Para anular la expresión de una creatividad para el inventario directo, establezca en audit_status"no_audit".
Predeterminado:false
Solo lectura.
is_prohibited Booleano Si Sherlock marca la creatividad para tener malware o cargar dominios bloqueados, se establece en true para evitar que el creativo sirva.
Predeterminado:false
Solo lectura.
is_hosted Booleano Si truees , Xandr hospeda la creatividad.
Solo lectura.
lifetime_budget double El presupuesto de duración en dólares.

Nota:
Para incluir este campo en una GET respuesta, pase attributes=1 la cadena de consulta.
Predeterminado:false
lifetime_budget_imps Entero Límite de duración del número de impresiones.
Nota:
Para incluir este campo en una GET respuesta, pase attributes=1 la cadena de consulta.
Predeterminado:unlimited
daily_budget double El presupuesto diario en dólares.

Nota:
Para incluir este campo en una GET respuesta, pase attributes=1 la cadena de consulta.
Predeterminado:unlimited
daily_budget_imps Entero Límite diario para el número de impresiones.

Nota:
Para incluir este campo en una GET respuesta, pase attributes=1 la cadena de consulta.
Predeterminado:unlimited
enable_pacing Booleano Si truees , el gasto presupuestado diario se distribuye uniformemente a lo largo de un día.

Nota: Para incluir este campo en una GET respuesta, pase attributes=1 la cadena de consulta.
Predeterminado:unlimited
allow_safety_pacing Booleano Si truees , el gasto por minuto está limitado a un máximo del 1 % del presupuesto de duración y del 5 % del presupuesto diario.
Solo administrador.
profile_id Entero Puede asociar la segmentación como el sexo y la geografía a un creativo creando un perfil y asociándolo aquí.
folder objeto Para organizar las creatividades en carpetas para mayor comodidad (normalmente en la interfaz de usuario), creará una carpeta mediante el Servicio de carpetas creativas y, a continuación, la asociará aquí a través del identificador de carpeta o en el servicio carpeta creativa a través del identificador creativo. La salida es {"id": "41", "name": "MyFolder"}.
line_items matriz de objetos Los elementos de línea asociados a la creatividad. Para obtener más información, vea Elementos de línea a continuación.
is_control Booleano Se trata de una marca que se usa para marcar esta creatividad como parte de un grupo de control o prueba en las pruebas A/B. Para obtener más información, vea Test and Control Targeting(Destino de prueba y control).
Predeterminado:true
segments matriz Una lista de segmentos a los que se agregará un usuario al ver o hacer clic en esta creatividad. Para obtener más información, vea Segmentos y el ejemplo siguiente.
created_on Timestamp Fecha y hora en que se creó esta creatividad. Si se creó antes de enero de 2010, será cero.
Solo lectura.
last_modified Timestamp Fecha y hora en que se modificó por última vez la creatividad.
Solo lectura.
creative_upload_status enumeración Obsolescente.
categories matriz de objetos Categorías que describen el tipo creativo y de oferta.

Nota:
Para incluir categorías en una GET respuesta, pase attributes=1 la cadena de consulta. Para recuperar una lista completa de categorías, consulte el Servicio de categorías y el ejemplo siguiente.
adservers matriz de objetos Los servidores de anuncios que entregan la creatividad o se llaman para la recopilación de datos durante la entrega de la creatividad.

Nota:
Para incluir adservers en una GET respuesta, pase attributes=1 la cadena de consulta. Para recuperar una lista completa de servidores de anuncios, consulte el Servicio de servidor de anuncios y el ejemplo siguiente.
Solo lectura.
technical_attributes matriz de objetos Atributos que describen las características técnicas de la creatividad, como "Expandable" o "Video".

Nota:
Para incluir atributos técnicos en una GET respuesta, pase attributes=1 la cadena de consulta. Para recuperar una lista completa de atributos técnicos, consulte el Servicio de atributos técnicos y el ejemplo siguiente.
language objeto El lenguaje de la creatividad. Para recuperar una lista completa de idiomas, consulte language service y el ejemplo siguiente.
brand objeto La marca de la empresa publicitando el creativo y la categoría asociada a la marca. Para obtener más información, consulte Marca a continuación.
Solo lectura.
sla Entero Las creatividades establecidas en 0 se enviarán para su auditoría con un acuerdo de nivel de servicio estándar.

Cautela: Las creatividades enviadas con cualquier número distinto de 0 producirán una auditoría de prioridad (cuando esté habilitada) y las tarifas resultantes.
Si tiene un contrato de servicios complementarios con Xandr para auditorías de prioridad, puede enviar una creatividad para la auditoría de prioridad (auditoría en un plazo de 2 horas durante el horario laboral) estableciendo este campo en 2. Para obtener más información sobre la auditoría de prioridad, consulte Creative Standards and Auditing (Estándares creativos y auditoría).
sla_eta Timestamp Tiempo estimado de finalización de una auditoría de prioridad.
Solo lectura.
currency string Código que define la moneda principal del anunciante (por ejemplo, USD). Para obtener más información sobre los tipos de moneda disponibles, consulte Servicio de divisas.
Predeterminado: Moneda predeterminada del miembro.
Solo lectura.
first_run Timestamp La fecha y hora en que la creatividad se sirvió por primera vez, actualizada cada hora. Este valor refleja la zona horaria UTC. Para incluir esta información en una GET respuesta, pase flight_info=true la cadena de consulta. Para obtener más información sobre cómo filtrar las creatividades en función de cuándo se han servido por primera vez, consulte Primera ejecución o última ejecución a continuación.
Solo lectura.
last_run Timestamp Fecha y hora en que la creatividad se sirvió por última vez, actualizada cada hora. Este valor refleja la zona horaria UTC. Para incluir esta información en una GET respuesta, pase flight_info=true la cadena de consulta. Para obtener más información sobre cómo crear creatividades en función de cuándo se sirvieron por última vez, consulte Primera ejecución o última ejecución a continuación.
Solo lectura.
video_attribute objeto Atributos de contenido en streaming (VAST) de terceros y contenidos de vídeo y audio hospedados. Para obtener más información, vea Atributo de vídeo a continuación.
Predeterminado: Moneda predeterminada del miembro.
Obligatorio en:POST, si la plantilla es para el subtipo multimedia "Standard VAST".
competitive_brands matriz de objetos Los creativos asociados a las marcas de esta matriz no servirán juntos en /mtj subastas. El ejemplo clásico de marcas competidoras es Coca-Cola frente a Pepsi. Consulte Marcas competitivas a continuación. Para obtener más información sobre las marcas de nuestro sistema, consulte el Servicio de marca.
Valor predeterminado:N/A
competitive_categories matriz de objetos Los creativos asociados a las categorías de esta matriz no servirán juntos en /mtj subastas, por ejemplo, "Citas" y "Educación". Vea Categorías competitivas a continuación. Para obtener más información sobre las categorías que aplicamos a los creativos (y las marcas), consulte el Servicio de categorías.
Valor predeterminado:N/A
adx_audit objeto Este objeto contiene información sobre el estado y los comentarios relacionados con la auditoría de Google AdExchange de la creatividad. La información sobre si se ha aprobado o no una creatividad se devuelve en el audit_status campo.
Solo lectura.
member_id Entero Identificador del miembro propietario de la creatividad.
media_assets matriz de objetos Se usa para asociar archivos hospedados de Xandr a la creatividad. Este campo se rellenará automáticamente al cargar archivos a través de la API.
Vea el ejemplo.

Nota:
creative_field siempre debe ser null para una creatividad VAST.
ad_type string Propina:
Este campo solo se aplica cuando se asocian creatividades a elementos de línea aumentadas.
Tipo de creatividad que se usa. Posibles valores:
- "banner"
- "video" (incluye creatividades de audio)
- "native"

Este valor determina cómo se realiza el seguimiento de los elementos de la subasta para la estrategia de compra del artículo de línea, la estrategia de pago, las opciones de optimización, la asociación creativa y las opciones de selección de destino.

Nota:
Todas las creatividades asociadas a un elemento de línea deben tener el mismo tipo de anuncio, que debe coincidir con el ad_type seleccionado en line item service - ALI.

segments ejemplo

"segments":[
{"id":11111,
"action":"add_on_view"
},
{"id":22222,
"action":"add_on_click"
}
]

categories ejemplo

"categories":[{"id":"13","name":"Online Games"}]

adservers ejemplo

"adservers":[{"id":"1","use_type":"adserver","name":"24/7 Real Media"}]

technical_attributes ejemplo

"technical_attributes":[{"id":"1","name":"Image"}]

language ejemplo

"language":{"id":"1","name":"English"}

media_assets ejemplo

"media_assets":[
{
"media_asset_id":22,
"creative_field":null
}
]

Audio

Campo Tipo Descripción
click_target string Destino del click_action, que es la acción que debe realizar el dispositivo cuando se hace clic en la creatividad. Escriba una dirección URL que nuestro equipo de auditoría pueda usar para comprobar la marca y los atributos de su creatividad de audio. Asegúrese de que el sitio al que apunta la dirección URL está en el mismo idioma que el audio. Esta dirección URL solo se usa con fines de auditoría.

Cautela:
Debe proporcionar una dirección URL auditable para que la creatividad pase la auditoría.

Elementos de línea

Cada objeto de la line_items matriz incluye los campos siguientes. Para obtener información sobre "id" campos o "code" , puede usar el Servicio de artículos de línea - ALI.

Campo Tipo (longitud) Descripción
name string Nombre del elemento de línea.
Solo lectura.
state enumeración El estado de la creatividad. Valores posibles: "active" o "inactive".
Solo lectura.
id Entero Identificador del elemento de línea. "code" O "id" es necesario al actualizar la asociación de elementos de línea.
Obligatorio activado:PUT
code string Código personalizado para el elemento de línea. "code" O "id" es necesario al actualizar la asociación de elementos de línea.
Obligatorio activado:PUT

Campañas

Cada objeto de la campaigns matriz incluye los campos siguientes. Para obtener información sobre "id" campos o "code" , puede usar el Servicio de campaña.

Campo Tipo (longitud) Descripción
id Entero Identificador de la campaña. "code" O "id" es necesario al actualizar la asociación de campaña.
Obligatorio activado:PUT
campaign_id Entero Identificador de la campaña.
creative_id Entero Identificador de la creatividad.
name string Nombre de la campaña.
Solo lectura.
state enumeración Estado de la campaña. Valores posibles: "active", "inactive"o "parent_inactive".
Solo lectura.
code string Código personalizado para la campaña. "code" O "id" es necesario al actualizar la asociación de elementos de línea.
Obligatorio activado:PUT

Estado

Nombre Tipo Descripción
user_ready booleano Estado del conjunto creativo por parte del usuario que describe si la creatividad está lista para servir o no. Valores posibles: "true" o "false".
Predeterminado:true
hosted_assets_association_complete boolean/null Estado de la creatividad cargada por los sistemas internos de Xandr. Valores posibles: "true" o "false" para las creatividades hospedadas y "null" para las creatividades de terceros.
Solo lectura.

Marcas competitivas

Sugerencia

Para obtener más información sobre las marcas, consulte el Servicio de marca.

Nombre Tipo Descripción
id Entero Identificador de la marca.
Predeterminado: N/A
Obligatorio activado: N/A
name string Nombre de la marca.
Predeterminado: N/A
Obligatorio activado: N/A

Recurso multimedia

media-asset object incluye los campos siguientes:

Nombre Tipo Descripción
id Entero Identificador del recurso multimedia.
Obligatorio activado:POST
parent_media_asset_id Entero Identificador del recurso multimedia primario.
size_in_bytes Entero Tamaño en bytes.
cdn_uploaded_on Entero Fecha en la que se cargó en la red CDN.
cdn_url string Dirección URL de red CDN no segura al recurso multimedia.
cdn_secure_url string Proteja la dirección URL de la red CDN en el recurso multimedia.
deleted booleano Indicador booleano que determina si el recurso multimedia se eliminó o no.
mime_type enumeración Tipo de recurso.
asset_type enumeración Uno de los siguientes tipos de recursos:
- html5
-vídeo
-audio
-imagen
duration double Duración del recurso de vídeo en milisegundos.

Media_asset_status

media_asset_status object incluye los campos siguientes:

Nombre Tipo Descripción
cdn_upload_attempt_count Entero Número de intentos realizados durante la carga en la red CDN.
status enumeración Indica que la fase de procesamiento del recurso está en.

Plantilla

template object incluye los campos siguientes:

Nombre Tipo Descripción
id Entero Identificador de la plantilla creativa.
name string Nombre de la plantilla creativa.
Solo lectura.
media_subtype_id Entero Identificador del subtipo de medios asignado a la plantilla. Puede usar el servicio de subtipos multimedia para ver todos los subtipos multimedia admitidos.
Solo lectura.
format_id string Nombre del formato asignado a la plantilla. Puede usar el servicio de formato creativo para ver todos los formatos admitidos.
Solo lectura.

Categorías competitivas

Sugerencia

Para obtener más información sobre las categorías, vea el servicio category.

Nombre Tipo Descripción
id Entero Identificador de la categoría.
Predeterminado: N/A
Obligatorio activado: N/A
name string Nombre de la categoría.
Predeterminado: N/A
Obligatorio activado: N/A

Atributo Video

video_attribute es necesario para las creatividades de audio y vídeo en el punto de creative-vast conexión. Los identificadores de plantilla son:

  • 6439 - Vídeo: VAST estándar
  • 38745 - Audio: ESTÁNDAR VAST

El video_attribute objeto incluye los campos siguientes:

Campo Tipo Descripción
is_skippable booleano Obsoleto. Xandr agrega automáticamente un seguimiento de saltos a todas las creatividades VAST traficadas.
duration_ms double Duración, en milisegundos, de la creatividad de audio o vídeo en streaming (VAST). Debe ser mayor que 0.
Obligatorio en:POST, PUT.
wrapper objeto Contenedor de documentos VAST que contiene la elements matriz y la trackers matriz. Para obtener más información, vea Contenedor de atributos de vídeo a continuación.
Obligatorio activado: El contenedor o el objeto insertado son necesarios en POST, PUT.
inline objeto Documento VAST insertado. Para obtener más información, vea Atributo de vídeo insertado a continuación.
Obligatorio activado: El contenedor o el objeto insertado son necesarios en POST, PUT.

Nota:

wrapper El objeto o inlinese puede especificar en la llamada creativa. Son mutuamente excluyentes.

Contenedor de atributos de vídeo

El wrapper objeto contiene los campos siguientes:

Campo Tipo Descripción
url string Dirección URL del documento VAST.
Obligatorio en:POST, PUT.
secure_url string Dirección URL segura del documento VAST.
elements matriz Elementos del contenedor VAST.
Obligatorio en:POST, PUT.

Elemento contenedor de atributos de vídeo

La elements matriz contiene los campos siguientes:

Nota:

Se debe especificar al menos un elemento.

Campo Tipo Descripción
vast_element_type_id Entero Id. de elemento VAST. Valor posible:
1:lineal
type string Tipo de elemento. Valor posible: "linear"
Solo lectura.
trackers matriz Seguimientos de eventos VAST.
media_files matriz Archivos multimedia en el contenedor VAST.

Seguimiento de eventos del contenedor de vídeo

Puede colocar píxeles en todos los eventos de los que se realiza el seguimiento en los informes (consulte vast_event_type_id a continuación). Agregue los píxeles como trackers en la creatividad. La trackers matriz contiene los campos siguientes:

Campo Tipo Descripción
name string Nombre del seguimiento de eventos.
vast_event_type_id Entero Identificador del evento VAST. Posibles valores:
- 2:empezar
- 3:saltarse
- 4:error
- 5: first_quartile
- 6:centro
- 7: third_quartile
- 8:terminación
- 9:impresión
- 10:clic
url string Dirección URL del seguimiento de eventos.
secure_url string Dirección URL segura del seguimiento de eventos.
event_type string Tipo de evento correspondiente a vast_event_type_id.
Solo lectura.

Archivos multimedia contenedor de vídeo

Campo Tipo Descripción
maintain_aspect_ratio string Relación entre los tamaños de un archivo multimedia en dimensiones diferentes.
Solo lectura.
scalable string Es escalable el archivo multimedia.
Solo lectura.
media_asset string Los valores se derivan de la aplicación de carga de vídeo o audio.
Solo lectura.

Atributo de vídeo insertado

Campo Tipo Descripción
ad_title string El título del anuncio.
Obligatorio en:POST, PUT.
ad_description string Opcional. Descripción del anuncio.
linear objeto Anuncio que aparece antes, después o durante una interrupción del contenido.
companion_ads matriz de objetos Anuncios de banner complementarios que aparecen en ubicaciones de banner en la misma página que el vídeo o audio que lo acompaña (consulta Objeto de anuncios complementarios en línea a continuación).

Objeto lineal insertado

Campo Tipo Descripción
trackers matriz Rastreadores lineales insertados.
media_files matriz Archivos multimedia lineales insertados.
skipoffset_seconds Entero El número de segundos que se permiten para que se reproduzca el vídeo, antes de que se pueda omitir. El valor predeterminado es null.

Nota:
Este campo solo se puede usar si el mismo miembro va a publicar anuncios en una ubicación.

Rastreadores lineales insertados

Campo Tipo Descripción
vast_event_type string Tipo de evento de seguimiento. Valores posibles:
- start
- skip
- error
- first_quartile
- completion
- impression
- click
Obligatorio en:POST, PUT.
name string Nombre del rastreador.
url string Dirección URL del seguimiento de eventos lineales insertados.
Obligatorio en:POST, PUT.
secure_url string Dirección URL segura del seguimiento de eventos lineales insertados.

Archivos multimedia lineales insertados

Campo Tipo Descripción
maintain_aspect_ratio string Relación entre los tamaños de un archivo multimedia en dimensiones diferentes.
Solo lectura.
scalable string Es escalable el archivo multimedia.
Solo lectura.
media_assets string Los valores se derivan de la aplicación de carga de vídeo.
Solo lectura.

Objeto Anuncios complementarios insertados

Campo Tipo Descripción
trackers matriz de objetos Rastreadores de anuncios complementarios insertados.
companion_creative_id Entero Identificador del anuncio complementario.

Segmentos

Estos campos se incluirán en la matriz Segmentos:

Campo Tipo Descripción
id Entero Identificador del segmento.
Obligatorio en:POST, PUT.
segment_id Entero Identificador del segmento. Este campo contiene la misma información que el id campo.
action enumeración Acción realizada por los usuarios que los agregarán al segmento. Valores posibles: "add on view" o "add on click".
Obligatorio en:POST, PUT.
name string Nombre del segmento.

Marca

El brand objeto contiene los campos siguientes.

Sugerencia

Este objeto es de solo lectura. Para establecer la marca de una creatividad, use el brand_id campo fuera de este objeto.

Campo Tipo Descripción
id Entero El id. de la marca de la empresa que anuncia la creatividad.
Solo lectura.
name string Nombre de la marca de la empresa que anuncia la creatividad.
Solo lectura.
category_id Entero Identificador de la categoría asociada a la marca.
Solo lectura.
category_name string Nombre de la categoría asociada a la marca.

Nota:
El category_name campo solo se devuelve cuando se pasa show_category_name=true la cadena de consulta de la llamada.

Primera ejecución/última ejecución

Para incluir los first_run campos y last_run en una GET respuesta, pase flight_info=true la cadena de consulta. También puede filtrar las creatividades en función de cuándo se atienden por primera y última vez, como se indica a continuación:

Recuperar solo las creatividades que nunca han servido

Pase never_run=true la cadena de consulta.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&never_run=true'

Sugerencia

Puede usar never_run=true en combinación con otros filtros, pero tenga en cuenta que siempre será una relación OR. Por ejemplo, si pasa tanto never_run=true como min_first_run=2012-01-01 00:00:00 en la cadena de consulta, buscará creativos que nunca hayan servido elementos de línea OR que se hayan servido por primera vez en o después del 2012-01-01.

Recuperar solo las creatividades que se sirvieron por primera vez en o después de una fecha específica

Pase min_first_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00'

Recuperar solo las creatividades que se sirvieron por primera vez en o antes de una fecha específica

Pase max_first_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&max_first_run=2012-08-01 00:00:00'

Recuperar solo las creatividades que se atienden por primera vez dentro de un intervalo de fechas específico

Pase min_first_run=YYYY-MM-DD HH:MM:SS&max_first_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00&max_first_run=2012-08-01 00:00:00'

Recuperar solo las creatividades que se sirvieron por última vez en o después de una fecha específica

Pase min_last_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00'

Recuperar solo las creatividades que se sirvieron por última vez en o antes de una fecha específica

Pase max_last_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&max_last_run=2012-08-01 00:00:00'

Recuperar solo las creatividades que se sirvieron por última vez dentro de un intervalo de fechas específico

Pase min_last_run=YYYY-MM-DD HH:MM:SS&max_last_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00&max_last_run=2012-08-01 00:00:00'

Cambios que provocan una nueva auditoría

Una vez que una creatividad ha pasado la auditoría Xandr (audit_status es "audited"), el cambio de cualquiera de los campos siguientes hace que la creatividad se vuelva a enviar para la auditoría (allow_audit está establecida en "pending").

  • media_url
  • click_url
  • language
  • categories
  • technical_attributes
  • brand_id
  • pixel_url
  • video_attribute
  • media_assets

Además, si audit_status es "no_audit", cambiar allow_audit de "false" a "true" hace que la creatividad se vuelva a enviar para la auditoría de Xandr.

Ejemplos

Carga de un contenido de vídeo o audio

Al cargar una creatividad para hospedar con Xandr:

Paso 1: Cargar el recurso en el servicio de carga creativa.

curl -X POST -H "Authorization: hbapi:139072:5761726637ada:nym2" --form "type=video" --form "file=@./Xandr_30_1280_720_2500k.mp4" "https://api.appnexus.com/creative-upload?member_id=123"

Se devuelve el media_asset_id .

{
    "response": 
        "status": "OK",
        "count": 0,
        "start_element": 0,
        "num_elements": 0,
        "media-asset": [
            {
                "id": 54621,
                "parent_media_asset_id": null,
                "member_id": 123,
                "advertiser_id": null,
                "publisher_id": null,
                "file_name": "Xandr_30_1280_720_2500k.mp4",
                "size_in_bytes": 8358845,
                "cdn_uploaded_on": null,
                "cdn_url": null,
                "cdn_secure_url": null,
                "created_on": "2016-06-15 15:33:17",
                "last_modified": "2016-06-15 15:33:17",
                "deleted": false,
                "media_asset_status": [
                    {
                        "id": 54621,
                        "media_asset_id": 54621,
                        "error_message": null,
                        "local_path": "03/36/2e/66/03362e66-674a-41b3-9477-fcd979cdbf0b/03362e66-674a-41b3-9477-fcd979cdbf0b.mp4",
                        "cdn_upload_attempt_count": 0,
                        "created_on": "2016-06-15 15:33:17",
                        "last_modified": "2016-06-15 15:33:17",
                        "deleted": false,
                        "status": "on_shared_storage"
                    }
                ],
                "media_asset_video": null,
                "media_asset_html5": null,
                "asset_type": "video",
                "mime_type": "video/mp4",
                "duration": "32000"
            }
        ]
    }

Paso 2:Use paramedia_asset_idcargar la creatividad.

$ cat creative_video

{
    "creative-vast": {
        "name": "upload hosted video",
        "media_assets": [
            {
               "media_asset_id": 54621
            }
        ],
        "click_url": "https://appnexus.com",
        "video_attribute": {
            "inline": {
                "ad_title": "hosting test",
                "linear": {
                    "trackers": []
                }
            },
            "is_skippable": true,
            "duration_ms": "57000"
        },
        "template": {
            "id": 6439
        },
        "advertiser_id": 164979,
        "segments": null,
        "allow_audit": true,
        "is_self_audited": false,
        "sla": 0
    }
}

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 12345678,
        "start_element": 0,
        "num_elements": 100,
        "creative-vast": {
            "name": "hosted creative video",
            "brand_id": 1,
            "media_url": "http://appnexus.com",
            "id": 12345678,
            ...
            "track_clicks": true,
            "audit_status": "pending",
            ...
            "media_url_secure": "https://appnexus.com",
            ...
            "is_hosted": true,
            ...
            "language": {
                "id": 1,
                "name": "English"
            },
            ...
            },
            "template": {
                "id": 6439,
                "name": "Standard",
                "media_subtype_id": 64,
                "format_id": 10
            },
            ...
            "video_attribute": {
               "is_skippable": true,
                "duration_ms": 57000,
                "inline": {
                    "ad_title": "hosted video creative",
                    "ad_description": null,
                    "linear": {
                        "trackers": null,
                        "media_files": null
                    }
                },
                "video_frameworks": null
            },
            "media_assets": [
                {
                    "media_asset_id": 54621
                }
            ],
            ...
            "currency": "USD",
            "type": "video"
        },
        ...
    }
}

Un video_attribute objeto con ejemplo de contenedor

{
    "creative-vast": {
        "id": 145,
        ...
        "template_id": 6439,
        "video_attribute": {
            "is_skippable": true,
            "duration_ms": 21000,
            "wrapper": {
                "url": "http://www.doubleclick.net/...",
                "secure_url": "https://www.doubleclick.net/...",
                "elements": [
                    {
                        "vast_element_type_id": 1,
                        "name": "linear",
                        "trackers": [
                            {
                                "name": "startTracker",
                                "vast_event_type": "impression",
                                "url": "http://tracker.com/...",
                                "secure_url": "https://tracker.com/...",
                            }
                            {
                                "name": "completionTracker",
                                "vast_event_type_id": 8,
                                "url": "http://tracker.com/...",
                                "secure_url": "https://tracker.com/...",
                                "event_type": "completion"
                            }
                        ]
                    }
                ]
            }
        }
    }
    }

Un video_attribute objeto con un ejemplo de VAST insertado

{
    "creative-vast": {
        "name": "John-Doe test",
        "member_id": 1111,
        "advertiser_id": 2474202,
        "template": {
            "id": 6439
        },
        "video_attribute": {
            "duration_ms": 10000,
            "inline": {
                "ad_title": "John-Doe test",
                "linear": {
                    "trackers": []
                }
            }
        },
        "media_assets": [
            {
                "media_asset_id": 5375731,
                "creative_field": null
            }
        ]
    }
    }