Servicio de ajuste

Artículo
05/17/2024

Nota:

Este servicio está disponible actualmente para un conjunto limitado de clientes y empleados de Microsoft.

Estos documentos (y la característica relacionada) solo son visibles para seleccionar clientes. No envíe vínculos a estos documentos ni mencione esta característica a los clientes a menos que haya confirmado que deben tener acceso.

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

Tipos de ajuste

Actualmente puede realizar tres tipos de ajustes de informes:

Ajustes del anunciante

advertiser_revenue - Este tipo de ajuste cambia los ingresos reservados y/o las impresiones, clics y conversiones que ves en los informes de un anunciante y ajusta el pago de los costos multimedia a los editores de revshare. Consulte el primer ejemplo siguiente 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 reservados y/o las impresiones, clics y conversiones que ves en los informes de un anunciante. No ajusta el pago de los costos multimedia a los editores de revshare.

Ajustes del publicador

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

Estado de 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 los ajustes se procesen, los objetos asociados deben estar activos. Por ejemplo, si un elemento de línea está inactivo, no se ejecutarán los trabajos de ajuste asociados.

El estado puede ser uno de los siguientes valores:

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

API de REST

Http (método)	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	Description
`adjustment_type`	enumeración	Valor predeterminado: `"advertiser_revenue"` 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 multimedia pagado por la red al publicador.
`created_on`	datetime	Fecha y hora en que se creó la solicitud de ajuste.
`end_date`	datetime	Valor predeterminado: `Yesterday` 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 (es decir, 123) Obligatorio activado: `PUT`, en la cadena de consulta. Identificador único del ajuste.
`last_modified`	datetime	Fecha y hora en que se modificó por última vez la solicitud de ajuste.
`member_id`	Entero	Identificador del miembro propietario del ajuste.
`notes`	string	Nota opcional para asociar con este ajuste.
`start_date`	datetime	Obligatorio activado: `POST` 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 el procesamiento si tienen un `start_date` plazo de 90 días a partir del momento en que se intenta ejecutar el ajuste.
`status`	enumeración	Valor predeterminado: `"new"` Estado de procesamiento actual para el ajuste. Posibles valores: - `"new"` - `"processing"` - `"propagating"` - `"pending"` - `"completed"` - `"failed"` - `"cancelled"`.
`timezone`	string	Valor predeterminado: zona horaria de miembro predeterminada Zona horaria en la que se realizará el ajuste. Los ajustes se realizarán a la primera hora del día de la zona horaria determinada. Para obtener una lista de valores de zona horaria aceptables, consulte Zonas horarias de API.
`user_id`	Entero	Identificador del usuario que realizó el ajuste.

Ajustes del anunciante

Campo	Tipo	Description
`booked_revenue`	double	Los nuevos ingresos reservados pagados por el anunciante a la red durante el período de ajuste dado (`start_date` a `end_date`). Si se establece en `null` o se deja en blanco, los ingresos reservados no se cambiarán.
`clicks`	Entero	Valor opcional para el número de clics durante el período de ajuste. Tenga en cuenta que el cambio del número de clics en un elemento de línea de CPC no afectará a los ingresos reservados del artículo de línea. Si se establece en `null` o se deja en blanco, no se cambiarán los clics.
`delete_overlapping_adjustments`	booleano	Valor predeterminado: `true`, si `adjustment_type` es `"advertiser_revenue"` Si `true`es , se eliminarán los ajustes anteriores a la misma línea de pedido dentro de la fecha de inicio/finalización del ajuste actual antes de aplicar el ajuste.
`imps`	Entero	Valor opcional para el número de impresiones durante el período de ajuste. Tenga en cuenta que el cambio del número de imps en un elemento de línea de CPM no afectará a los ingresos reservados del artículo de línea. Para cambiar el pago del anunciante a la red, debes establecerlo `booked_revenue` por separado. Si se establece en `null` o se deja en blanco, los imps no se cambiarán.
`line_item_id`	Entero	Obligatorio activado: `POST`, si `adjustment_type` es `"advertiser_revenue"` o `"advertiser_credit"`. Identificador del elemento de línea que se va a ajustar.
`post_click_convs`	Entero	Valor opcional para el número de conversiones de clic posteriores durante el período de ajuste. Tenga en cuenta que el cambio del número de conversiones de clic posteriores en un elemento de línea de CPA no afectará a los ingresos reservados del artículo de línea. Si se establece en o se deja `null` en blanco, no se cambiarán las conversiones de clic posteriores.
`post_view_convs`	Entero	Valor opcional para el número de conversiones posteriores a la vista durante el período de ajuste. Tenga en cuenta que el cambio del número de conversiones posteriores a la vista en un elemento de línea de CPA no afectará a los ingresos reservados del artículo de línea. Si se establece en `null` o se deja en blanco, no se cambiarán las conversiones posteriores a la vista.

Ajustes del publicador

Campo	Tipo	Descrito
`clicks`	Entero	Valor opcional para el número de clics durante el período de ajuste.
`country`	string	Código de dos letras para el país para el que se ajustarán los datos de impresión.
`height`	Entero	Alto de las ubicaciones para las que se ajustarán los datos.
`imp_types`	string	Valor predeterminado: `"kept"` Tipos de impresiones para las que se ajustarán los datos. Posibles valores: - `"default"`: una creatividad predeterminada que se sirve porque ninguna oferta de campaña o ninguna otra creatividad era apta. - `"kept"`: uno de los anunciantes administrados sirvió a un creativo. - `"resold"`: la impresión se vendió a un comprador de terceros.
`imps`	Entero	Valor opcional para el número de impresiones durante el período de ajuste.
`media_cost`	Dinero	El nuevo costo multimedia pagado por la red al publicador durante el período de ajuste especificado (`start_date` a `end_date`). Si se establece en o se deja `null` en blanco, no se cambiará el costo multimedia.
`media_type`	object	Tipo de medio para el que se ajustarán los datos. Posibles valores: - `"banner"` - `"pop"` - `"text"` - `"interstitial"` - `"expandable"` - `"video"`.
`placement_id`	Entero	Obligatorio activado: `POST`, si `adjustment_type` es `"publisher"`. Identificador de la ubicación para la que se ajustarán los datos.
`post_click_convs`	Entero	Valor opcional para el número de conversiones de clic posteriores durante el período de ajuste.
`post_view_convs`	Entero	Valor opcional para el número de conversiones posteriores a la vista durante el período de ajuste.
`publisher_id`	Entero	Identificador del publicador para el que se ajustarán los datos.
`site_id`	Entero	Identificador del sitio para el que se ajustarán los datos.
`width`	Entero	Ancho de las ubicaciones para las que se ajustarán los datos.

Ejemplos

Ajuste de los ingresos del anunciante y el recuento de impresiones con atribución a los publicadores

En "advertiser_revenue" el caso de 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 proporcionadas por un editor.

Nota:

El anunciante ejecuta un artículo de línea de CPM de 1 USD.
Xandr registra 10 000 impresiones y 10 USD de ingresos reservados para este artículo de línea, servidos en tres publicadores.
El anunciante registra 9000 impresiones y ofrece pagar 9 USD.

Informe antes del ajuste

Elemento de línea del anunciante	Publisher	Regla de pago	Impresiones	Ingresos reservados	Costo de medios
Elemento de línea de CPM de $1	Publicador 1	Regla de pago de 60% revshare	1,000	1,00 USD	0,60 USD
Elemento de línea de CPM de $1	Publicador 2	Regla de pago de 60% revshare	5,000	$5.00	$3.00
Elemento de línea de CPM de $1	Publicador 3	Regla de pago de CPM de 0,50 USD	1,000	1,00 USD	$0.50
Elemento de línea de CPM de $1	Publicador 4	Regla de pago del 70 % de revshare	3,000	$3.00	$2.10

Para ajustar los ingresos a 9 USD y las impresiones a 9000 para el elemento de línea, cree y POST el 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'

Informe después del ajuste

Elemento de línea del anunciante	Publisher	Regla de pago	Impresiones ajustadas	Ingresos reservados ajustados	Costo de medios ajustado
Elemento de línea de CPM de $1	Publicador 1	Regla de pago de 60% revshare	1,000	0,90 USD	0,54 USD
Elemento de línea de CPM de $1	Publicador 2	Regla de pago de 60% revshare	5,000	$4.50	$2.70
Elemento de línea de CPM de $1	Publicador 2	Regla de pago de CPM de 0,50 USD	1,000	0,90 USD	$0.50
Elemento de línea de CPM de $1	Publicador 3	Regla de pago del 70 % de revshare	3,000	$2.70	$1.89
Elemento de línea de CPM de $1	-	-	-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 publicador. Sin embargo, esta fila no aparecerá en los informes ejecutados por anunciantes porque no pueden agrupar por publicador.
El costo de los medios no se ajusta para los editores pagados sobre una base cpm, ni para los pagos a otros miembros de la plataforma.

Ajuste de los ingresos e impresiones de publicidad, el número de 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..."
   }
}

Ajuste del costo multimedia del publicador y el recuento de impresiones para las ubicaciones que se proporcionan con creativos

Informe antes del ajuste

Publisher	Site	Ubicación	Regla de pago	País	Size	Tipo de medio	Tipo de pago	Costo de medios	Duendes
NY Post	Business	Página principal	$1 CPM	EE. UU.	728x90	Banner	CPM propietario	1	1000
NY Post	Business	Página principal	$1 CPM	CA	728x90	Banner	CPM propietario	0.5	500
NY Post	Business	Pop de página principal	$10 CPM	EE. UU.	0x0	Popup	CPM propietario	10	1000
NY Post	Business	Página principal	$2 CPM	EE. UU.	300x250	Banner	CPM propietario	2	1000
NY Post	Business	Página principal	60 % de revshare	GB	300x250	Banner	Propietario Revshare	1.25	500

Para ajustar el costo multimedia a 10 USD y las impresiones a 3500, cree y POST el 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'

Informe después del ajuste

Identificador de ajuste	Publisher	Site	Ubicación	Regla de pago	País	Size	Tipo de medio	Tipo de pago	Costo de medios	Duendes
0	NY Post	Business	Página principal	$1 CPM	EE. UU.	728x90	Banner	CPM propietario	1	1000
1	NY Post	Business	Página principal	$1 CPM	EE. UU.	728x90	Banner	CPM propietario	-0.322033898305085	-125
0	NY Post	Business	Página principal	$1 CPM	CA	728x90	Banner	CPM propietario	0.5	500
1	NY Post	Business	Página principal	$1 CPM	CA	728x90	Banner	CPM propietario	-0.161016949152542	-62.5
0	NY Post	Business	Pop de página principal	$10 CPM	EE. UU.	0x0	Popup	CPM propietario	10	1000
1	NY Post	Business	Pop de página principal	$10 CPM	EE. UU.	0x0	Popup	CPM propietario	3.22033898305085	-125
0	NY Post	Business	Página principal	$2 CPM	EE. UU.	300x250	Banner	CPM propietario	2	1000
1	NY Post	Business	Página principal	$2 CPM	EE. UU.	300x250	Banner	CPM propietario	-0.64406779661017	-125
0	NY Post	Business	Página principal	60 % de revshare	GB	300x250	Banner	Propietario Revshare	1.25	500
1	NY Post	Business	Página principal	60 % de revshare	GB	300x250	Banner	Propietario Revshare	-0.402542372881356	-62.5

Cancelación de un ajuste

Puede cancelar los ajustes que tienen 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'

Visualización de 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
            },
            ...
        ]
    }
}

Compartir a través de

Servicio de ajuste

Tipos de ajuste

Ajustes del anunciante

Ajustes del publicador

Estado de ajuste

API de REST

Campos JSON

General

Ajustes del anunciante

Ajustes del publicador

Ejemplos

Ajuste de los ingresos del anunciante y el recuento de impresiones con atribución a los publicadores

Ajuste de los ingresos e impresiones de publicidad, el número de clics y conversiones sin atribución a los editores

Ajuste del costo multimedia del publicador y el recuento de impresiones para las ubicaciones que se proporcionan con creativos

Cancelación de un ajuste

Visualización de todos los ajustes

Recursos adicionales