Servicio de perfil de licitador heredado

Los perfiles de licitador se usan para crear y administrar criterios de filtrado para los que desea recibir solicitudes de puja en tiempo real. Los perfiles permiten limitar los recursos necesarios para procesar solicitudes de puja no deseadas. Consulte el perfil del licitador: preguntas más frecuentes.

Notas importantes

• Para que una solicitud de puja pase un perfil de licitador, la solicitud de puja debe cumplir TODOS los criterios de filtro especificados.
• Puede crear varios perfiles para el postor, pero solo un perfil primario puede estar activo para el postor en un momento dado. Active un perfil asociándolo al licitador mediante el Servicio del Licitante.
• El postor siempre recibirá solicitudes de puja para el inventario que pertenece a un miembro asociado con el postor. En este caso, los perfiles del licitador no se aplican.
• Los licitadores del proveedor de datos solo pueden tener un perfil primario y ningún perfil secundario.

Advertencia

Los perfiles deben adjuntarse a un objeto pujador activo.

Después de crear un perfil, debe adjuntarlo al postor especificando "parent_profile_id" a través del Servicio del Licitante.

No use campos en desuso.

No incluya ninguno de los campos marcados como en desuso a continuación cuando configure los perfiles. Esto hará que el licitador no reciba el volumen esperado de solicitudes de puja.

Las actualizaciones de perfil frecuentes pueden bloquear temporalmente ese perfil.

Si realiza varias actualizaciones en un perfil de postor en un plazo de 30 minutos, es posible que el perfil se bloquee como precaución de seguridad. Si se bloquea un perfil, el tráfico que coincida solo con este perfil no pasará durante aproximadamente 5 minutos.

Criterios de filtrado admitidos

Actualmente se admiten los siguientes criterios de filtrado:

• Miembro vendedor
  • Especifique si desea requerir o excluir el inventario de los miembros, consulte servicio de miembros de la plataforma.

Nota:

El grupo de miembros de Xandr Direct Seller se incluye de forma predeterminada y no se puede excluir a través de la API. Para obtener más información, consulte Suministro para asociados de demanda externa.

• Geografía
  • País
    • Incluir o excluir solicitudes para un conjunto especificado de países, OR
    • Recibir solicitudes de puja para cualquier país EXCEPTO un conjunto especificado de países.
  • Región
    • Incluir o excluir solicitudes para un conjunto especificado de regiones, OR
    • Recibir solicitudes de puja para cualquier región EXCEPTO un conjunto especificado de regiones.
  • DMA
    • Incluir o excluir solicitudes para un conjunto especificado de DMA, OR
    • Recibir solicitudes de puja para cualquier región EXCEPTO un conjunto especificado de DMA.
• Inventario
  • Lista de dominios
    • Incluir o excluir solicitudes de impresiones que cumplan los requisitos de listas de permitidos o listas de bloqueo.
  • Atributo inventory
    • Incluir o excluir solicitudes de impresiones que contengan determinados atributos de inventario.
  • Estado de auditoría
    • Excluir solicitudes de dominios que Xandr no ha auditado.
• Público

Advertencia

A partir del 27 de abril de 2019, Xandr ya no admite segmentos en la plataforma para los CSP integrados externamente.

• Segmentación de destino

  • Incluir o excluir solicitudes de usuarios que cumplan los criterios de segmentación de destino.

• Tamaño creativo

  • Incluir o excluir solicitudes de puja para el conjunto especificado de tamaños creativos.

• Tipo de suministro (web/mobile_app/mobile_web)

  • Incluir o excluir impresiones para aplicaciones web y móviles normales.

API de REST

Http (método)	Endpoint	Description
GET	https://api.adnxs.com/profile/BIDDER_ID	Ver perfiles: Para ver todos los perfiles adjuntos al postor.
GET	https://api.adnxs.com/profile/BIDDER_ID/PROFILE_ID	Ver perfiles: Para ver un perfil específico adjunto al postor.
POST	https://api.adnxs.com/profile/BIDDER_ID (JSON de perfil)	Agregue un perfil para el postor.
PUT	https://api.adnxs.com/profile/BIDDER_ID/PROFILE_ID (JSON de perfil)	Modificar un perfil existente.
DELETE	https://api.adnxs.com/profile/BIDDER_ID/PROFILE_ID Nota: Solo se pueden eliminar perfiles inactivos; es decir, perfiles que no están asociados al objeto del licitador.	Elimine un perfil existente.
	Use el Servicio del Licitador para establecer el profile_id campo del licitador en el identificador del perfil de licitador deseado.	Active un perfil para el postor como perfil primario.
	Use el Servicio del Licitador para actualizar la matriz de child_profiles en el licitador para incluir el identificador del perfil de licitador deseado.	Active un perfil para el postor como perfil secundario.

Campos JSON

Campo	Tipo	Descripción
ID	Cadena	Identificador único del perfil del licitador. Obligatorio: Sí, al actualizar.
code	Cadena	Identificador alternativo para el perfil del licitador, específico del postor. Obligatorio: No.
description	Cadena	Descripción del perfil del licitador. Obligatorio: No.
last_activity	Timestamp	Marca de tiempo de la última modificación del perfil. Obligatorio: No.
Limitación de pujas
passthrough_percent	double	Porcentaje (50 = 50 %) de solicitudes de puja que satisfacen la segmentación de perfil que desea recibir. Las solicitudes que se envían al postor se eligen aleatoriamente, aunque puede elegir que el licitador reciba siempre solicitudes para los usuarios en segmentos de miembros asociados con el postor. Si establece en passthrough_percent0, el pujador solo recibirá solicitudes de usuarios en al menos uno de los segmentos de los miembros. Estos valores surten efecto en incrementos de 0,1. Obligatorio: No.
Filtrado de miembros
member_targets	Matriz de objetos	Matriz de objetos que incluyen los identificadores de miembro de los miembros. La acción predeterminada, si no se especifica ninguna acción, es "include" , lo que significa que se deben incluir los identificadores de miembro. Esto se puede invalidar especificando en "action" el objeto , por ejemplo, "member_targets":[{"id":"100","action": "exclude"}]. Para obtener más información, consulte Servicio de miembros de la plataforma. Obligatorio: No.
Filtrado geográfico
country_action	Enumeración: "exclude" o "include"	Si "exclude"es , solo se enviarán al licitador las solicitudes de puja para los países QUE NO están en "country_targets" . Si "include"es , solo se enviarán al licitador las solicitudes de puja de los países de "country_targets" . El valor predeterminado es exclude. Obligatorio: No.
country_targets	Matriz de objetos	Los identificadores de país que se excluirán o incluirán, tal como se define en el country_action campo. Puede usar country service para recuperar una lista de identificadores de país. Para obtener más detalles y formato, consulte Destinos de país. Obligatorio: No.
region_action	Enumeración: "exclude" o "include"	Si "exclude"es , solo se enviarán al licitador las solicitudes de puja de las regiones NOT in "region_targets" . Si "include"es , solo se enviarán al licitador las solicitudes de puja de las regiones de "region_targets" . El valor predeterminado es exclude. Obligatorio: No.
region_targets	Matriz de objetos	Los identificadores de región o estado que se van a excluir o incluir, tal como se define en el region_action campo. Puede usar el Servicio de región para recuperar una lista de identificadores de región. Para obtener más detalles y formato, consulte Destinos de región. Obligatorio: No.
dma_targets	Matriz de objetos	Matriz de objetos que especifican el destino de dmas (para inclusión o exclusión). E.g. [{"dma":123}, {"dma":124}] Obligatorio: No.
dma_action	Enumeración: "exclude" o "include"	Valores predeterminados de "exclude". Consulte dma_targets. Obligatorio: No.
city_targets	Matriz de objetos	Los identificadores de ciudades que se incluirán o excluirán, tal como se define en el city_action campo. Puede usar city service para recuperar una lista de identificadores de ciudad. Para obtener más detalles y formato, consulte Destinos de ciudad. Obligatorio: No.
city_action	Enumeración: "exclude" o "include"	Si "exclude"es , solo se enviarán al licitador las solicitudes de ofertas de ciudades QUE NO estén en "city_targets" . Si "include"es , solo se enviarán al licitador las solicitudes de puja de las ciudades de "city_targets" . El valor predeterminado es exclude. Obligatorio: No.
Inventario
inventory_action	Enumeración: "exclude" o "include"	En desuso. Déjelo como "exclude" y no use este campo, ya que esto puede reducir el inventario disponible enviado al pujador. Obligatorio: No.
use_inventory_attribute_targets	Booleano	Si se establece en "true", inventory_attribute_targets se aplicará. Esta marca permite "opt-in" recibir determinados atributos de inventario, como las barras de herramientas, si existen para un fragmento de inventario. Si "false"es , el pujador recibirá todo el inventario. Obligatorio: No.
inventory_attribute_targets	Matriz de objetos de atributo de inventario .	Matriz de objetos para que los destinos incluyan, por ejemplo, [{"id":12}]. Si use_inventory_attribute_targets está habilitado, enviaremos solicitudes de puja que contengan los atributos seleccionados. También enviaremos solicitudes de puja que no contengan atributos de inventario. Para excluir un atributo de inventario determinado, solo tiene que incluir todos los identificadores excepto el atributo que desea excluir. Obligatorio: No.
non_audited_url_action	string	Si se establece en "exclude", se excluirá todo el inventario que Xandr no haya auditado. De lo contrario, se incluirá todo el inventario. Obligatorio: No.
domain_list_action	Enumeración: "exclude" o "include"	Acción predeterminada que se va a aplicar a domain_list_target. Obligatorio: No.
domain_list_targets	Matriz de objetos con el identificador de las listas de dominios.	Matriz de objetos para los destinos de lista de dominios, por ejemplo, []. Solo se enviarán al licitador las solicitudes de puja para el inventario que coincidan con para domain_list_action las listas de dominio enumeradas. Obligatorio: No.
domain_action		Obligatorio: Obsoleto.
domain_targets		Obligatorio: Obsoleto.
Público
segment_targets	Matriz de destinos de segmento con el identificador y la acción de cada uno.	Si "segment_boolean_operator" es "and", si "action" para un segmento se establece "exclude"en , las impresiones de los usuarios que están en ese segmento no se enviarán al pujador; si alguno "action" está establecido "include"en , los usuarios de los segmentos que se incluyen se enviarán al pujador. Si "segment_boolean_operator" se establece en "or", los usuarios que cumplan cualquiera de los segment_targets criterios se enviarán al licitador. Advertencia: A partir del 27 de abril de 2019, Xandr ya no admitirá segmentos en la plataforma para los CSP integrados externamente. Obligatorio: No.
segment_boolean_operator	Enumeración : "y" o "o"	Acción que se va a aplicar a segment_targets. "Y" significa que se deben cumplir todos los criterios. "O" significa que se debe cumplir al menos uno. Advertencia: A partir del 27 de abril de 2019, Xandr ya no admitirá segmentos en la plataforma para los CSP integrados externamente. Obligatorio: No.
Tipo de suministro (web/móvil)
supply_type_targets	Matriz de destinos de tipo de suministro: "mobile_app" (para el inventario de aplicaciones móviles), "mobile_web" (para el inventario web móvil), "web" (para el inventario de visualización normal)	Determina qué destinos de tipo de suministro deben incluirse o excluirse en virtud de supply_type_action. Obligatorio: No.
supply_type_action	Enumeración: "exclude" o "include"	Acción que se va a aplicar a supply_type_targets. Obligatorio: No.
Específico para dispositivos móviles
carrier_targets	Todavía no se admite	Obligatorio: No.
carrier_action	Enumeración: "exclude" o "include"	Acción que se va a aplicar a carrier_targets. Obligatorio: No.
handset_make_targets	Todavía no se admite	Obligatorio: No.
handset_make_action	Enumeración: "exclude" o "include"	Acción que se va a aplicar a handset_make_targets. Obligatorio: No.
handset_model_targets	Todavía no se admite	Obligatorio: No.
handset_model_action	Enumeración: "exclude" o "include"	Acción que se va a aplicar a handset_model_targets. Obligatorio: No.
location_target_radius	Todavía no se admite	Obligatorio: No.
location_target_latitude	Todavía no se admite	Obligatorio: No.
location_target_longitude	Todavía no se admite	Obligatorio: No.
Otros
size_targets	Matriz de objetos	Matriz de anchos y alturas, especificando los tamaños creativos en los que pujará el licitador. E.g. [{"width":300,"height":250},{"width":600,"height":160}] Obligatorio: No.
No compatible actualmente
language_targets		Este campo no está disponible actualmente.
postal_code_targets		Este campo no está disponible actualmente.
age_targets		Este campo no está disponible actualmente.
daypart_targets		Este campo no está disponible actualmente.
browser_targets		Este campo no está disponible actualmente.

Destinos de país

Cada objeto de la country_targets matriz contiene los campos siguientes.

Campo	Tipo	Description
id	Entero	El identificador del país. Puede usar country service para recuperar una lista completa de identificadores de país.
name	string	Solo lectura. Nombre del país.
code	string	Solo lectura. Código del país.

Destinos de país: ejemplo

{
    "profile": {
        "country_action": "include",
        "country_targets": [
            {
                "id": 233,
                "name": "United States",
                "code": "US"
            }
        ]
    }
}

Destinos de región

Cada objeto de la region_targets matriz contiene los campos siguientes.

Campo	Tipo	Description
id	Entero	Identificador de la región. Puede usar el Servicio de región para recuperar una lista de identificadores de región.
name	string	Solo lectura. Nombre de la región.
code	string	Solo lectura. Código de la región.
country_name	string	Solo lectura. Nombre del país al que pertenece la región.
country_code	string	Solo lectura. Código del país al que pertenece la región.

Destinos de región: ejemplo

{
    "profile": {
        "region_action": "include",
        "region_targets": [
            {
                "id": 1
                                "name": "New York",
                                "code": "NY",
                "country_name": "United States",
                                "country_code": "US"
            }
        ]
    }
}

Destinos de ciudad

Cada objeto de la city_targets matriz contiene los campos siguientes.

Campo	Tipo	Description
id	Entero	Identificador de la ciudad de destino. Puede usar city service para recuperar una lista de identificadores de ciudad.
name	string	Solo lectura. Nombre de la ciudad de destino.
region_name	string	Solo lectura. Nombre de la región a la que pertenece la ciudad.
region_code	string	Solo lectura. Código de la región a la que pertenece la ciudad.
country_name	enumeración	Solo lectura. Nombre del país al que pertenece la región.
country_code	enumeración	Solo lectura. Código del país al que pertenece la región.

Destinos de ciudad: ejemplo

{
    "profile": {
        "city_action": "include",
        "city_targets": [
            {
                "id": 123,
                "name": "Queens",
                "region_name": "New York",
                "region_code": "NY",
                "country_code": "US",
                "country_name": "United States",
            }
        ]
    }
}

Token de autenticación

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.

Ejemplos

Adición de un nuevo perfil al postor 6

El identificador del nuevo perfil es 123.

$ cat bidder_profile:
    {
    "profile":
        {
        "description": "Only Alberta (NO US can be included)",
        "country_action": "include",
        "country_targets": [{"id": 1},{"ide":2}],
        "region_action": "exclude",
        "region_targets": [{id: 1}],
        "member_targets": [
           {
             "id": "100",
             "action": "exclude"
           },
           {
             "id": "102",
             "action": "exclude",
             "name": "Inventory name 2"
           }
        ],
        "dma_targets": [{"dma":123}, {"dma":124}],
        "dma_action": "exclude",
        "segment_boolean_operator": "and",
        "segment_targets": [
         {
          "id": "16808",
          "name": "Users meeting certain criteria",
          "action": "include",
          "start_minutes": null,
          "expire_minutes": null,
          "other_less": null,
          "other_greater": null,
          "other_equals": null
         },
         {
          "id": "16809",
          "name": "Users that have seen an ad for this campaign and should not be targeted for 2 days",
          "action": "exclude",
          "start_minutes": null,
          "expire_minutes": "2880",
          "other_less": null,
          "other_greater": null,
          "other_equals": null,
         }
        ],
        "size_targets": [{"width":300,"height":250},{"width":600,"height":160}]
        }
    }
    $ curl -b cookies -c cookies -X POST --data-binary @bidder_profile "https://api.adnxs.com/profile/6"
    {
    "response":
       {
         "status":"OK",
         "id":"123"
       }
    }

Visualización de todos los perfiles asociados actualmente al licitador 6

curl -b cookies -c cookies "https://api.adnxs.com/profile/6"

Ver el perfil 123 asociado al licitador 6

curl -b cookies -c cookies "https://api.adnxs.com/profile/6/123"

Para activar un perfil para el postor, use el Servicio del Licitador para establecer el profile_id campo del postor en el id. del perfil de licitador deseado.

Actualización del identificador de perfil 123 al licitador 6

$ cat bidder_profile:
    {
    "profile":
        {
        "id": "123",
        "country_action": "include",
        "country_targets": [{"id": 233}]
        }
    }
    $ curl -b cookies -c cookies -X PUT --data-binary @bidder_profile "https://api.adnxs.com/profile/6/123"

Agregue una lista de dominios al perfil del licitador como una "lista de bloqueos"

Sugerencia

Para obtener más información sobre las listas de dominios, consulte Domain List Service.

$ cat domain-list-profile
{
   "profile" : {
      "domain_list_targets" : [
         {
            "id" : 9351
         }
      ],
      "domain_list_action" : "exclude",
      "id" : 431739
   }
}
$ curl -b cookies -c cookies -X PUT --data-binary @domain-list-profile 'https://api.adnxs.com/profile/497/431739'
{
   "response" : {
      "count" : 1,
      "num_elements" : null,
      "id" : "431739",
      "profile" : {
         "supply_type_targets" : null,
         "browser_targets" : null,
         "id" : 431739,
         "dma_targets" : null,
         "screen_size_targets" : null,
         "inventory_attribute_targets" : null,
         "device_type_targets" : null,
         "dma_action" : "exclude",
         "operating_system_targets" : null,
         "domain_list_targets" : [
            {
               "id" : 9351,
               "deleted" : false,
               "type" : "black",
               "description" : "Rich's awesome domain list (blocklist)",
               "name" : "Rich's awesome domain list (blocklist)"
            }
         ],
         "session_freq_type" : "platform",
         "operating_system_family_targets" : null,
         "domain_targets" : null,
         "venue_targets" : null,
         "description" : "Ethical Ad Blocker Test Segment",
         "city_targets" : null,
         "age_targets" : null,
         "domain_action" : "exclude",
         "inventory_action" : "exclude",
         "site_targets" : null,
         "size_targets" : [
            {
               "width" : 300,
               "height" : 50
            },
            {
               "width" : 300,
               "height" : 250
            }
         ],
         "location_target_radius" : null,
         "language_action" : "exclude",
         "ip_targets" : null,
         "segment_targets" : [
            {
               "deleted" : false,
               "other_greater" : null,
               "name" : "ethical ad blocker segment 00",
               "code" : "ethical-adblock-00",
               "other_less" : null,
               "expire_minutes" : null,
               "action" : "include",
               "other_in_list" : null,
               "id" : 110944,
               "other_equals" : null,
               "start_minutes" : null
            }
         ],
         "is_expired" : false,
         "region_action" : "exclude",
         "location_target_latitude" : null,
         "code" : "ethical-adblock-00",
         "inventory_group_targets" : null,
         "country_action" : "exclude",
         "querystring_targets" : null,
         "carrier_targets" : null,
         "member_id" : null,
         "passthrough_percent" : 100,
         "segment_boolean_operator" : "or",
         "intended_audience_targets" : null,
         "operating_system_extended_targets" : null,
         "device_model_action" : "exclude",
         "language_targets" : null,
         "gender_targets" : null,
         "non_audited_url_action" : "include",
         "inventory_network_resold_targets" : null,
         "supply_type_action" : "exclude",
         "daypart_targets" : null,
         "daypart_timezone" : null,
         "postal_code_targets" : null,
         "querystring_boolean_operator" : "and",
         "last_activity" : "2015-03-30 21:25:41",
         "member_targets" : [
            {
               "action" : "include",
               "billing_name" : "unexposed",
               "id" : 4782,
               "third_party_auditor_id" : null
            }
         ],
         "browser_family_targets" : null,
         "screen_size_action" : "exclude",
         "min_session_imps" : null,
         "device_model_targets" : null,
         "querystring_action" : "exclude",
         "segment_group_targets" : null,
         "country_targets" : null,
         "city_action" : "exclude",
         "domain_list_action" : "exclude",
         "location_target_longitude" : null,
         "carrier_action" : "exclude",
         "position_targets" : null,
         "use_inventory_attribute_targets" : false,
         "device_type_action" : "exclude",
         "region_targets" : null,
         "browser_action" : "exclude"
      },
      "start_element" : null,
      "status" : "OK"
   }
}

Tema relacionado

Perfil del licitador: preguntas más frecuentes