Cross Promotion

https://api.revolution.wortise.com

Crear campaña

POST https://api.revolution.wortise.com/campaigns

{
  "general": {
    // "campaign_days": "13", send only if it is not cross promotion
    // "campaign_total_budget": 100, send only if it is not cross promotion
    "campaign_name": "cp_test_001",
    "new_campaign_name": "cp_test_001",
    "campaign_start_date": "2024-01-11T00:00:00.000Z",
    "campaign_end_date": "2024-01-24T00:00:00.000Z",
    // "campaign_purchase_model": "CPM", // Do not change, send only if it is not cross promotion
    // "unit_price": "1000", send only if it is not cross promotion
    "country": "ar",
    "action": "create",
    "origin": "pub", // Do not change
    "categories": [],
    "publisher" : "", // Pub account ID
    "asset": "", // Pub asset ID
    "cross_promotion": true // send true if it is cross promotion
  },
  "banners": [
    {
      "banner_html": "",
      "banner_url": "wortise.com",
      "audience_id": "MONGO AUDIENCE _ID"
    }
  ],
  "interstitials": [
    {
      "interstitial_html": "",
      "interstitial_url": "wortise.com",
      "audience_id": "MONGO AUDIENCE _ID"
    }
  ]
}

Editar campaña

POST https://api.revolution.wortise.com/campaigns

{
  "general": {
    // "campaign_days": "7", send only if it is not cross promotion
    // "campaign_total_budget": 100, send only if it is not cross promotion
    "campaign_name": "cp_test_001",
    "new_campaign_name": "cp_test_001",
    "campaign_start_date": "2023-12-21T00:00:00.000Z",
    "campaign_end_date": "2023-12-28T23:59:59.000Z",
    // "campaign_purchase_model": "CPM", // Do not change, send only if it is not cross promotion
    // "unit_price": 1000, send only if it is not cross promotion
    "country": "ar",
    "action": "edit",
    "origin": "pub", // Do not change
    "categories": [],
    "publisher" : "", // Pub account ID
    "asset": "", // Pub asset ID
    "cross_promotion": true // can't be changed
  },
  "banners": [
    {
      "deleted": true,
      "element_id": 1000,
      "banner_html": "",
      "banner_url": "wortise.com",
      "audience_id": "MONGO AUDIENCE _ID"
    }
  ],
  "interstitials": [
    {
      "element_id": 1000,
      "interstitial_html": "",
      "interstitial_url": "wortise.com",
      "audience_id": "MONGO AUDIENCE _ID"
    }
  ]
}

Detalles importantes

Se utiliza el nombre de la campaña (campaign_name) como identificador único de la misma. Quiere decir que si se intenta crear una campaña con un nombre existente, devolverá error.

Los valores que tienen el comentario "Do not change", son estáticos y exclusivos para Cross Promotion. No deberían cambiarse.

El valor campaign_days debe calcularse en base a la fecha de inicio y fin de la campaña.

El valor campaign_total_budget es en USD.

El valor unit_price es el valor unitario por cada acción. En este caso la campaña es de CPM. Así que es el precio que se pagará por cada 1.000 impresiones.

El valor country determina en qué país vivirá la campaña.

Obtener campañas (Información superficial)

GET https://api.revolution.wortise.com/campaigns/pub?limit=1&page=1

Los parámetros limit y page sirven para aplicar paginación. Si uno de ellos, o ambos, no se especifican, se traerán todos los resultados.

Hay 2 parámetros que son enabled y cross_promotion, que pueden especificarse con true o false. Sirven para filtrar entre esos valores. Si no se especifica, se traerán todos los resultados.

Hay otros 2 parámetros que son start y end. Sirven para filtrar según la fecha de creación de campaña.

Luego, hay otro parámetro opcional, que es verification. El cual se puede especificar con pending, approved o rejected. Sirve para filtrar según el estado de verificación. Si no se especifica, se traerán todas las campañas.

Por último, están los parámetros publisher y asset. También son opcionales. Sirven para filtrar en base a las campañas de una cuenta o aplicación específica. Esto sirve, por ejemplo, para mostrar la lista de campañas propias a un PUB. Si no se especifica, se traerán todas las campañas (admin).

Si necesitas obtener solamente un resumen de los datos generados, puedes enviar el parámetro summary en true. Por defecto es false.

Obtener campaña (Información a detalle)

GET https://api.revolution.wortise.com/campaigns/pub/{CAMPAIGN ID}/details

Esto devolverá información a detalle y específica de una campaña. Por ejemplo, sus datos core, creativos, estadísticas de cada creativo, estadísticas de perfil de usuario de la campaña, etc.

Prender campaña

POST https://api.revolution.wortise.com/campaigns/pub/{CAMPAIGN ID}/enable

Apagar campaña

POST https://api.revolution.wortise.com/campaigns/pub/{CAMPAIGN ID}/disable

Aprobar campaña

POST https://api.revolution.wortise.com/campaigns/pub/{CAMPAIGN ID}/approve

Rechazar campaña

POST https://api.revolution.wortise.com/campaigns/pub/{CAMPAIGN ID}/decline