Licitadores: servicio para miembros
Nota
Los miembros se integran en el sistema de Xandr y se administran a través del servicio miembro.
Cualquier entidad que tenga una relación financiera con la plataforma de Xandr (normalmente un comprador o vendedor) debe agregarse al sistema de Xandr como "miembro" para poder realizar transacciones. Los miembros pueden registrarse en el Servicio para Miembros, ya sea por un postor o por personal de Xandr.
Para poder comprar o vender anuncios, un miembro necesita un contrato con Xandr. Este contrato establecerá términos financieros y facilidades de crédito (si procede) y vinculará al miembro a los términos y condiciones de Xandr, como la calidad del contenido y el uso de información de identificación personal. Cualquier postor puede crear un miembro en cualquier momento, pero los miembros no podrán realizar ofertas hasta que su contrato haya sido aprobado.
Nota
- Si busca información sobre otros miembros de la plataforma, use el servicio de miembro de la plataforma.
- En los entornos de espacio aislado del licitador, está disponible toda la funcionalidad del servicio miembro.
- El servicio miembro no concede acceso a la API. Esto se hace a través del servicio de usuario.
Http (método) | Endpoint | Description |
---|---|---|
GET |
https://api.adnxs.com/member | Para ver a todos los miembros. |
GET |
https://api.adnxs.com/member/MEMBER_ID | Para ver un miembro determinado. |
Nota
Las llamadas siguientes solo son visibles para los empleados de Xandr. Los pueden hacer los usuarios con el "administrador" user_type
.
Http (método) | Endpoint | Description |
---|---|---|
POST |
https://api.adnxs.com/member | Para agregar un nuevo miembro. |
PUT |
https://api.adnxs.com/member/MEMBER_ID | Para modificar un miembro existente. |
Campo | Tipo | Descripción |
---|---|---|
active |
Booleano | Si el miembro puede proporcionar o pujar por el inventario. |
agent_id |
string | Se usa para los miembros del agregador de inventario. |
allow_ad_profile_override |
Este campo no se usa actualmente. | |
audit_notify_email |
string | Cada vez que Xandr audita una creatividad que pertenece a este miembro, se envía una respuesta detallada a esta dirección de correo electrónico. La respuesta incluye el estado de auditoría del creativo y los motivos por los que la creatividad no ha superado la auditoría. Este campo admite varias direcciones de correo electrónico separadas por comas. |
bidder_id |
Entero | El licitador que administra la puja por el miembro. Puede estar en blanco para los miembros que solo venden inventario. |
billing_address_1 |
string(255) | Primera línea de la dirección del miembro. |
billing_address_2 |
string(255) | Segunda línea de la dirección del miembro. |
billing_city |
string(100) | La ciudad de la dirección del miembro. |
billing_country |
string(50) | El país del miembro. |
billing_name |
string(100) | Nombre de facturación (en el que se va a escribir). Obligatorio activado: POST . |
billing_postal_code |
string(50) | El código postal de la dirección del miembro. |
billing_region |
string | Región de la dirección del miembro. |
buyer_clearing_fee_pct |
double | Porcentaje del CPM pagado por el inventario cobrado como cuota. |
buyer_credit_limit |
double | Límite de crédito para este miembro al comprar inventario a través de Xandr. Solo lectura. |
code |
string(100) | Forma opcional de agregar una identificación interna. |
contact_email |
Este campo no se usa actualmente. | |
default_ad_profile_id |
Entero | Si quieres establecer un perfil de anuncio para todos los TinyTags que pertenecen a un miembro. |
default_tag_id |
Entero | Identificador de la creatividad que se va a servir en el caso de que se llame a las etiquetas mediante códigos desconocidos. |
dongle |
string | Contraseña que se puede pasar a una subasta de depuración (como el parámetro "dongle") que permitirá a un miembro acceder a la salida de depuración pertinente desde su pujador. |
email_code |
string(50) | El código de correo electrónico es un valor único que se usa cuando TinyTags se procesa a través de nuestra herramienta de procesamiento de etiquetas de correo electrónico. Debe ser un valor alfanumérico. |
id |
Entero | Identificador del miembro. Obligatorio activado: PUT . |
last_activity |
Timestamp | Marca de tiempo de la última modificación en esta instancia del licitador. |
platform_exposure |
Consulte a continuación para obtener más información. | |
price_buckets |
matriz | Cuando se usan etiquetas preferentes, un miembro de la venta puede requerir price bucket para los precios del servidor de anuncios de terceros. En función del tipo de integración que requiera un servidor adserver de terceros, los valores pueden ser [{"price_bucket": 10}, {"price_bucket": 20}. . . ] Otra posibilidad: [{"price_bucket": 10, "width": 300, "height":200", "pixel_url": "https://..."}, . . . ] . |
prioritize_margin |
Booleano | Si se establece en "true" , Xandr realizará una comprobación de puja o sin puja para las campañas administradas en función de la configuración de margen mínimo del elemento de línea. Si se establece en "false" , Xandr no realizará ninguna comprobación de puja o de oferta para campañas administradas basadas en el elemento de línea mínimo. |
seller_revshare_pct |
double | Solo lectura para usuarios y miembros del pujador. Cantidad porcentual que Xandr saca de los ingresos del vendedor. |
serving_domain |
matriz de cadenas | Se usa al generar etiquetas para vender miembros. (es decir, mycompany.adnxs.com en su lugar ib.adnxs.com ). "serving_domain": {"cname": null,"type": null} Solo lectura. |
sherlock_notify_email |
string | Cada vez que Sherlock, nuestro sistema de escaneo creativo automatizado, escanea una creatividad que pertenece a este miembro, se envía una respuesta a esta dirección de correo electrónico. La respuesta incluye el estado de auditoría del creativo y los motivos por los que la creatividad no ha superado la auditoría. Para obtener más información, vea Sherlock. Este campo admite varias direcciones de correo electrónico separadas por comas. |
timezone |
string | La zona horaria de miembro es la zona horaria predeterminada para los informes. Para ver los valores posibles, consulte Zonas horarias de informes. El valor predeterminado es "EST5EDT" . |
La configuración de exposición de la plataforma determina cómo se muestra la cuenta a otros miembros de la plataforma. Hay tres valores que dan lugar a comportamientos ligeramente diferentes, como se describe a continuación:
Valor de exposición de la plataforma | Comportamiento |
---|---|
hidden |
No se muestra el miembro. Nota: Si se establece platform_exposure en , ocultará el miembro "name" y "domain" los campos en nuestro archivo de sellers.json y mostrará el asiento del miembro como "is_confidential": 1 ."hidden" Por ejemplo, vea hidden el ejemplo.Esto puede limitar la monetización del inventario, ya que es posible que algunos proveedores de servicios no decidan comprar impresiones a vendedores que no sean transparentes en el "schain" objeto. |
private |
El miembro se muestra como "Miembro 123", donde 123 es el identificador de miembro. |
public |
El miembro se muestra con el nombre de facturación. Nota: Si se establece platform_exposure en , se mostrarán el miembro "name" y "domain" los campos en nuestro archivo de sellers.json."public" Por ejemplo, vea public el ejemplo. |
{
"seller_id": "8253",
"is_confidential": 1,
"seller_type": "PUBLISHER"
}
{
"seller_id": "7694",
"seller_type": "INTERMEDIARY",
"domain": "groupm.com",
"name": "Xaxis – Slovakia Marketplace"
}
En el json de ejemplo siguiente se muestra cómo establecer este parámetro.
{
"member": {
"platform_exposure": "public"
}
}
La autenticación siempre es el primer paso cuando se usan los servicios de API. A continuación, el token de autenticación se puede escribir en nuestro archivo de cookies para su uso futuro. Para obtener instrucciones más detalladas, consulte Servicio de autenticación.
Los únicos campos necesarios son billing_name
y bidder_id
si el miembro está asociado a un postor, pero como un miembro tiene una relación financiera con Xandr, probablemente querrá incluir otra información relacionada con la facturación.
$ cat member
{
"member" : {
"active" : true,
"billing_name" : "My Company",
"bidder_id" : 2,
"billing_address_1" : "One Coke Way",
"billing_city" : "Atlanta",
"billing_region" : "GA",
"billing_country" : "US",
"email_code" : "cola"
}
}
$ curl -b cookies -c cookies -X POST --data-binary @member 'https://api.adnxs.com/member'
{
"response":{
"status":"OK","id":1
}
}
$ cat member_mod
{
"member" : {
"active" : true,
"billing_name" : "My Company",
"bidder_id" : 2,
"billing_address_1" : "Building 5",
"billing_address_2" : "Company Complex",
"billing_city" : "Atlanta",
"billing_region" : "GA",
"billing_country" : "US",
"billing_postal_code" : "33608"
}
}
Actualice la información de miembro en la memoria caché del bus de impresiones mediante el identificador de miembro.
$ curl -b cookies -c cookies-X PUT --data-binary @member_mod 'https://api.adnxs.com/member/1'
{
"response":{
"status":"OK"
}
}
$ curl -b cookies -c cookies 'https://api.adnxs.com/member/1'
{
"response":{
"status":"OK",
"member": {
"id": 334,
"agent_id": null,
"code": null,
"active": true,
"buyer_credit_limit": 0,
"billing_name" : "My Company",
"bidder_id" : 2,
"billing_address_1" : "Building 5",
"billing_address_2" : "Company Complex",
"billing_city" : "Atlanta",
"billing_region" : "GA",
"billing_country" : "US",
"billing_postal_code" : "33608"
"email_code": "cola",
"seller_revshare_pct": 95,
"price_buckets": [
],
"default_tag_id": null,
"default_ad_profile_id": 251,
"buyer_clearing_fee_pct": null,
"serving_domain": {
"cname": null,
"type": null
},
"last_activity": "2010-04-08 03:38:16",
"timezone": "EST5EDT"
}
}
}