Servicio TinyTag
El servicio TinyTag le permite crear identificadores de TinyTag, así como modificarlos y verlos.
Los identificadores están asociados a información sobre el espacio de anuncios, como el tamaño, el precio de reserva y qué marcas o creatividades pueden ejecutarse en ese espacio. Esta información se almacena en el servidor con Xandr y es fácil de modificar.
Los identificadores de TinyTag se pueden usar en TinyTags, que se colocan directamente en las páginas del publicador y tienen el formato https://ib.``adnxs``.com/tt?id=1básico . Se puede pasar más información en un TinyTag mediante parámetros TinyTag dinámicos.
Tenga en cuenta que el miembro asociado al id. de TinyTag tiene derechos de primera denegación en el inventario y recibe crédito (o efectivo) si otro miembro lo compra.
API de REST
| Http (método) | Endpoint | Description |
|---|---|---|
| DELETE | https://api.adnxs.com/tt/MEMBER_ID/TAG_ID | Elimine un TinyTag existente. |
| GET | https://api.adnxs.com/tt/MEMBER_ID | Ver todas las TinyTags de un miembro. |
| GET | https://api.adnxs.com/tt/MEMBER_ID/TAG_ID | Ver un TinyTag determinado. |
| POST | https://api.adnxs.com/tt/MEMBER_ID (etiqueta JSON) |
Create un tinytag nuevo. |
| PUT | https://api.adnxs.com/tt/MEMBER_ID/TAG_ID (etiqueta JSON) |
Modifique un TinyTag existente. |
Campos JSON
| Campo | Obligatorio | Tipo | Descripción |
|---|---|---|---|
acb_code |
no | string(32) | No se usa con frecuencia. |
active |
No, el valor predeterminado está activo | Entero | El valor booleano determina si se puede usar el segmento |
ad_profile_id |
no | Entero | Este es el identificador del perfil de aprobación de anuncios que se usa para los estándares de calidad creativa. |
audit_level |
no | enumeración | Valores solo para la auto auditación. Nota: Las auditorías automáticas en el nivel de sitio se pueden invalidar en el nivel de selección de ubicación (tinytag). Posibles valores: - "tinytag": use este valor si el campo auditado está establecido en true en la ubicación. - "site": use este valor si el campo auditado está establecido en false en la ubicación, pero true en el sitio. |
audited |
no | booleano | Si es true, el propietario ha auditado automáticamente la ubicación. |
code |
no | string(100) | Campo definido por el usuario para llamar a la etiqueta a través de códigos. Puede encontrar más información en la página tinytag. |
code2 |
no | string(100) | Segundo código, si lo desea. |
content_retrieval_timeout_ms |
no | Entero | - Si 0es , el servidor de anuncios usa el valor del servicio miembro. : el valor predeterminado es 0 si no se proporciona a la API en PUT o POST llama a . - Si el servidor de anuncios lee un 0 en este campo, realiza una búsqueda de miembros y usa el tiempo de espera predeterminado definido por el servicio miembro (suponiendo que también sea distinto de cero). - Al crear un TinyTag, ninguno de los valores se copia en este campo de la configuración predeterminada del miembro. Debe especificarlos explícitamente en las llamadas a POST. Para obtener más información, vea el default_content_retrieval_timeout_ms campo del servicio miembro. |
default_calculation_type |
no | enumeración | Esto determina el umbral de precio de la oferta por debajo del cual se sirve una creatividad predeterminada. Puede elegir si este umbral es los ingresos brutos de la red o los ingresos netos del publicador. Si no hay campañas aptas adicionales ni creatividades predeterminadas disponibles, se proporciona una PSA. Valores posibles: "gross" o "net". |
default_creative_id |
no | Entero | Creatividad predeterminada que se va a ejecutar si no hay ofertas que cumplan el precio de reserva. |
default_creatives |
no | matriz | Las creatividades predeterminadas que se muestran en lugar de una PSA cuando no hay ningún ganador de la subasta. Para cada creatividad predeterminada, el precio de reserva se establece con el campo "price" en la matriz. Consulte Las creatividades predeterminadas a continuación para obtener más detalles. Nota: Para las ubicaciones emergentes: la colocación no aparece si no se cumple el precio de reserva, excepto en el caso de un prepop. |
default_referrer_url |
no | string | Si se establece un perfil de visibilidad para ocultar las direcciones URL de inventario en las solicitudes de puja, puede establecer este campo para pasar una dirección URL de vanidad en su lugar. Esto resulta especialmente útil en los casos en los que los editores no quieren compartir dominios reales, pero, sin embargo, quieren que los compradores puedan identificarlos por dominio. Tenga en cuenta, sin embargo, que el dominio de vanidad no puede ser dirigido directamente por las campañas de Xandr, aunque puede ser dirigido por licitadores externos. |
enable_for_mediation |
no | booleano | - Este es el origen de la verdad para si un TinyTag debe aceptar contenido mediado - A menos que se establezca en PUT o POST, este campo hereda su valor predeterminado del miembro. Si el valor predeterminado se cambia en el servicio miembro, esa acción no afecta retroactivamente a tinyTags creados anteriormente; siguen estando establecidos en el valor predeterminado anterior. En otras palabras, el valor de este campo no se puede actualizar con carácter retroactivo estableciendo el valor predeterminado del miembro. Para obtener más información, vea el default_enable_for_mediation campo del servicio miembro. |
estimated_clear_prices |
no | El importe de la puja que históricamente ha ganado la mayoría (95%) de las subastas de terceros en las que participa. Consulte Precio claro estimado a continuación para obtener más detalles. | |
exclusive |
No, el valor predeterminado es false | booleano | Solo lectura. Este campo ha quedado en desuso. Este campo anteriormente sirvió como valor predeterminado para el comportamiento exclusivo en un TinyTag. Esta configuración ahora se controla a través del rtb campo en el marketplace_map objeto del site servicio. |
floor_application_target |
no | enumeración | Tipo de pujas a las que se aplica el precio de reserva. Posibles valores: -"external_only" - El precio de la reserva se aplica solo a las pujas externas (los miembros compradores y los miembros vendedores son diferentes). Use esta opción si prefiere proporcionar una impresión de aprendizaje administrada disponible que servir un valor predeterminado, incluso si esto significa superar el porcentaje máximo de volumen diario para aprender. - "external_non_preferred": el precio de la reserva se aplica a las pujas externas (el miembro comprador y el miembro vendedor son diferentes) o cuando la impresión es una impresión de aprendizaje administrada disponible que supera el porcentaje máximo de volumen diario para aprender. Use esta opción si prefiere proporcionar un valor predeterminado que proporcionar una impresión de aprendizaje administrada disponible que superaría el porcentaje máximo de volumen diario para aprender. - "todos" - El precio de reserva se aplica a todas las ofertas excepto a las impresiones de aprendizaje administradas dentro del porcentaje máximo de volumen diario para aprender. |
height |
no | Entero | Alto de la etiqueta en píxeles. |
hide_referer |
booleano | No muestre la página de referencia. | |
id |
No, solo en modificar | Entero | Identificador Xandr asignado por la API para hacer referencia a esta etiqueta. |
intended_audiences |
no | enumeración | Valores solo para la auto auditación. Valores posibles: "general", "children", "young_adult" o "mature". |
inventory_attributes |
no | matriz | Valores solo para la auto auditación. Se trata de una matriz de objetos con identificadores. Consulte el Servicio de atributos de inventario para obtener una lista de identificadores. |
is_resizable |
no | booleano | Si la ubicación usa un iFrame descriptivo y desea que el tamaño de la ubicación se ajuste a creatividades más pequeñas o más grandes, establezca este campo en true. |
last_activity |
no | Timestamp | Marca de tiempo de la última modificación de esta etiqueta diminuta. |
media_subtypes |
no | enumeración | En desuso. En su lugar, use supported_media_types y supported_media_subtypes. |
member_id |
sí | int | Identificador de miembro propietario de esta etiqueta. Se requiere para la llamada, pero no para JSON. |
name |
no | string | Nombre asociado a TinyTag |
pixel_type |
no | enumeración | Identifica el tipo de píxel. Los valores posibles son "script" o "image". |
pixel_url |
no | string | Ubicación que el píxel notifica cuando un usuario hace clic en esa ubicación. |
pixel_url_secure |
no | booleano | Indica si la dirección URL del píxel apunta a una página web encyrpted. |
pop_values |
no | matriz | Si el supported_media_type es "Pop" o el supported_media_subtypes es "Popup" o "Popunder", esta matriz define el comportamiento del elemento emergente. Consulte Los valores emergentes a continuación para obtener más detalles. |
position |
no | enumeración | "above", "below" o "unknown": la posición de TinyTag en relación con el pliegue de página |
publisher_id |
no | Entero | Identificador del publicador asociado al sitio en el que se encuentra la etiqueta. |
reserve_price |
No, el valor predeterminado es $0 | double | El precio de reserva del anuncio en $CPM: es el precio más bajo por el que el propietario del inventario está dispuesto a vender, de lo contrario, se sirve la creatividad predeterminada. Nota : este campo aparece como "precio" en la lista /meta. |
segments |
no | Matriz de objetos | Un usuario que ve este TinyTag se coloca en todos los segmentos especificados Ejemplo: "segments": [ {"segment_id":1} ] |
site_id |
sí | int | Identificador del sitio al que está asociada la etiqueta. La jerarquía es Etiquetas de sitios>. Para obtener más información sobre el servicio de sitio, realice una GET llamada a https://api.adnxs.com/site/meta. |
supported_media_subtypes |
no | matriz | Subtipos multimedia que pueden servir en la ubicación. Consulte Subtipos de medios admitidos a continuación para obtener más detalles. |
supported_media_types |
no | matriz | Los tipos de medios que pueden servir en la ubicación. Consulte Tipos de medios admitidos a continuación para obtener más detalles. |
tag_data |
no | string | Otra información, a menudo datos demográficos o descriptivos. Solo se envía al postor del propietario. Vea también qs_data en TinyTags. Nota: este campo aparece como "other_data" en la lista /meta. |
use_detected_domain |
No, el valor predeterminado es true. | booleano | Solo lectura. Si se va a usar el dominio detectado frente al dominio notificado. El valor predeterminado es true para todos los clientes. |
visibility_profile_id |
no | Entero | Identificador del perfil de visibilidad asignado directamente a la ubicación. |
width |
no | Entero | Ancho de la etiqueta en píxeles. |
Tipos de medios admitidos
Las creatividades se clasifican por tipo de medio y subtipo multimedia. El tipo de medio define el estilo de visualización general de la creatividad, por ejemplo, "Banner" y el subtipo multimedia define el estilo de visualización específico de las creatividades, por ejemplo, "Banner estándar" o "Vídeo en banner". Puede usar esta matriz para limitar el tipo de medio, el estilo de visualización general de las creatividades, que puede servir en una ubicación. Para limitar el subtipo multimedia, el estilo de visualización específico de las creatividades, use la matriz supported_media_subtypes (consulte Subtipos multimedia admitidos a continuación).
| Campo | Tipo | Description |
|---|---|---|
id |
Entero | Identificador del subtipo de medios permitido. |
name |
string | Solo lectura. Nombre del subtipo de medios permitido. |
Subtipos multimedia admitidos
Las creatividades se clasifican por tipo de medio y subtipo multimedia. El tipo de medio define el estilo de visualización general de la creatividad, por ejemplo, "Banner" y el subtipo multimedia define el estilo de visualización específico de las creatividades, por ejemplo, "Banner estándar" o "Vídeo en banner". Puede usar esta matriz para limitar el subtipo multimedia, el estilo de visualización específico de las creatividades, que puede servir en una ubicación. Para limitar el tipo de medio, el estilo de visualización general de las creatividades, use la matriz supported_media_types (consulte Los subtipos multimedia admitidos anteriormente).
| Campo | Tipo | Description |
|---|---|---|
id |
Entero | Identificador del subtipo de medios permitido. |
name |
string | Solo lectura. Nombre del subtipo de medios permitido. |
Notas sobre los tipos de medios y subtipos multimedia admitidos
Si no especifica los tipos de medios admitidos o los subtipos multimedia admitidos, el tipo de medio "Banner" se permite de forma predeterminada.
Puede combinar los tipos de medios "Banner" y "Text", así como cualquier combinación de sus subtipos multimedia, en una sola ubicación, pero no puede combinar ninguno de los otros tipos de medios y subtipos multimedia. Esta limitación garantiza que solo se proporcionen las creatividades adecuadas en una ubicación. Por ejemplo, una ubicación que permite a los creativos del tipo multimedia "Video" se pretende alimentar a un reproductor de vídeo; no tendría sentido permitir que los creativos de cualquier otro tipo de medio, como "Intersticial", sirvieran en la colocación.
Puede establecer una ubicación para permitir el tipo de medio "Expandable" o cualquiera de sus subtipos para el inventario directo. Si desea admitir creatividades ampliables para las ubicaciones que están disponibles para revender a otros miembros de la plataforma, proporcione la dirección URL para que sea compatible con la verificación.
Creatividades predeterminadas
Esta matriz se usa para asignar creatividades predeterminadas a la ubicación. Tenga en cuenta los siguientes requisitos:
- Una creatividad predeterminada no debe expirar. Para obtener más información, consulte el campo is_expired en Creative Service.
- Se debe asignar una creatividad predeterminada a una plantilla creativa que coincida con el supported_media_types y supported_media_subtypes de la ubicación. Por ejemplo, si la ubicación permite creatividades del tipo de medio "Banner", no podrá asociar las creatividades predeterminadas que usan una plantilla creativa para el tipo de medio "Intersticial". Consulte el campo de plantilla en Creative Service para obtener más información.
- Si el tamaño de la ubicación es (los campos "width" y "height" están definidos para la colocación), esta matriz debe contener solo un creativo con las dimensiones coincidentes.
| Campo | Tipo | Description |
|---|---|---|
height |
Entero | Alto de la creatividad predeterminada. |
id |
Entero | Identificador de la creatividad predeterminada. |
name |
string | Solo lectura. Nombre de la creatividad predeterminada. |
price |
double | Precio de reserva para la creatividad predeterminada. Una oferta ganadora debe estar por encima de este precio. |
width |
Entero | Ancho de la creatividad predeterminada. |
Valores emergentes
Si el supported_media_type es "Pop" o el supported_media_subtypes es "Popup" o "Popunder", estos campos deben incluirse en la matriz "pop_values". Consulte a continuación para obtener un ejemplo.
| Campo | Tipo | Description | Predeterminada |
|---|---|---|---|
| pop_freq_duration | Entero | Consulte pop_freq_times. | Sin límite de frecuencia |
| pop_freq_times | Entero | Número de veces que la etiqueta se puede mostrar a un usuario único en pop_frequency_duration segundos. No tiene ningún efecto cuando pop_is_prepop se establece en true. | Sin límite de frecuencia |
| pop_is_prepop | booleano | Si es true, la etiqueta es una etiqueta de rellenado previo y sirve en una ventana que la página del publicador ya ha aparecido. | false |
| pop_max_height | Entero | Alto máximo de la creatividad. Si se especifica pop_max_height, cualquier creatividad mostrada por la etiqueta debe tener un alto igual o menor que pop_max_height | sin altura máxima |
| pop_max_width | Entero | Si se especifica pop_max_width, cualquier creatividad mostrada por la etiqueta debe tener un ancho igual o menor que pop_max_width | sin ancho máximo |
Precios claros estimados
| Campo | Tipo | Description |
|---|---|---|
| average_price | double | Este es el promedio de todas las ofertas enviadas para esta colocación. |
| clear_price | Entero | El importe de la puja que históricamente ha ganado la mayoría (95%) de las subastas de terceros en las que participa para esta colocación. |
| height | Entero | Al exportar etiquetas de ubicación sin tamaño que se van a servir, esto determina el alto de la ubicación. |
| Verificado | booleano | Indica si se comprueban los precios creados. |
| width | Entero | Al exportar etiquetas de ubicación sin tamaño que se van a servir, esto determina el ancho de la ubicación. |
Ejemplo
Paso 1. Create un archivo con formato JSON con los parámetros pertinentes
$ cat tag
{
"tinytag":
{
"width": "728",
"height": "90",
"reserve_price": "5.00",
"default_creative_id": 212,
"active": true,
"tag_data": "male/22",
"ad_profile_id": 234
}
}
Paso 2. Agregue el archivo TinyTag a la memoria caché de Imp Bus mediante el identificador de miembro.
$ curl -b cookies -c cookies -X POST --data-binary @tag https://api.adnxs.com/tt/1/
{
"response": {
"status": "OK",
"id": "1234"
}
}
Paso 3. Visualización de la etiqueta que ha creado con el identificador de etiqueta 1234
$ curl -b cookies -c cookies https://api.adnxs.com/tt/1/1234
$ curl -b cookies -c cookies [adnxs.com/tt/1/1234](https://api.adnxs.com/tt/1/1234)
{
"response": {
"tinytag": {
"id": 1234,
"width": "728",
"height": "90",
"member_id": 1,
"reserve_price": 5.00,
"default_creative_id": 212,
"tag_data": "male\/22",
"active": true,
"ad_profile_id": 234
},
"status": "OK"
}
}