Appearance
Opera Marketing Corporation Event Integration Guildline
Opera Event Postback Integrate
Events
| Event | Description | Recommended parameters | Required | Event Name |
|---|---|---|---|---|
| App Opened | When a user Open/Launch app success. Opera highly recommends measuring apps important to your business. | Mandatory | app_opened | |
| View Item | When a visitor views a specific page .(Opera recommends measuring pages important to your business such as, Item / product page , Promote page , Category page.) | content_type, quantity, description, content_id, currency, value | Mandatory | view_content |
| Add to Cart | When a visitor adds an item to the cart. | content_type, quantity, description, content_id, currency, value | Mandatory | add_to_cart |
| Complete Purchase | When a visitor completed the purchase. Opera recommends using this event when placing an order and making a purchase are the same. | content_type, quantity, description, content_id, currency, value | Mandatory | purchase |
| Custom Events | Important events for your business to succeed. | Optional | your_custom_event |
Note: By default, In-app events S2S/MMP postback should bring User ID.
Events Value
View_content Event Parameter definition
| Event | Event Value Recommended parameters | Description | Required | eg. | JSON String |
|---|---|---|---|---|---|
| ‘View_content’ Event Value parameters | content_type | product tags, eg. Mall /seller product / Promotional / TopSales / | Mandatory | Mall / Top /Hot / free shipping etc. | { "event_value": [ { "content_type": "hot", "quantity": "13", "description": "Tubo Par Slider Protetor Carenagem Motor Tanque Carbono Pedal Moto para Mata Cachorro", "content_id": "612406277-21297620739", "currency": "BRL", "content_value": "25.90" }, { "content_type": "hot", "quantity": "13", "description": "Tubo Par Slider Protetor Carenagem Motor Tanque Carbono Pedal Moto para Mata Cachorro", "content_id": "612406277-21297620739", "currency": "BRL", "content_value": "25.90" } ] } |
| content_id | Product Unique ID, used to mapping with Product Feeds; If product id is multilevel index, like ‘seller_id’-’product_id’, the value could be ‘’ | Mandatory | Unique product ID = 21297620739 Multi ID = 612406277/21297620739 | ||
| description | Content Description, | Optional | Product title | ||
| content_value | Sale Price | Optional | |||
| currency | Sale Price Currency | Optional | USD/IDR | ||
| quantity | Stock Available Quantity | Optional | ‘13’ |
Add_to_cart Event Parameter definition
| Event | Event Value Recommended parameters | Description | Required | eg. | JSON String |
|---|---|---|---|---|---|
| ‘add_to_cart’ Event Value parameters | content_type | product tags, eg. Mall /seller product / Promotional / TopSales / | Mandatory | Mall / Top /Hot / free shipping etc. | { "event_value": [ { "content_type": "hot", "quantity": "13", "description": "Tubo Par Slider Protetor Carenagem Motor Tanque Carbono Pedal Moto para Mata Cachorro", "content_id": "612406277-21297620739", "currency": "BRL", "content_value": "25.90" }, { "content_type": "hot", "quantity": "13", "description": "Tubo Par Slider Protetor Carenagem Motor Tanque Carbono Pedal Moto para Mata Cachorro", "content_id": "612406277-21297620739", "currency": "BRL", "content_value": "25.90" } ] } |
| content_id | Product Unique ID, used to mapping with Product Feeds; If product id is multilevel index, like ‘seller_id’-’product_id’, the value could be ‘’ | Mandatory | Unique product ID = 21297620739 Multi ID = 612406277/21297620739 | ||
| description | Content Description, | Optional | Product title | ||
| content_value | Sale Price | Optional | |||
| currency | Sale Price Currency | Optional | USD/IDR | ||
| quantity | Stock Available Quantity | Optional | ‘13’ |
Purchase Event Parameter definition
| Event | Event Value Recommended parameters | Description | Required | eg. | JSON String |
|---|---|---|---|---|---|
| ‘purchase’ Event Value parameters | content_type | product tags, eg. Mall /seller product / Promotional / TopSales / | Mandatory | Mall / Top /Hot / free shipping etc. | { "event_value": [ { "content_type": "hot", "quantity": "13", "description": "Tubo Par Slider Protetor Carenagem Motor Tanque Carbono Pedal Moto para Mata Cachorro", "content_id": "612406277-21297620739", "currency": "BRL", "content_value": "25.90" }, { "content_type": "hot", "quantity": "13", "description": "Tubo Par Slider Protetor Carenagem Motor Tanque Carbono Pedal Moto para Mata Cachorro", "content_id": "612406277-21297620739", "currency": "BRL", "content_value": "25.90" } ] } |
| content_id | Product Unique ID, used to mapping with Product Feeds; If product id is multilevel index, like ‘seller_id’-’product_id’, the value could be ‘’ | Mandatory | Unique product ID = 21297620739 Multi ID = 612406277/21297620739 | ||
| description | Content Description, | Mandatory | Product title | ||
| content_value | Sale Price ( Purchase price ) | Mandatory | Purchase Price, Known as GMV per item | ||
| currency | Sale Price Currency | Mandatory | USD/IDR | ||
| quantity | Stock Available Quantity | Mandatory | ‘13’ |
S2S Event Postback Integrate
| cvid | Event Name | Event Value | Realtime | Note |
|---|---|---|---|---|
| Provided by Opera | app_opened | None | Yes | |
| Provided by Opera | view_content | Yes | Yes | |
| Provided by Opera | add_to_cart | Yes | Yes | |
| Provided by Opera | purchase | Yes | Yes | |
| Provided by Opera | your_custom_event | Yes | Yes |
Postback API
Using the HTTP POST Method to carry event information.
Endpoint
https://cb.adx.opera.com/marketing/pb?cvid=channel_id
Note: Channel id is separated by Opera.
Body parameter
| Parameters | Type | Description | Mandatory |
|---|---|---|---|
| cvid | String | The conversion ID allocated by Opera | YES |
| click_id | String | An ID generated by OperaAds side dynamically (different click_id for different AD requests.) and put in the click-through URL. Advertisers need to get the click_id from the click-through URL, put it in this click_id parameter without any change and post back to OperaAds Server. | YES |
| gaid | String | Android Advertising ID | YES |
| idfa | String | Apple advertising ID ( If cannot get IDFA, could use IDFV instead) | YES |
| event_name | String | Event name: install, register, login, purchase, place_order. If advertisers need more customized events, please contact Opera Ads to create. | YES |
| event_value | JSON String | JSON String | Yes |
Example
POST https://cb.adx.opera.com/marketing/pb?cvid=129874392442
Body:
{
"cvid": "12987439244672",
"event_name": "purchase",
"event_value": ”[
{
"content_type": "hot",
"quantity": "13",
"description": "Tubo Par Slider Protetor Carenagem Motor Tanque Carbono Pedal Moto para Mata Cachorro",
"content_id": "612406277-21297620739",
"currency": "BRL",
"content_value": "25.90"
},
{
"content_type": "hot",
"quantity": "13",
"description": "Tubo Par Slider Protetor Carenagem Motor Tanque Carbono Pedal Moto para Mata Cachorro",
"content_id": "612406277-21297620739",
"currency": "BRL",
"content_value": "25.90"
}
]“,
"click_id": "opera_click_id",
"idfa": "",
"gaid": "a3c9eb3b-d9d13-45a3-96d9-2c8c50cacd30"
}HTTP Response
HTTP Status Code is 200 if the request is processed.
Response Body HTTP Body in JSON format:
| Field | Type | Description |
|---|---|---|
| status | int | 0 means report success, otherwise failure |
| message | string | “ok” or the reason for failure. |
{
"status": 0,
"message": "ok"
}Note :
content_id normally known as Product_id, JSON string may be different from above example, insert Product Profile just work for us
