Servicio de anunciante

Artículo
05/18/2024

El servicio Anunciante permite a las redes agregar, modificar y ver los anunciantes que interactúan con Xandr. Los vendedores directos rara vez usan el servicio anunciante porque solo tienen un anunciante (ellos mismos).

API de REST

Http (método)	Endpoint	Description
`GET`	`https://api.appnexus.com/advertiser`	Ver a todos tus anunciantes.
`GET`	`https://api.appnexus.com/advertiser?id=ADVERTISER_ID`	Ver un anunciante específico.
`GET`	`https://api.appnexus.com/advertiser?code=ADVERTISER_CODE`	Ver un anunciante específico.
`GET`	`https://api.appnexus.com/advertiser?id=1,2,3`	Vea varios anunciantes por identificador mediante una lista separada por comas.
`GET`	`https://api.appnexus.com/advertiser?search=SEARCH_TERM`	Busque anunciantes con identificadores o nombres que contengan determinados caracteres.
`GET`	`https://api.appnexus.com/advertiser/meta`	Averigüe por qué campos puede filtrar y ordenar.
`POST`	`https://api.appnexus.com/advertiser`	Agregue un nuevo anunciante.
`PUT`	`https://api.appnexus.com/advertiser?id=ADVERTISER_ID`	Modificar un anunciante existente.
`PUT`	`https://api.appnexus.com/advertiser?code=ADVERTISER_CODE`	Modificar un anunciante existente.
`DELETE`	`https://api.appnexus.com/advertiser?id=ADVERTISER_ID`	Eliminar un anunciante. Nota: Al eliminar un anunciante, se eliminarán todos sus pedidos de inserción secundarios, elementos de línea, campañas, creativos, píxeles de conversión y segmentos. Las eliminaciones son permanentes y no se pueden revertir. Aunque los objetos eliminados siguen estando disponibles en los informes, ya no tendrá visibilidad sobre su configuración específica, como el presupuesto de ingresos para los artículos de línea, el presupuesto de costos y la segmentación de campañas.

Campos JSON

Campo	Tipo	Descripción
`allow_safety_pacing`	booleano	solo Administración. Si `true`es , el gasto por minuto está limitado a un máximo del 1 % del presupuesto de duración y del 5 % del presupuesto diario.
`audience_size_check_state`	enumeración	Estado de la comprobación de validación del tamaño de la audiencia. Usamos un servicio externo proporcionado por Yield Analytics para confirmar que el tamaño de la audiencia cumple nuestros criterios para la segmentación de artículos de línea definidos por la oferta de Netflix. Posibles valores: - `passed` - `failed` - `in_progress` - `unchecked` Nota: Este campo solo está visible para el elemento de línea definida por la oferta de Netflix.
`audience_size_check_last_run`	Timestamp	Marca de tiempo de la última vez que se realizó la comprobación de validación del tamaño de la audiencia, que es cuando el estado cambió a `passed` o `failed`. Nota: Este campo solo está visible para el elemento de línea definida por la oferta de Netflix.
`billing_address1`	string (100)	Como referencia.
`billing_address2`	string (100)	Como referencia.
`billing_city`	string (100)	Como referencia.
`billing_country`	string (100)	Como referencia.
`billing_internal_user`	matriz	Como referencia. Esta es una lista de personas (cadenas) que trabajan en este anunciante.
`billing_name`	string (50)	Como referencia. El valor puede ser un máximo de 50 caracteres.
`billing_phone`	string (20)	Como referencia.
`billing_state`	string (100)	Como referencia.
`billing_zip`	string (25)	Como referencia.
`code`	string (100)	Un código personalizado para el anunciante. Xandr asignará un identificador único, pero los anunciantes pueden usar su propio sistema de identificación. En `"code"` otros servicios se permitirán los campos o el identificador asignado por Xandr.
`legal_entity_name`	string (255)	Representa a la entidad jurídica en cuyo nombre se muestra el anuncio y quién cubre el costo del anuncio del anunciante. Este campo se utiliza en las respuestas a la oferta con el fin de cumplir con la Ley de Servicios Digitales (DSA) de la Unión Europea.
`competitive_brands`	matriz	Matriz de identificadores de marca. 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. Para obtener más información sobre las marcas de nuestro sistema, consulte el Servicio de marca.
`competitive_categories`	matriz	Matriz de identificadores de categoría. Las creatividades asociadas a las categorías de esta matriz no servirán juntas en `/mtj` subastas, por ejemplo, `"Dating"` y `"Education"`. Para obtener más información sobre las categorías que aplicamos a los creativos (y las marcas), consulte el Servicio de categorías.
`control_pct`	double	Porcentaje de usuarios en el grupo de control de este anunciante. Esto debe expresarse como un número entre `0` y `1`, ambos inclusive. A estos usuarios se le mostrará un creativo de control con el fin de medir la eficacia de otras creatividades. Para obtener más información, vea Test and Control Targeting (Standard Line Item) en la documentación de la interfaz de usuario.
`daily_budget`	double	Presupuesto diario para el anunciante. (Vea `lifetime_budget` a continuación).
`daily_budget_imps`	Entero	El presupuesto diario de impresiones para el anunciante. (Vea `lifetime_budget` a continuación).
`default_brand`	object	Información sobre la marca predeterminada. Consulte Marca predeterminada a continuación para obtener más detalles. Valor predeterminado: `null`
`default_brand_id`	Entero	El identificador interno de la marca predeterminada para todas las creatividades de este anunciante. La marca de cada creatividad se comprobará durante el proceso de auditoría.
`default_category`	object	Esta característica no funciona en este momento. Se usará en el desarrollo futuro.
`default_currency`	string (3)	Moneda predeterminada que se usará para el anunciante. Este será un código de tres letras que puede recuperar del servicio de moneda de solo lectura. Consulte Compatibilidad con monedas en la documentación de la interfaz de usuario para obtener más información sobre el concepto. Nota: Como procedimiento recomendado, alinee la moneda con la moneda de facturación para lograr la mejor experiencia de moneda local posible. Valor predeterminado: moneda predeterminada del miembro
`enable_pacing`	booleano	Si `true`es , los gastos se aplicarán a este anunciante a lo largo del día.
`enable_political_io_by_default`	booleano	Valores posibles: `0` o `1`. Si se establece en `true`, los pedidos de inserción creados para este anunciante mediante la interfaz de usuario tendrán habilitada la publicidad política de forma predeterminada. Esto no afecta a los pedidos de inserción creados mediante la API. Valor predeterminado: `1` (true)
`id`	Entero	El identificador del anunciante. Solo lectura Obligatorio activado: `PUT` Valor predeterminado: número incrementado automáticamente
`is_malicious`	booleano	solo Administración. Si `true`es , el estado del anunciante se establecerá en inactivo. Los administradores de Xandr establecerán este campo `true` en para los anunciantes que se determine que dirigen a los usuarios a páginas de aterrizaje malintencionadas. Los usuarios no podrán volver a establecer el estado del anunciante en activo hasta que un administrador de Xandr vuelva a establecer el `is_malicious` campo en `false`. Valor predeterminado: `false`
`is_mediated`	booleano	solo Administración. Si `true`es , el anunciante no se mostrará en la interfaz de usuario. Los administradores de Xandr pueden establecer este campo `true` en cuando el anunciante está asociado a una oferta mediada. Valor predeterminado: `false`
`is_running_political_ads`	booleano	Valores posibles: `0` o `1`. Declara si este anunciante lleva a cabo o no publicidad política (definida como publicidad relacionada con una elección, iniciativa de votación o candidato político, en el Estados Unidos). Si un anunciante existente ya tiene pedidos de inserción con publicidad política habilitada, no podrá establecer `is_running_political_adsfalse`en . Valor predeterminado: `0` (false)
`labels`	matriz	Las etiquetas opcionales aplicadas al anunciante. Actualmente, hay tres etiquetas disponibles para los anunciantes: - `"Salesperson"` - `"Account Manager"` - `"Advertiser Type"`. Consulte Etiquetas a continuación para obtener más detalles. Nota: Puede informar sobre las etiquetas de anunciante con el informe de Network Analytics . Por ejemplo, si usa la etiqueta "Salesperson" para especificar el nombre del vendedor responsable de cada anunciante, puede ejecutar el informe de Network Analytics filtrado por `"salesperson_for_advertiser"` para centrarse en los anunciantes de los que un vendedor determinado es responsable o agrupado para `"salesperson_for_advertiser"` clasificar el rendimiento de sus vendedores.
`last_modified`	Timestamp	Marca de tiempo de la última vez que se modificó este anunciante.
`lifetime_budget`	double	Puedes establecer todos los parámetros presupuestados en el nivel de anunciante, así como los niveles de compra de campañas y medios. Los presupuestos en el nivel de anunciante se aplicarán a todo el tráfico de su anunciante. Se trata de un presupuesto en dólares (costo multimedia).
`lifetime_budget_imps`	Entero	El presupuesto de impresiones de duración para el anunciante. (Vea `lifetime_budget` lo anterior).
`name`	string (255)	Nombre del anunciante. Obligatorio activado: `POST`
`object_stats`	object	Número de pedidos de inserción totales, activos e inactivos, artículos de línea, campañas y creatividades bajo el anunciante, así como el número de creativos con estados de auditoría determinados. Para incluir este objeto en una `GET` respuesta, pase `object_stats=true` la cadena de consulta. Solo lectura.
`partner_fees`	matriz	Una matriz de tarifas de partner aplicadas a este anunciante. Puede crear, adjuntar, ver o quitar tarifas de asociados con el Servicio de cuotas de asociados.
`profile_id`	Entero	Puede establecer un valor opcional `profile_id` en los niveles anunciante, artículo de línea, campaña y creatividad. Un perfil es un conjunto genérico de reglas para el inventario de destino. Un perfil establecido en el nivel de anunciante se aplicará a todo el tráfico de tu anunciante, por lo que probablemente querrás mantener este perfil muy amplio. Las llamadas a anuncios deben pasar todos los perfiles de destino en cualquier nivel. Consulte profile service para obtener más información.
`remarketing_segment_id`	Entero	Un segmento se marca como "remarketing" solo con fines de informes y filtrado. Si marca un segmento como de remarketing en la interfaz de usuario, se mostrará aquí. O bien, puede agregar identificadores de segmento aquí y se marcarán como remarketing con fines de informes.
`state`	enumeración	Estado del anunciante. Valores posibles: `"active"` o `"inactive"`. Valor predeterminado: `"active"`
`stats`	object	El `stats` objeto ha quedado en desuso (a partir del 17 de octubre de 2016). Use el servicio de informes para obtener información estadística en su lugar.
`timezone`	enumeración	La zona horaria del anunciante. Consulte Zonas horarias de API para obtener más información y valores aceptados. Para obtener más información sobre cómo hacer que la zona horaria del anunciante "se reduzca" a objetos secundarios, vea Zona horaria para objetos dependientes a continuación. Valor predeterminado: `"EST5EDT"`o la zona horaria del miembro.
`thirdparty_pixels`	matriz	Matriz de píxeles de terceros asociados al anunciante. Puede adjuntar automáticamente estos píxeles a todas las creatividades propiedad de este anunciante mediante el servicio Pixel de terceros o adjuntarlos individualmente en el nivel creativo mediante el Servicio creativo. Solo lectura. Valor predeterminado: `null`
`time_format`	enumeración	Formato en el que desea ver las horas mostradas en la interfaz de usuario. Valores posibles: `"12-hour"` o `"24-hour"`. Valor predeterminado: `"12-hour"`
`use_insertion_orders`	booleano	Si `true`es , el uso de pedidos de inserción que contienen colecciones de artículos de línea, se habilitará para este anunciante. No podrá crear pedidos de inserción, si este campo está establecido en `"false"`. Consulte el servicio de pedido de inserción para obtener más información. PRECAUCIÓN: Elementos de línea preexistedos Si establece este campo en `true` y ya ha creado elementos de línea antes de habilitar esta configuración, esos elementos de línea dejarán de gastar. Para permitir que esos elementos de línea continúen con el gasto, cree un pedido de inserción (mediante el servicio de pedido de inserción) y asocie los elementos de línea con el orden de inserción (mediante el servicio de elementos de línea). Todos los elementos de línea recién creados requerirán un orden de inserción. Nota: Cuando el anunciante tenga pedidos de inserción asociados, no podrá actualizar el valor de `"use_insertion_orders"` a `false`. Valor predeterminado: `true`

Píxeles de terceros

La thirdparty_pixels matriz contiene campos de la tabla siguiente. Estos campos son de solo lectura. Para actualizar o crear píxeles de terceros o adjuntar píxeles de terceros a todas las creatividades propiedad del anunciante, use el servicio Pixel de terceros. Para adjuntar píxeles de terceros a creatividades individuales, use el Servicio creativo.

Campo	Tipo	Descripción
`active`	booleano	Estado actual del píxel (`true = active`). Solo lectura.
`audit_statu`s	string	Estado de auditoría del píxel. Solo lectura.
`id`	Entero	Identificador del píxel. Solo lectura.
`name`	string	Nombre completo del píxel. Solo lectura.

Estadísticas

El stats objeto ha quedado en desuso (a partir del 17 de octubre de 2016). Use el servicio de informes para obtener información estadística en su lugar.

Etiquetas

Puede usar el Servicio de etiquetas de solo lectura para ver todas las etiquetas posibles para anunciantes, pedidos de inserción, artículos de línea, campañas y publicadores. Este servicio permite ver las etiquetas que ya se aplican a los objetos.

Campo	Tipo (longitud)	Description
`id`	Entero	Identificador de la etiqueta. Posibles valores: `1` (Vendedor) `3` (Administrador de cuentas) `12` (Tipo de anunciante).
`name`	enumeración	Nombre de la etiqueta. Posibles valores: - `"Salesperson"` - `"Account Manager"` - `"Advertiser Type"`. Solo lectura.
`value`	string (100)	Valor asignado a la etiqueta. Por ejemplo, para la `"Salesperson"` etiqueta, podría ser un nombre como `"Michael Sellers"`.

Paginación

Puede solicitar un determinado número de objetos a través de estos campos:

"count": 8,
    "start_element": null,
    "num_elements": null

Campo	Tipo	Description
`count`	Entero	¿Cuántos objetos hay en este servicio? Por ejemplo, 8 anunciantes.
`num_elements`	Entero	¿Cuántos elementos devolver? Por ejemplo, comience en el objeto 4 y devuelva 3 objetos, o bien 4, 5, 6.
`start_element`	Entero	Número en el que se va a empezar a contar.

Marca predeterminada

Campo	Tipo	Description
`category_id`	Entero	Identificador de la categoría de la marca.
`id`	Entero	El identificador de la marca.
`name`	string	Nombre de la marca.

Zona horaria para objetos dependientes

Cuando cambias la zona horaria de un anunciante, puedes elegir si quieres hacer que el cambio "se desgajo" a objetos secundarios (campañas, artículos de línea y creativos). Para ello, debe pasar set_child_timezone=true la cadena de consulta de la dirección URL durante la solicitud para crear o actualizar la zona horaria.

Por ejemplo:

$ curl -b cookies -X PUT -d @advertiser 'https://api.appnexus.com
/advertiser?id=111&set_child_timezone=true'

Si truees , la zona horaria de todos los objetos secundarios se establece en la zona horaria del anunciante. Tenga en cuenta que cualquier configuración de zona horaria en objetos de nivel inferior (por ejemplo, pedidos de inserción, artículos de línea, campañas) se invalidará con la zona horaria del anunciante.
Si falsees , la zona horaria solo se establece en el anunciante.

Ejemplos

Adición de un anunciante

$ cat advertiser.json

{
   "advertiser":
   {
      "name":"Advertiser B",
      "legal_entity_name":"Toyota UK",
      "state":"active"
   }
}

$ curl -b cookies -c cookies -X POST --data-binary @advertiser.json 'https://api.appnexus.com/advertiser'

{
   "response":{
      "status":"OK",
      "id":51
   }
}

Actualización de un anunciante

$ cat advertiser_update

{
   "advertiser":
   {
      "name":"Advertiser B",
      "legal_entity_name":"Toyota UK",
      "state":"active",
      "code":"PSS"
   }
}

$ curl -b cookies -c cookies -X PUT --data-binary @advertiser_update 'https://api.appnexus.com/advertiser?id=51'

{
   "response":{
      "status":"OK",
      "id":492
   }
}

Ver todos los anunciantes

$ curl -b cookies -c cookies 'https://api.appnexus.com/advertiser'

{
  "response": {
    "status": "OK",
    "advertisers": [
      {
        "id": 51,
        "code": null,
        "name": "Advertiser B",
        "legal_entity_name":"Toyota France",
        "state": "active",
        "default_brand_id": 0,
        "remarketing_segment_id": null,
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "enable_pacing": true,
        "profile_id": null,
        "thirdparty_pixels": [
          {
            "id":145,
            "name":"sample pixel",
            "audit_status":"pending",
            "active":true
          },
          {
            "id":314,
            "name":"another sample pixel",
            "audit_status":"pending",
            "active":true
          }
        ],
        "control_pct": 0,
        "timezone": "EST5EDT",
        "last_modified": "2010-08-03 23:07:02",
        "stats": null,
        "billing_internal_user": null,
        "billing_address1": "123 Happy Street",
        "billing_address2": "",
        "billing_city": "New York",
        "billing_state": "NY",
        "billing_country": "US",
        "billing_zip": "10011",
        "default_category": null,
        "default_currency": "USD",
        "labels": null,
        "use_insertion_orders": false,
        "time_format": "12-hour",
        "default_brand": null,
        "is_malicious": false
      },
      {
        "id": 493,
        "code": null,
        "name": "Cheese Club",
        "legal_entity_name":"Toyota Germany",
        "state": "active",
        "default_brand_id": 0,
        "remarketing_segment_id": 11111,
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "enable_pacing": true,
        "profile_id": null,
        "thirdparty_pixels":null,
        "control_pct": 0,
        "timezone": "EST5EDT",
        "last_modified": "2010-09-15 21:02:37",
        "stats": null,
        "billing_internal_user": null,
        "billing_address1": null,
        "billing_address2": null,
        "billing_city": null,
        "billing_state": null,
        "billing_country": null,
        "billing_zip": null,
        "default_category": null,
        "default_currency": "USD",
        "labels": null,
        "use_insertion_orders": false,
        "time_format": "12-hour",
        "default_brand": null,
        "is_malicious": false
      }
    ],
    "count": 5,
    "start_element": null,
    "num_elements": null,
    "dbg_info": {
      ...
    }
  }
}

Visualización de un anunciante específico

$ curl -b cookies -c cookies 'https://api.appnexus.com/advertiser?id=51'

{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":0,
        "num_elements":100,
        "advertiser":{
            "id":51,
            "code":null,
            "name":"Advertiser A",
            "legal_entity_name":"Toyota UK",
            "state":"active",
            "default_brand_id":0,
            "remarketing_segment_id":null,
            "profile_id":null,
            "control_pct":0,
            "timezone":"EST5EDT",
            "last_modified":"2010-05-06 20:21:56",
            "member_id":79,
            "billing_name":null,
            "billing_phone":null,
            "billing_address1":null,
            "billing_address2":null,
            "billing_city":null,
            "billing_state":null,
            "billing_country":null,
            "billing_zip":null,
            "default_currency":"USD",
            "use_insertion_orders":false,
            "time_format":"12-hour",
            "is_malicious":false,
            "billing_internal_user":null,
            "default_category":null,
            "default_brand":null,
            "labels":null,
            "competitive_brands":null,
            "competitive_categories":null,
            "lifetime_budget":null,
            "lifetime_budget_imps":null,
            "daily_budget":null,
            "daily_budget_imps":null,
            "enable_pacing":null,
            "lifetime_pacing":null,
            "lifetime_pacing_span":null,
            "allow_safety_pacing":null,
            "stats":null
      }
   }
}

Compartir a través de