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. |
metric |
# 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 |
For tiered commission structures, this is the commission that is added to the baseline commission when a publisher reaches a certain level of sales. This value is populated only at the end of the month when Publisher Invoices are generated. |
metric |
Average Order Value |
Average Order Value |
The average monetary value of each order. |
dimension |
Baseline Commission |
Baseline Commission |
The commission amount that is calculated before adjustments are made at the end of the month for tiered offers. |
metric |
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. |
metric |
Commission Status |
Commission Status |
The status of an Enhanced Order Locking order, indicating if the order is unlocked, locked, or not applicable for Enhanced Order Locking. This status can affect commission processing. |
dimension |
Commissioning List ID |
Commissioning List ID |
The unique identifier of the commission list to which the transaction belongs. This field is optional and available if reported by the Advertiser. |
dimension |
Commissioning List Name |
Commissioning List Name |
The name of the commissioning list, as provided by the advertiser, which details specific commission rules. |
dimension |
Consumer Country |
Consumer Country |
The country of the consumer who made the purchase. |
dimension |
Currency |
Currency |
The currency in which monetary values are reported (e.g., USD, EUR). |
dimension |
Customer Status |
Customer Status |
The status assigned by the advertiser to the consumer for a specific order, based on the customer’s order history with the advertiser. |
dimension |
Device |
Device |
The type of device a consumer used when clicking a link, for example, PC, Tablet, or Phone. |
dimension |
Estimated Net Total Cost |
Estimated Net Total Cost |
The estimated net total cost of an item or order. |
metric |
Gross Commissions |
Gross Commissions |
The total of all commissions (excluding CPC commissions) before taking cancellations into account. It is calculated by adding the sum of all commissions with values greater than 0. |
metric |
Gross Sales |
Gross Sales |
The total sales amount generated. |
metric |
Gross Total Commissions |
Gross Total Commissions |
The total of all commissions (including CPC commissions) before taking cancellations into account. It is calculated by adding the sum of all commissions with values greater than 0. |
metric |
Group Offer ID |
Group Offer ID |
The identifier for a group of offers, where multiple individual offers can be associated with this single group. |
metric |
Link ID |
Link ID |
An identifier for the click from which the transaction originated. This field is optional and available if reported by the Publisher. |
metric |
Link Name |
Link Name |
The name of the link used for the transaction. |
dimension |
Link Size |
Link Size |
The dimensions (size) of a creative, such as a banner, Dynamic Rich Media (DRM), or Flex Link. This field does not apply to text links. |
dimension |
Link Type |
Link Type |
The creative type of the affiliate link, such as Banner, Text, or Flex Link. |
dimension |
Net Items Per Order |
Net Items Per Order |
The number of items sold after canceled items are subtracted from the gross number of items, divided by the number of orders that were placed. |
metric |
Network |
Network |
The specific Rakuten Advertising network region (e.g., US, UK, JP) to which the data pertains. |
dimension |
Network ID |
Network ID |
A numerical identifier for the specific Rakuten Advertising network region (e.g., 1 for US, 3 for UK, 11 for JP). |
dimension |
Offer Group ID |
Offer Group ID |
A unique identifier assigned by the system that connects the base commission, SKU lists, and commissioning rules for more complex offers. |
metric |
Offer ID |
Offer ID |
The unique identifier associated with the offer on which the transaction was commissioned. |
metric |
Offer Name |
Offer Name |
The name assigned to a particular offer by the advertiser. |
dimension |
Order Coupon Code(s) |
Order Coupon Code(s) |
The coupon code(s) used by a customer during a transaction. This field helps in attributing sales and commissions to specific promotional efforts. |
dimension |
Order Discount Amount |
Order Discount Amount |
The total monetary amount discounted by an advertiser for a specific order. |
dimension |
Order ID |
Order ID |
The ID of the order as reported 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 date and time when the transaction was processed by Rakuten. |
dimension |
Product Name |
Product Name |
The name of the product sold. |
dimension |
Publisher Group ID |
Publisher Group ID |
Unique identifier for a group of publishers within the Rakuten Advertising network. Publishers are often organized into groups for reporting and management purposes. |
metric |
Publisher Group Name |
Publisher Group Name |
The human-readable name of a publisher group in the Rakuten Advertising network. This name corresponds to the Publisher Group ID. |
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 primary URL associated with the publisher responsible for driving the transaction or performance metric. This indicates the website or platform where the publisher promotes advertiser offers. |
dimension |
Quantity |
Quantity |
The number of items purchased in the order. |
metric |
SKU |
SKU |
The stock-keeping unit (SKU) number of the product sold. |
dimension |
Sales |
Sales |
The total revenue generated from referred transactions. |
dimension |
Ship-to Country |
Ship-to Country |
The country where the order is being shipped. |
dimension |
Total Commission |
Total Commission |
The aggregate commission earned from referred transactions. |
metric |
Transaction Created On Date |
Transaction Created On Date |
The date when the order was placed on the Advertiser’s site. |
dimension |
Transaction Created On Time |
Transaction Created On Time |
The time when the order was placed on the Advertiser’s site, as part of the Transaction Created On Date. |
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 transaction, defined by Rakuten Advertising as an internal numbering system for tracked event components. Not to be confused with the advertiser-defined order ID. |
dimension |
Transaction Time |
Transaction Time |
The time of day that a consumer completed a transaction. |
dimension |