Docs
Targeted Ads
Ads

Glossary

TermDefinition
ADCIO AdminAdmin platform used by Stores and Sellers on ADCIO
StoreADCIO client with its own store on site/app
SellerA seller who subscribes to Store
It is recommended to visit flow overview (opens in a new tab) before reading this document.

Targeted Ad

The targeted ad is one of the key features of the ADCIO. A store can invite multiple sellers. The store’s placements are used for the advertisements (ads) of those sellers. Note that targeted ads for customers (users) are calculated by the ML model in addition to ADCIO admin configurations by sellers and stores.

Embedding Ads

💡
If you use a e-commerce solution such as Cafe24, you may not need to make new codes for your web or app. Please follow simple steps suggested from the solution. If you still have questions, please visit adcio.ai (opens in a new tab) and contact us (opens in a new tab).

Similar to [recommendations](https://docs.adcio.ai/en/docs/personalized-recommendations/recommendations (opens in a new tab)), ads are also made based on the placement (opens in a new tab). To embed an ad, you need to specify the placementId or the page which the placement is bounded to.

There are 2 ways to embed ads from your application.

1. Using Placement ID

Set placement IDs on where you want to show ads. For example, if you're using adcio.js, you can specify placement IDs with a placements parameter.

JavaScript
const adcioInstance = new adcio.Adcio({ clientId: "..." });
const { suggestions } = adcioInstance.createAdvertisementProducts({  placementId: "...",});
Dart
import 'package:adcio_placement/adcio_placement.dart';
 
final rawData = await adcioSuggest(placementId: '...');
Kotlin
import ai.corca.adcio_placement.feature.AdcioPlacement
 
val rawData = AdcioPlacement.adcioSuggest(placementId = "...")

Placement IDs can be found on ADCIO Admin page (opens in a new tab) for stores

ADCIO Admin Page -> [SideBar] Placement -> placement detail page -> Placement ID

placementid-9a52e645.png

2. Using Page Name

If you don't want to modify your client-side code every time when the new placements are added or deleted, you can just set page name instead of the actual placement IDs. The bounded placements of that page will be used for the ads. For more details about the relation between pages and placements, please refer to page (opens in a new tab).

Under the hood, the placement IDs are fetched by using the API. Note that it can be a little bit slower than using Placement ID because of this fetching step.

The page parameter is not yet implemented for App SDKs.
JavaScript
const [placement] = await adcioInstance.fetchPlacements({ pageName: "..." });
⚠️
Ad creatives can only be served properly if there are active campaigns with sufficient ad budget/credits remaining. For example, if all campaigns have depleted their budgets or are deactivated for any reason, there may be a shortage of eligible ad creatives to deliver into the ad placements. In such cases, an exception will be raised. This exception should be handled gracefully (e.g. hiding the entire ad placement sections, or falling back to displaying organic product listings without ADCIO integration).