Servicio de ajuste

Nota:

Actualmente, este servicio solo está disponible para un conjunto limitado de clientes y empleados de Microsoft.

Estos documentos (y la característica relacionada) solo son visibles para clientes seleccionados. No envíes vínculos a estos documentos ni menciones esta característica a los clientes a menos que hayas confirmado que deberían tener acceso.

El servicio de ajuste se usa para realizar cambios en los ingresos reservados y los valores del coste multimedia en los informes.

Tipos de ajuste

Actualmente, puede realizar tres tipos de ajustes en los informes:

Ajustes del anunciante

  • advertiser_revenue - Este tipo de ajuste cambia los ingresos registrados y/o las impresiones, los clics y las conversiones que ves en los informes de un anunciante y ajusta el pago del coste de los medios a los editores de revshare. Consulte el primer ejemplo a continuación para obtener más detalles sobre cómo se ajusta el pago a los editores de revshare.
  • advertiser_credit - Este tipo de ajuste cambia los ingresos o las impresiones, los clics y las conversiones que se ven en los informes de un anunciante. No ajusta el pago del costo de sus medios a los editores de revshare.

Ajustes del editor

"publisher" - Este tipo de ajuste cambia el coste multimedia o las impresiones, los clics y las conversiones que se ven en los informes de un editor.

Estado del ajuste

Los ajustes se aplican de forma asincrónica a los informes y aparecerán varias horas desde el momento en que se crean. El servicio de ajuste proporciona una interfaz para comprobar el estado actual de un ajuste.

Nota:

Para que se procesen los ajustes, los objetos asociados deben estar activos. Por ejemplo, si una línea de pedido está inactiva, no se ejecutarán los trabajos de ajuste asociados.

El estado puede ser uno de los siguientes valores:

Estado Descripción
new Se ha introducido el ajuste en el sistema.
pending El ajuste se ha recogido para su procesamiento.
processing Se está procesando el ajuste.
propagating El ajuste se ha completado y se está propagando a las memorias caché de informes.
completed El ajuste está completo y debería estar disponible en los informes.
failed Error al procesar el ajuste.
cancelled Ajuste cancelado por el usuario.

API de REST

Método HTTP Endpoint Description
POST https://api.appnexus.com/adjustment Para agregar un nuevo ajuste
PUT https://api.appnexus.com/adjustment?id=ADJUSTMENT_ID Para modificar o cancelar un ajuste existente:
GET https://api.appnexus.com/adjustment Para ver todos los ajustes:
GET https://api.appnexus.com/adjustment?advertiser_id=ADVERTISER_ID Para ver todos los ajustes de un anunciante:
GET https://api.appnexus.com/adjustment?id=ADJUSTMENT_ID Para ver un ajuste específico:
GET https://api.appnexus.com/adjustment?state=new,processing,propagating,pending,completed,failed,cancelled Para ver todos los ajustes en un estado determinado:
GET https://api.appnexus.com/adjustment?like_start_date=START_DATE&like_end_date=END_DATE Para ver todos los ajustes dentro de un período de tiempo determinado:

Campos JSON

General

Campo Tipo Descripción
adjustment_type enumeración Valor predeterminado: "advertiser_revenue"

El tipo de ajuste. Posibles valores:
- "advertiser_revenue" - Ajusta la cantidad de ingresos del anunciante a la red y también vuelve a atribuir los pagos de revshare a los editores.
- "advertiser_credit" - Cambia solo la cantidad de ingresos del anunciante, pero no vuelve a atribuir los pagos del editor.
- "publisher" - Ajusta el costo de los medios pagados por la red al editor.
created_on datetime La fecha y hora en que se creó la solicitud de ajuste.
end_date datetime Valor predeterminado: Yesterday

La fecha de finalización del período de ajuste. Esto debe ser al menos 24 horas en el pasado.
id Entero Valor predeterminado: Número incrementado automáticamente (por ejemplo, 123)

Requerido el: PUT, en la cadena de consulta.

El identificador único del ajuste.
last_modified datetime La fecha y hora en que se modificó por última vez la solicitud de ajuste.
member_id Entero El identificador del miembro propietario del ajuste.
notes string Nota opcional para asociar con este ajuste.
start_date datetime Requerido en: POST

La fecha de inicio del ajuste. Los ajustes se aplicarán uniformemente en el intervalo de tiempo definido por start_date y .end_date

Los ajustes solo son aptos para su procesamiento si tienen un start_date plazo de 90 días desde el momento en que se intenta ejecutar el ajuste.
status enumeración Valor predeterminado: "new"

El estado de procesamiento actual para el ajuste. Posibles valores:
- "new"
- "processing"
- "propagating"
- "pending"
- "completed"
- "failed"
- "cancelled".
timezone string Valor predeterminado: Zona horaria predeterminada para miembros

La zona horaria en la que se realizará el ajuste. Se realizarán ajustes a la primera hora del día de la zona horaria especificada. Para obtener una lista de valores aceptables de zona horaria, consulte Zonas horarias de API.
user_id Entero El identificador del usuario que realizó el ajuste.

Ajustes del anunciante

Campo Tipo Descripción
booked_revenue double Los nuevos ingresos reservados pagados por el anunciante a la red durante el período de ajuste especificado (start_date a end_date). Si se establece o se deja en null blanco, los ingresos reservados no se cambiarán.
clicks Entero Valor opcional para el número de clics durante el período de ajuste. Ten en cuenta que cambiar el número de clics en una línea de pedido de CPC no afectará a los ingresos registrados de la línea de pedido. Si se establece o se deja en null blanco, los clics no se cambiarán.
delete_overlapping_adjustments booleano Valor predeterminado: true, si adjustment_type es "advertiser_revenue"

Si true, cualquier ajuste anterior al mismo elemento de línea dentro de la fecha de inicio o finalización del ajuste actual se eliminará antes de que se aplique el ajuste.
imps Entero Valor opcional para el número de impresiones durante el período de ajuste. Ten en cuenta que cambiar el número de diablillos en una línea de pedido de CPM no afectará a los ingresos registrados de la línea de pedido. Para cambiar el pago del anunciante a la red, debe establecerlo booked_revenue por separado. Si se establece o se deja en null blanco, los diablillos no se cambiarán.
line_item_id Entero Requerido en: POST, si adjustment_type es "advertiser_revenue" o "advertiser_credit".

El identificador del artículo de línea que se va a ajustar.
post_click_convs Entero Valor opcional para el número de conversiones posteriores a clics durante el período de ajuste. Ten en cuenta que cambiar el número de conversiones al publicar clics en una línea de pedido de CPA no afectará a los ingresos registrados de estas. Si se establece o se deja en null blanco, las conversiones al publicar clics no cambiarán.
post_view_convs Entero Valor opcional para el número de conversiones de visualización de publicaciones durante el período de ajuste. Ten en cuenta que cambiar el número de conversiones de vista de publicación en una línea de pedido de CPA no afectará a los ingresos registrados de la línea de pedido. Si se establece o se deja en null blanco, las conversiones de vista de publicación no se cambiarán.

Ajustes del editor

Campo Tipo Se describe
clicks Entero Valor opcional para el número de clics durante el período de ajuste.
country string El código de dos letras del país o región para el que se ajustarán los datos de impresiones.
height Entero La altura de las ubicaciones para las que se ajustarán los datos.
imp_types string Valor predeterminado: "kept"

Los tipos de impresiones para los que se ajustarán los datos. Posibles valores:
- "default": una creatividad predeterminada publicada porque ninguna puja de campaña o ninguna otra creatividad era apta.
- "kept": uno de sus anunciantes administrados publicó una creatividad.
- "resold": La impresión se vendió a un comprador externo.
imps Entero Valor opcional para el número de impresiones durante el período de ajuste.
media_cost dinero El costo de los nuevos medios pagado por la red al editor durante el período de ajuste dado (start_date a end_date). Si se establece o se deja en null blanco, el costo de los soportes no se modificará.
media_type objeto El tipo de medio para el que se ajustarán los datos. Posibles valores:
- "banner"
- "pop"
- "text"
- "interstitial"
- "expandable"
- "video".
placement_id Entero Requerido en: POST, si adjustment_type es "publisher".

Id. del emplazamiento para el que se ajustarán los datos.
post_click_convs Entero Valor opcional para el número de conversiones posteriores a clics durante el período de ajuste.
post_view_convs Entero Valor opcional para el número de conversiones de visualización de publicaciones durante el período de ajuste.
publisher_id Entero El identificador del publicador para el que se ajustarán los datos.
site_id Entero El identificador del sitio para el que se ajustarán los datos.
width Entero El ancho de las ubicaciones para las que se ajustarán los datos.

Ejemplos

Ajustar los ingresos de los anunciantes y el recuento de impresiones con atribución a editores

Para "advertiser_revenue" los ajustes, la atribución de los ajustes de ingresos reservados a los editores de revshare se realiza proporcionalmente en función del número de impresiones servidas por un editor.

Nota:

  • El anunciante ejecuta una línea de pedido de CPM de 1 $.
  • Xandr registra 10 000 impresiones e ingresos reservados de 10 $ para esta partida, servida en 3 editoriales.
  • El anunciante registra 9.000 impresiones y ofrece pagar 9 dólares.

Informe antes del ajuste

Línea de pedido de anunciante Publisher Regla de pago Impresiones Ingresos reservados Costo de medios
Elemento de línea de CPM de 1 USD Editor 1 Regla de pago de Revshare del 60% 1,000 $1.00 0,60 USD
Elemento de línea de CPM de 1 USD Editor 2 Regla de pago de Revshare del 60% 5,000 $5.00 $3.00
Elemento de línea de CPM de 1 USD Editor 3 Regla de pago de 0,50 USD CPM 1,000 $1.00 $0.50
Elemento de línea de CPM de 1 USD Editor 4 Regla de pago de Revshare del 70% 3,000 $3.00 Precio $2.10

Para ajustar los ingresos a 9 $ y las impresiones a 9 000 para la línea de pedido, cree el POST siguiente archivo con formato JSON:

$ cat adjustment
  
{
   "adjustment": {
      "adjustment_type": "advertiser_revenue",
      "line_item_id": 4243,
      "booked_revenue": 9.00,
      "imps": 9000
      "start_date": "2011-01-01 00:00:00",
      "end_date": "2011-01-01 23:59:59",
      "note": "This is a note..."
   }
}
  
$ curl -b cookies -c cookies -X POST -d @adjustment 'https://api.appnexus.com/adjustment'

Informar después del ajuste

Línea de pedido de anunciante Publisher Regla de pago Impresiones ajustadas Adjusted Booked Revenue Costo de medios ajustado
Elemento de línea de CPM de 1 USD Editor 1 Regla de pago de Revshare del 60% 1,000 0,90 USD 0,54 USD
Elemento de línea de CPM de 1 USD Editor 2 Regla de pago de Revshare del 60% 5,000 Precio $4.50 Precio $2.70
Elemento de línea de CPM de 1 USD Editor 2 Regla de pago de 0,50 USD CPM 1,000 0,90 USD $0.50
Elemento de línea de CPM de 1 USD Editor 3 Regla de pago de Revshare del 70% 3,000 Precio $2.70 Precio $1.89
Elemento de línea de CPM de 1 USD - - -1,000 $0.00 $0.00

Nota:

  • Insertamos una fila adicional para los cambios en los recuentos de impresiones, clics o conversiones. Esta fila aparecerá en los informes de red al agrupar por Publisher. Sin embargo, esta fila no aparecerá en los informes que ejecuten los anunciantes porque no pueden agruparse por publicador.

  • El costo de los medios no se ajusta para los editores pagados sobre una base de cpm o para los pagos a otros miembros de la plataforma.

Ajustar los ingresos publicitarios y las impresiones, clics y conversiones sin atribución a los editores

$ cat adjustment
  
{
   "adjustment": {
      "adjustment_type": "advertiser_credit",
      "line_item_id": 4321,
      "booked_revenue": 100.00,
      "imps": 10000,
      "clicks": 10,
      "conversions": 1,
      "start_date": "2011-01-01 00:00:00",
      "end_date": "2011-01-01 23:59:59",
      "note": "This is a note..."
   }
}

Ajustar el coste multimedia del editor y el recuento de impresiones para las ubicaciones servidas con creatividades

Informe antes del ajuste

Publisher Site Ubicación Regla de pago País o región Size Tipo de medio Tipo de pago Costo de medios Diablillos
NY Post Business Página principal $1 CPM EE. UU. 728 x 90 Banner CPM del propietario 1 1000
NY Post Business Página principal $1 CPM CA 728 x 90 Banner CPM del propietario 0.5 500
NY Post Business Elemento emergente de la página principal $10 CPM EE. UU. 0x0 Ventana emergente CPM del propietario 10 1000
NY Post Business Página principal CPM de $2 EE. UU. 300x250 Banner CPM del propietario 2 1000
NY Post Business Página principal 60% Revshare ES 300x250 Banner Propietario: Revshare 1.25 500

Para ajustar el coste de los medios a 10 USD y las impresiones a 3500, cree el POST siguiente archivo con formato JSON:

$ cat adjustment
  
{
   "adjustment": {
      "adjustment_type": "publisher",
      "publisher_id": 23,
      "media_cost": 10.00,
      "imps": 3500,
      "start_date": "2011-01-01 00:00:00",
      "end_date": "2011-01-01 23:59:59",
      "note": "This is a note...",
      "imp_types": [
         "resold"
      ]
   }
}
  
$ curl -b cookies -c cookies -X POST -d @adjustment 'https://api.appnexus.com/adjustment'

Informar después del ajuste

ID de ajuste Publisher Site Ubicación Regla de pago País o región Size Tipo de medio Tipo de pago Costo de medios Diablillos
0 NY Post Business Página principal $1 CPM EE. UU. 728 x 90 Banner CPM del propietario 1 1000
1 NY Post Business Página principal $1 CPM EE. UU. 728 x 90 Banner CPM del propietario -0.322033898305085 -125
0 NY Post Business Página principal $1 CPM CA 728 x 90 Banner CPM del propietario 0.5 500
1 NY Post Business Página principal $1 CPM CA 728 x 90 Banner CPM del propietario -0.161016949152542 -62.5
0 NY Post Business Elemento emergente de la página principal $10 CPM EE. UU. 0x0 Ventana emergente CPM del propietario 10 1000
1 NY Post Business Elemento emergente de la página principal $10 CPM EE. UU. 0x0 Ventana emergente CPM del propietario 3.22033898305085 -125
0 NY Post Business Página principal CPM de $2 EE. UU. 300x250 Banner CPM del propietario 2 1000
1 NY Post Business Página principal CPM de $2 EE. UU. 300x250 Banner CPM del propietario -0.64406779661017 -125
0 NY Post Business Página principal 60% Revshare ES 300x250 Banner Propietario: Revshare 1.25 500
1 NY Post Business Página principal 60% Revshare ES 300x250 Banner Propietario: Revshare -0.402542372881356 -62.5

Cancelar un ajuste

Puede cancelar los ajustes que tengan el estado "new" o "pending".

$ cat modify_adjustment
  
{
   "adjustment": {
      "id": 5,
      "status": "cancelled"
   }
}
  
$ curl -b cookies -c cookies -X PUT -d @modify_adjustment 'https://api.appnexus.com/adjustment'

Ver todos los ajustes

$ curl -b cookies -c cookies 'https://api.appnexus.com/adjustment'
  
{
    "response": {
        "status": "OK",
        "count": 2,
        "start_element": 0,
        "num_elements": 100,
        "adjustments": [
            {
                "id": 5,
                "member_id": 294,
                "line_item_id": 2725,
                "timezone": "EST5EDT",
                "start_date": "2011-03-02 00:00:00",
                "end_date": "2011-03-04 23:59:59",
                "status": "completed",
                "adjustment_type": "advertiser_revenue",
                "booked_revenue": 100,
                "imps": 2000,
                "clicks": null,
                "post_click_convs": null,
                "post_view_convs": null,
                "notes": null,
                "created_on": "0000-00-00 00:00:00",
                "last_modified": "2011-03-15 17:56:40",
                "publisher_id": null,
                "site_id": null,
                "placement_id": null,
                "payment_rule_id": null,
                "width": null,
                "height": null,
                "country": null,
                "imp_type_kept": false,
                "imp_type_resold": false,
                "imp_type_default": false,
                "media_cost": null,
                "delete_overlapping_adjustments": false,
                "media_type": null,
                "user": null,
                "imp_types": null
            },
            {
                "id": 6,
                "member_id": 294,
                "line_item_id": 2725,
                "timezone": "EST5EDT",
                "start_date": "2011-03-02 00:00:00",
                "end_date": "2011-03-04 23:59:59",
                "status": "completed",
                "adjustment_type": "advertiser_revenue",
                "booked_revenue": 200,
                "imps": 1000,
                "clicks": null,
                "post_click_convs": null,
                "post_view_convs": null,
                "notes": null,
                "created_on": "0000-00-00 00:00:00",
                "last_modified": "2011-03-16 22:56:29",
                "publisher_id": null,
                "site_id": null,
                "placement_id": null,
                "payment_rule_id": null,
                "width": null,
                "height": null,
                "country": null,
                "imp_type_kept": false,
                "imp_type_resold": false,
                "imp_type_default": false,
                "media_cost": null,
                "delete_overlapping_adjustments": false,
                "media_type": null,
                "user": null,
                "imp_types": null
            },
            ...
        ]
    }
}