Servicio de regla de pago

Artículo
05/17/2024

Una regla de pago define los términos por los que una red paga a uno de sus publicadores administrados. Una red puede tener más de un conjunto de términos de pago con un publicador. Por ejemplo, el tráfico que se origina en determinadas áreas geográficas puede tener términos de acuerdo de distribución de ingresos diferentes.

Nota:

La segmentación de anunciantes, artículos de línea o campañas a través del Servicio de selección de ubicación invalidará cualquier segmentación de esos objetos a través de la opción opcional profile_idde este servicio.

API de REST

Nota:

publisher_code se puede usar en lugar de publisher_idy payment_rule_code se puede usar en lugar de publisher_rule_id para todas las llamadas siguientes.

Http (método)	Endpoint	Description
`POST`	`https://api.appnexus.com/payment-rule?publisher_id=PUBLISHER_ID` (JSON de regla de pago)	Agregue una nueva regla de pago.
`PUT`	`https://api.appnexus.com/payment-rule?id=PAYMENT_RULE_ID&publisher_id=PUBLISHER_ID` (JSON de regla de pago)	Modificar una regla de pago existente.
`GET`	`https://api.appnexus.com/payment-rule?publisher_id=PUBLISHER_ID`	Ver todas las reglas de pago de un publicador.
`GET`	`https://api.appnexus.com/payment-rule?id=PAYMENT_RULE_ID`	Ver una regla de pago específica para un publicador.
`GET`	`https://api.appnexus.com/payment-rule?id=1,2,3`	Vea varias reglas de pago por identificador mediante una lista separada por comas.
`DELETE`	`https://api.appnexus.com/payment-rule?id=PAYMENT_RULE_ID`	Eliminar una regla de pago.

Campos JSON

Campo	Tipo	Description
`id`	Entero	Identificador de esta regla de pago. Obligatorio activado: `PUT`, en la cadena de consulta
`code`	string	Código personalizado opcional que puede usar para hacer referencia a esta regla de pago. Valor predeterminado: `Null`
`name`	string	Nombre que se usa para describir esta regla de pago. Valor predeterminado: `None` Obligatorio activado: `POST`
`state`	enumeración	Estado de esta regla de pago. Valores posibles: `"active"` o `"inactive"`. Valor predeterminado: `"active"`
`description`	string	Una descripción opcional.
`start_date`	Timestamp	Fecha de inicio de esta regla. Valor predeterminado: `Immediately`
`end_date`	Timestamp	Fecha de finalización de esta regla. Valor predeterminado: `Indefinitely`
`pricing_type`	enumeración	Posibles valores: - `"revshare"` - Al editor se le paga un porcentaje de los ingresos del anuncio. - `"cpm"` - Al editor se le paga una tarifa plana por anuncio publicado. - `"dynamic"` - Los términos de pago se definen mediante un mínimo y un máximo de revshare y un eCPM objetivo. Valor predeterminado: `"revshare"` Obligatorio activado: `POST`
`cost_cpm`	double	Si `pricing_type` es `"cpm"`, esta es la cuota de CPM que se paga al publicador. Obligatorio activado: `POST`, si `pricing_type` es `"cpm"`
`revshare`	double	Si `pricing_type` es `"revshare"`, este es el porcentaje pagado al publicador. Si el tipo de precios es `"dynamic"`, este es el porcentaje mínimo de revshare pagado al publicador, con el máximo definido por `max_revshare`. El porcentaje debe expresarse como un número entre 0 y 1 (ambos inclusive), donde 1 es el 100 %. Obligatorio activado: `POST`, si `pricing_type` es `"revshare"` o `"dynamic"`
`profile_id`	Entero	Se usa un opcional `profile_id` para determinar cuándo aplicar una regla de pago. Un perfil es un conjunto genérico de reglas para el inventario de destino y algunas reglas de pago solo se pueden aplicar a determinados segmentos del inventario. Consulte profile service para obtener más información.
`priority`	Entero	Opcionalmente, puede proporcionar una prioridad que defina el nivel en el que debe aplicarse esta regla en relación con otras reglas de pago. Valor predeterminado: `5`
`timezone`	string	Zona horaria utilizada para calcular los datos de precios. Para obtener una lista de zonas horarias, consulte Zonas horarias de API. Valor predeterminado: `'EST5EDT'`
`last_modified`	Timestamp	Hora de la última modificación de esta regla de pago.
`filtered_advertisers`	matriz de objetos	Lista de anunciantes a los que le gustaría aplicar la acción especificada por `demand_filter_action` . Consulta Anunciantes filtrados a continuación.
`filtered_line_items`	matriz de objetos	Lista de elementos de línea a los que desea aplicar la acción especificada por `demand_filter_action` . Vea Elementos de línea filtrados a continuación.
`filtered_campaigns`	matriz de objetos	Lista de campañas a las que desea aplicar la acción especificada por `demand_filter_action` . Consulta Campañas filtradas a continuación.
`buyer_type`	enumeración	A qué tipo de comprador se va a aplicar esta regla de pago. Posibles valores: - `"direct"`: su propio inventario administrado - `"external"`: tercero, inventario administrado - `"both"` Valor predeterminado: `"both"`
`max_revshare`	double	Si `pricing_type` es `"dynamic"`, este es el porcentaje máximo de revshare pagado al publicador. Obligatorio activado: `POST`, si `pricing_type` es `"dynamic"`.
`apply_cost_on_default`	booleano	Si se paga o no al editor aunque la subasta no se produzca.
`demand_filter_action`	enumeración	Decida si quiere incluir o excluir los anunciantes, los artículos de línea o las campañas que aparecen en las `filtered_advertisers`matrices , `filtered_line_items`o `filtered_campaigns` . Posibles valores: - `"include"` - `"exclude"` - `"default"`

Anunciantes filtrados

Campo	Tipo	Description
`id`	Entero	El identificador del anunciante.
`name`	string	Nombre del anunciante.

Elementos de línea filtrados

Campo	Tipo	Description
`id`	Entero	Identificador del elemento de línea.
`name`	string	Nombre del elemento de línea.

Campañas filtradas

Campo	Tipo	Description
`id`	Entero	Identificador de la campaña.
`name`	string	Nombre de la campaña.

Ejemplos

Create una regla de pago

$ cat payment_rule.json

{
    "payment-rule":{
        "name": "France - 1/24 - $.40 CPM",
        "code": "france_payment_rule",
        "pricing_type": "cpm",
        "cost_cpm": "0.4",
        "state": "active",
        "start_date": "2010-01-01 00:00:00",
        "end_date": "2010-03-31 11:59:59",
        "priority": 8,
        "profile_id": 12345
    }
}

$ curl -c cookies -b cookies -X POST -d @payment_rule.json 'https://api.appnexus.com/payment-rule?publisher_id=65103'

{
  "response": {
    "status": "OK",
    "count": 1,
    "id": 66323,
    "start_element": 0,
    "num_elements": 100,
    "payment-rule": {
      "id": 66323,
      "code": "france_payment_rule",
      "name": "France - 1/24 - $.40 CPM",
      "description": "",
      "pricing_type": "cpm",
      "cost_cpm": 0.4,
      "revshare": null,
      "state": "active",
      "start_date": "2010-01-01 00:00:00",
      "end_date": "2010-03-31 11:59:59",
      "profile_id": 12345,
      "timezone": "EST5EDT",
      "priority": 8,
      "last_modified": "2011-02-18 21:19:52"
    }
  }
}

Leer una regla de pago único

$ curl -b cookies 'https://api.appnexus.com/payment-rule?id=92873'

{
    "payment-rule": {
    "apply_cost_on_default": true,
    "target_ecpm": 0.8,
    "max_revshare": 0.8,
    "buyer_type": "both",
    "last_modified": "2012-08-02 19:04:00",
    "priority": 10,
    "timezone": "EST5EDT",
    "profile_id": null,
    "end_date": null,
    "start_date": "2013-01-01 00:00:00",
    "state": "active",
    "revshare": 0.67,
    "cost_cpm": 40,
    "pricing_type": "dynamic",
    "description": "A payment rule for targeting USA users",
    "name": "USA",
    "code": "usa_payment_rule",
    "id": 98273
    }
}

Leer todas las reglas de pago de un publicador

$ curl -c cookies -b cookies 'https://api.appnexus.com/payment-rule?publisher_id=65103'

{
  "response": {
    "status": "OK",
    "count": 4,
    "start_element": null,
    "num_elements": null,
    "payment-rules": [
      {
        "id": 95479,
        "code": null,
        "name": "Base Payment Rule",
        "description": "",
        "pricing_type": "revshare",
        "cost_cpm": null,
        "revshare": 0.6,
        "state": "active",
        "start_date": null,
        "end_date": null,
        "profile_id": null,
        "timezone": "EST5EDT",
        "priority": 1,
        "last_modified": "2012-04-09 11:40:54",
        "buyer_type": "both",
        "max_revshare": null,
        "target_ecpm": null,
        "apply_cost_on_default": false,
        "demand_filter_action": "default",
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "filtered_advertisers": null,
        "filtered_line_items": null,
        "filtered_campaigns": null
      },
      {
        "id": 95480,
        "code": null,
        "name": "AbenBog Unique Impressions",
        "description": "",
        "pricing_type": "revshare",
        "cost_cpm": null,
        "revshare": 0.7,
        "state": "active",
        "start_date": "2012-04-09 00:00:00",
        "end_date": null,
        "profile_id": 142958,
        "timezone": "EST5EDT",
        "priority": 5,
        "last_modified": "2012-04-09 11:46:32",
        "buyer_type": "both",
        "max_revshare": null,
        "target_ecpm": null,
        "apply_cost_on_default": false,
        "demand_filter_action": "exclude",
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "filtered_advertisers": null,
        "filtered_line_items": null,
        "filtered_campaigns": null
      },
      {
        "id": 98434,
        "code": null,
        "name": "Rich's cool payment rule",
        "description": "",
        "pricing_type": "revshare",
        "cost_cpm": null,
        "revshare": 0.7,
        "state": "active",
        "start_date": null,
        "end_date": null,
        "profile_id": null,
        "timezone": "EST5EDT",
        "priority": 5,
        "last_modified": "2012-08-03 17:37:17",
        "buyer_type": "both",
        "max_revshare": null,
        "target_ecpm": null,
        "apply_cost_on_default": true,
        "demand_filter_action": "default",
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "filtered_advertisers": null,
        "filtered_line_items": null,
        "filtered_campaigns": null
      },
      {
        "id": 98435,
        "code": "this_is_a_test",
        "name": "Rich's other cool payment rule",
        "description": "",
        "pricing_type": "revshare",
        "cost_cpm": null,
        "revshare": 0.7,
        "state": "active",
        "start_date": null,
        "end_date": null,
        "profile_id": null,
        "timezone": "EST5EDT",
        "priority": 5,
        "last_modified": "2012-08-03 17:57:27",
        "buyer_type": "both",
        "max_revshare": null,
        "target_ecpm": null,
        "apply_cost_on_default": true,
        "demand_filter_action": "default",
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "filtered_advertisers": null,
        "filtered_line_items": null,
        "filtered_campaigns": null
      }
    ]
  }
}

Actualización de una regla de pago

$ cat payment_rule.json

{
    "payment-rule": {
    "apply_cost_on_default": true,
    "target_ecpm": 0.8,
    "max_revshare": 0.8,
    "priority": 10,
    "timezone": "EST5EDT",
    "revshare": 0.67,
    "cost_cpm": 40,
    "pricing_type": "dynamic",
    "description": "A payment rule for targeting USA users"
    }
}

$ curl -b cookies -X PUT -d @payment_rule.json
'https://api.appnexus.com/payment-rule?publisher_id=65103&id=98273'

{
    "payment-rule": {
    "apply_cost_on_default": true,
    "target_ecpm": 0.8,
    "max_revshare": 0.8,
    "buyer_type": "both",
    "last_modified": "2012-08-02 19:04:00",
    "priority": 10,
    "timezone": "EST5EDT",
    "profile_id": null,
    "end_date": null,
    "start_date": "2013-01-01 00:00:00",
    "state": "active",
    "revshare": 0.67,
    "cost_cpm": 40,
    "pricing_type": "dynamic",
    "description": "A payment rule for targeting USA users",
    "name": "USA",
    "code": "usa_payment_rule",
    "id": 98273
    }
}

Eliminación de una regla de pago

$ curl -b cookies -X DELETE "https://api.appnexus.com/payment-rule?id=98384"

{
  "response": {
    "status": "OK"
  }
}

Compartir a través de