Rakuten Advertiser: Most-used fields#
The table below gives information about most-used fields that you can import from Rakuten Advertiser. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
# of Cancelled Items |
# of Cancelled Items |
The number of items within a transaction that were cancelled. |
metric |
# of Clicks |
# of Clicks |
The total number of click-throughs recorded for links within the specified period. |
dimension |
# of Impressions |
# of Impressions |
The total number of times an advertisement or link was displayed. |
metric |
# of Items |
# of Items |
The total quantity of individual items sold in transactions. |
metric |
# of Net Items |
# of Net Items |
The total number of items purchased in a transaction after accounting for any returns or cancellations. This relates to the ‘Items’ field which represents item-count in the API. |
metric |
# of Orders |
# of Orders |
The total count of completed orders. |
metric |
Adjusted Commission |
Adjusted Commission |
The commission amount after any adjustments, which can either increase or decrease the baseline commission. |
metric |
Average Order Value |
Average Order Value |
The average monetary value of each order. |
metric |
Baseline Commission |
Baseline Commission |
The initial commission amount earned before any adjustments or modifications. |
metric |
Browser |
Browser |
The type of web browser used by the customer. |
dimension |
Click IP Address |
Click IP Address |
The Internet Protocol (IP) address recorded for the user’s device at the time of a click event. The platform supports IP-related reports. |
dimension |
Click Through Rate (CTR) |
Click Through Rate (CTR) |
The ratio of clicks to impressions, indicating the percentage of users who clicked on a link after viewing it. |
dimension |
Commission Status |
Commission Status |
The current payment status of a transaction’s commission (e.g., Approved, Held, Denied). |
dimension |
Commissioning List ID |
Commissioning List ID |
The unique identifier for a list used to manage commission rules and payouts. |
dimension |
Commissioning List Name |
Commissioning List Name |
The name of the commissioning list. |
dimension |
Consumer Country |
Consumer Country |
The country of the consumer who made the purchase. |
dimension |
Converting Site Name |
Converting Site Name |
The name of the publisher’s website or property that drove the conversion. |
dimension |
Cost Per Action (CPA) |
Cost Per Action (CPA) |
metric |
|
Currency |
Currency |
The currency in which monetary values are reported (e.g., USD, EUR). |
dimension |
Customer Status |
Customer Status |
dimension |
|
Device |
Device |
The type of device (e.g., desktop, mobile, tablet) used by the customer. |
dimension |
Earnings Per Click (EPC) |
Earnings Per Click (EPC) |
The average earnings generated for each click received. |
metric |
Estimated Gross Total Cost |
Estimated Gross Total Cost |
metric |
|
Estimated Net Total Cost |
Estimated Net Total Cost |
metric |
|
Gross Commissions |
Gross Commissions |
The total commission earned before any deductions or cancellations. |
metric |
Gross Sales |
Gross Sales |
The total sales revenue before any returns, discounts, or allowances. |
metric |
Gross Total Commissions |
Gross Total Commissions |
The overall sum of gross commissions. |
metric |
Group Offer ID |
Group Offer ID |
metric |
|
Link ID |
Link ID |
A unique identifier for a specific tracking link used by a publisher. |
metric |
Link Name |
Link Name |
A descriptive name for the tracking link. |
dimension |
Link Size |
Link Size |
The dimensions (e.g., width x height) of a banner or creative link. |
dimension |
Link Type |
Link Type |
The classification of the link (e.g., text link, banner link, dynamic rich media). |
dimension |
Mobile Operating System |
Mobile Operating System |
The mobile operating system (e.g., iOS, Android) used by the customer. |
dimension |
Net Items Per Order |
Net Items Per Order |
The number of items in an order after accounting for any returns, cancellations, or other adjustments. The API provides ‘Items’ per transaction. |
metric |
Network |
Network |
The specific Rakuten Advertising network region (e.g., US, UK, CA). |
dimension |
Network ID |
Network ID |
A numerical identifier for the specific Rakuten Advertising network (e.g., 1 for US, 3 for UK). |
metric |
Offer Group ID |
Offer Group ID |
metric |
|
Offer ID |
Offer ID |
The unique identifier for a specific advertising offer or program. |
metric |
Offer Name |
Offer Name |
The descriptive name of the advertising offer or program. |
dimension |
Order Coupon Code(s) |
Order Coupon Code(s) |
The coupon codes applied to an order. |
dimension |
Order Discount Amount |
Order Discount Amount |
dimension |
|
Order ID |
Order ID |
A unique identifier assigned to each customer order by the advertiser. |
dimension |
Orders/Click |
Orders/Click |
The conversion rate, representing the number of orders generated per click. |
metric |
Process Date |
Process Date |
The date when a transaction or event was processed by the Rakuten Advertising system. |
dimension |
Process Time |
Process Time |
The time when a transaction or event was processed by the Rakuten Advertising system. |
dimension |
Product Category |
Product Category |
The primary classification or type of the product. |
dimension |
Product Category 2 |
Product Category 2 |
dimension |
|
Product Category 3 |
Product Category 3 |
dimension |
|
Product Category 4 |
Product Category 4 |
dimension |
|
Product Name |
Product Name |
The name of the product sold. |
dimension |
Publisher Group ID |
Publisher Group ID |
metric |
|
Publisher Group Name |
Publisher Group Name |
dimension |
|
Publisher ID |
Publisher ID |
A unique identifier for the publisher within the Rakuten Advertising network. |
metric |
Publisher Name |
Publisher Name |
The name of the publisher. |
dimension |
Publisher URL |
Publisher URL |
The web address (domain) associated with the publisher. |
dimension |
Quantity |
Quantity |
The number of units for a specific product within a transaction. |
metric |
Referrer URL |
Referrer URL |
The URL of the webpage that directed the user to the advertiser’s site. |
dimension |
SKU |
SKU |
The Stock Keeping Unit, a unique code used to identify each distinct product or item. |
dimension |
Sales |
Sales |
The total revenue generated from referred transactions. |
metric |
Ship-to Country |
Ship-to Country |
dimension |
|
Sub-Publisher ID |
Sub-Publisher ID |
A unique identifier for a sub-publisher or affiliate segment, often corresponding to the ‘u1’ parameter in tracking links. |
metric |
Total Commission |
Total Commission |
The aggregate commission earned from referred transactions. |
metric |
Transaction Created On Date |
Transaction Created On Date |
The date when the transaction record was initially created. |
dimension |
Transaction Created On Time |
Transaction Created On Time |
The time when the transaction record was initially created. |
dimension |
Transaction Date |
Transaction Date |
The date when a customer completed a purchase or action. |
dimension |
Transaction ID |
Transaction ID |
A unique identifier for each individual transaction. |
dimension |
Transaction Time |
Transaction Time |
The time when a customer completed a purchase or action. |
dimension |
datetime |
datetime |
The date and time when an event or transaction occurred. This corresponds to the ‘Date’ and ‘Time’ fields available in the API. |
dimension |