API de plataforma digital: servicio Search creativa
Este servicio de solo lectura permite buscar creatividades activas según criterios específicos, como el estado de auditoría, el identificador, el tamaño, etc. A continuación, puede usar estos identificadores creativos en el servicio de perfil de anuncios. Para agregar creatividades al sistema, consulte El servicio creativo.
Nota:
Dado que este servicio busca todas las creatividades activas en la plataforma AppNexus (no solo la suya), una búsqueda demasiado amplia podría producir un error. Para asegurarse de que obtiene resultados, limite la búsqueda tanto como sea posible.
Esta API también permite la búsqueda de determinados campos nativos mediante la búsqueda creativa.
Los campos que se pueden buscar son los siguientes:
- title (1)
- descripción (2)
- call_to_action (3)
- additional_description (13)
La búsqueda devolverá una creatividad si el término de búsqueda coincide con cualquier texto de cualquiera de los campos mencionados anteriormente.
API de REST
| Http (método) | Endpoint | Description |
|---|---|---|
POST |
https://api.appnexus.com/creative-search (creative_search JSON) |
Busque creatividades. |
POST |
https://api.appnexus.com/creative-search?sort=FIELD_NAME.ASC_OR_DESC (creative_search JSON) |
Busque creatividades y ordene los resultados. |
Nota:
Los campos usados para buscar creatividades no son exactamente los mismos que los campos devueltos. Esto se debe a que los objetos devueltos se extraen del Servicio creativo y tienen el formato correspondiente.
Campos JSON
| Campo | Tipo | Description |
|---|---|---|
creative_ids |
matriz de enteros | Busque creativos por sus identificadores. Ordenable: Sí, use "id" en la cadena de consulta. |
description |
string | Busque creatividades por términos en sus descripciones. Ordenable: No |
audit_status |
Matriz de enumeración | Busque creatividades por su estado de auditoría. Valores posibles: "no_audit", "pending", "rejected", "audited".Ordenable: Sí |
ad_profile_id |
Entero | Debe utilizarse con brand_status. Busque una creatividad por el identificador de su perfil de anuncio.Ordenable: No |
brand_status |
Matriz de enumeración | Debe utilizarse con ad_profile_id. Busque creativos por su estado de marca. Por ejemplo, si se establece "trusted"en , todas las marcas de confianza dentro de los perfiles de anuncio especificados en ad_profile_id se devolverán en la respuesta. Valores posibles: "trusted", "case-by-case", "banned". El campo de estado de marca solo se devuelve en la respuesta cuando se usa este filtro.Ordenable: No |
review_status |
Matriz de enumeración | Busque creatividades en función de su estado de revisión (de los perfiles de anuncios asociados). Valores posibles: "reviewed", "unreviewed". El campo de estado de revisión solo se devuelve en la respuesta cuando se usa este filtro.Ordenable: No |
uploaded_since |
Timestamp | Busque las creatividades que se cargaron desde esta fecha. Formato: "AAAA-MM-DD HH:MM:SS". Ordenable: No |
modified_since |
Timestamp | Busque las creatividades que se modificaron desde esta fecha. Formato: "AAAA-MM-DD HH:MM:SS". Ordenable: No |
formats |
Matriz de enumeración | Busque creatividades por sus formatos. Valores posibles: "url-html", "url-js", , "flash", "raw-js""image", "raw-html", , "iframe-html", , "url-vast""text".Ordenable: Sí, use "format" en la cadena de consulta. |
media_subtype |
Matriz de enumeración | En desuso, use media_subtype_ids en su lugar. Busque creatividades por sus subtipos multimedia. Valores posibles: "Banner", "Popup", "Popunder".Ordenable: No |
media_subtype_ids |
matriz de enteros | Busque creatividades por su subtipo multimedia a través del identificador. Puede usar el servicio subtipo multimedia para buscar los identificadores deseados. Ordenable: Sí, use "media_subtype_id" en la cadena de consulta. |
media_url |
string | Busque una creatividad por su dirección URL. Ordenable: Sí |
media_content |
string | Busque una creatividad por los datos en su campo de original_content (consulte Creative Service). Ordenable: No |
sizes |
matriz de cadenas | Busque creatividades por sus tamaños, por ejemplo, "728x90". Ordenable: Sí, use "width" y "height" en la cadena de consulta. |
brand_ids |
matriz de enteros | Busque creativos por los identificadores de sus marcas. Ordenable: No |
member_ids |
matriz de enteros | Debe utilizarse con member_action. Busque creativos por los identificadores de sus miembros.Ordenable: Sí, use "member_id" en la cadena de consulta. |
member_action |
enumeración | Debe utilizarse con member_ids. Si se establece en "exclude", se excluyen los miembros especificados en de member_ids la búsqueda. De lo contrario, se incluyen los identificadores especificados.Ordenable: No |
template_id |
Entero | Busque creativos por sus identificadores de plantilla creativa. Ordenable: Sí |
size_in_bytes |
string | No es un filtro. Ordenar da como resultado un orden de tamaño ascendente o descendente. Ordenable: Sí |
click_url |
string | No es un filtro. Ordenar da como resultado un orden ascendente o descendente de la dirección URL de clic alfabética. Ordenable: Sí |
landing_page_url |
string | No es un filtro. Ordenar da como resultado un orden ascendente o descendente de la dirección URL de la página de aterrizaje alfabética. Ordenable: Sí |
Ejemplos
Búsqueda de todas las creatividades de banner que han superado la auditoría de AppNexus
$ cat creative_search
{
"creative-search": {
"audit_status": [
"audited"
],
"media_subtype": [
"banner"
]
}
}
$ curl -b cookies -c cookies -X POST -d @creative_search 'https://api.appnexus.com/creative-search'
{
"response": {
"status": "OK",
"creatives": [
{
"id": "48652",
"width": "300",
"height": "250",
"media_url": "https:\/\/cdn.adnxs.com\/p\/05\/d1\/cd\/fe\/05d1cxxxxxx221db2ba8b.png",
"content": null,
"format": "image",
"member_id": "408",
"brand_id": "1",
"click_url": "https:\/\/www.sample.com",
"audit_status": "audited",
"size_in_bytes": "14545",
"landing_page_url": null,
"last_activity": "2010-07-23 16:40:41",
"created_on": "2010-04-30 07:20:23",
"media_subtypes": [
"banner"
],
"pop_values": null
},
{
"id": "73163",
"width": "300",
"height": "250",
"media_url": null,
"content": "<iframe src=\"https:\/\/xxxx.net\/udm\/img.fetch?sid=2773;tid=2;ev=1;dt=1;\" width=300
height=250 Marginwidth=0 Marginheight=0 Hspace=0 Vspace=0 Frameborder=0 Scrolling=No><\/iframe>
<noscript><a href=\"https:\/\/fletcher.net\/udm\/clk.cpx?sid=2773;ev=2;tid=2;dt=3\"><img src=\
"https:\/\/sample.net\/udm\/img.fetch?sid=2773;ev=1;tid=2;dt=3\" width=300 height=250 border=0>
<\/a><\/noscript>",
"format": "iframe-html",
"member_id": "333",
"brand_id": "17",
"click_url": "",
"audit_status": "audited",
"size_in_bytes": "0",
"landing_page_url": "https:\/\/www.appleblueberry.com",
"last_activity": "2010-09-07 23:33:45",
"created_on": "2010-08-25 16:31:43",
"media_subtypes": [
"banner"
],
"pop_values": null
},
...
]
}
}
Buscar todas las creatividades flash que se han cargado desde 2012-01-01 00:00:00
$ cat creative_search
{
"creative-search": {
"formats": [
"flash"
],
"uploaded_since": "2012-01-01 00:00:00"
}
}
$ curl -b cookies -c cookies -X POST -d @creative_search 'https://api.appnexus.com/creative-search'
{
"response": {
"status": "OK",
"creatives": [
{
"id": "1207858",
"width": "160",
"height": "600",
"media_url": "https:\/\/cdn.adnxs.com\/p\/c7\/6d\/5b\/bd\/c76d5bbdxxxxx8b9e1507c07cbe61.swf",
"content": null,
"format": "flash",
"member_id": "326",
"brand_id": "4467",
"click_url": "https:\/\/clickclick.com\/witness\/p=28xxx96\/c=6sxd3",
"audit_status": "audited",
"size_in_bytes": "40077",
"landing_page_url": "https:\/\/www.destination.com",
"last_activity": "2012-01-01 15:56:59",
"created_on": "2012-01-01 02:34:14",
"media_subtypes": [
"banner"
],
"pop_values": null
},
{
"id": "1207859",
"width": "160",
"height": "600",
"media_url": "https:\/\/cdn.adnxs.com\/p\/3b\/d6\/f6\/1d\/3bd6f61dkdh4473djfb579430ed.swf",
"content": null,
"format": "flash",
"member_id": "326",
"brand_id": "4467",
"click_url": "https:\/\/clickclick.com\/witness\/p=2ddssd6\/c=3423",
"audit_status": "audited",
"size_in_bytes": "32094",
"landing_page_url": "https:\/\/www.destination.com",
"last_activity": "2012-01-01 15:57:36",
"created_on": "2012-01-01 02:35:52",
"media_subtypes": [
"banner"
],
"pop_values": null
},
...
]
}
}
Busque todas las creatividades de imágenes de 728x90 y 300x250 que pertenecen al miembro 333.
$ cat creative_search
{
"creative-search": {
"sizes": [
"728x90",
"300x250"
],
"formats": [
"image"
],
"member_ids": [
333
]
}
}
$ curl -b cookies -c cookies -X POST -d @creative_search 'https://api.appnexus.com/creative-search'
{
"response": {
"status": "OK",
"creatives": [
{
"id": "61967",
"width": "300",
"height": "250",
"media_url": "https://cdn.adnxs.com/p/c8/fb/12/56/c8fb125634xxxx2e67a783d91cf.png",
"content": null,
"format": "image",
"member_id": "333",
"brand_id": "1",
"click_url": "https://www.clickplace.com/",
"audit_status": "no_audit",
"size_in_bytes": "29433",
"landing_page_url": null,
"last_activity": "2011-05-13 02:34:47",
"created_on": "2010-07-28 20:44:22",
"media_subtypes": [
"banner"
],
"pop_values": null
},
{
"id": "291801",
"width": "728",
"height": "90",
"media_url": "https://cdn.adnxs.com/p/54/62/87/d1/546287aasxxx8e6431960ad2b1fb.png",
"content": null,
"format": "image",
"member_id": "333",
"brand_id": "2450",
"click_url": "https://thatplace.com/careers",
"audit_status": "audited",
"size_in_bytes": "24091",
"landing_page_url": "https://thatplace.com/careers",
"last_activity": "2011-05-13 03:30:00",
"created_on": "2011-04-05 18:28:29",
"media_subtypes": [
"banner"
],
"pop_values": null
},
...
]
}
}