🥘
Food Commerce API Help
  • Catalog Sync
    • Restaurant Catalog
    • Restaurant Menu Items Catalog
  • User Tracking Events
    • API
      • Sending Events
      • Register Ad Impressions
      • Registering Ad Click
        • Implementation for Sponsored Ads
        • Implementation for External Network Ads
    • JS SDK
      • Installing the Tag
      • Track Product View
      • Track Restaurant View
      • Track Add to Cart
      • Track Purchases
      • Track Impressions
      • Track Ad Clicks
      • References
      • Common Errors
  • Billing API
    • Charge API
    • Debit API
    • Charge Status API
    • Balance API
    • Transaction Log API
Powered by GitBook
On this page
  • How to Implement
  • Endpoint
  1. User Tracking Events
  2. API
  3. Registering Ad Click

Implementation for External Network Ads

OnlineSales.ai sets certain parameters in the ad URL which are required for correct attribution. It is very important to send all the URL parameters back to OnlineSales.ai and hence registering a click with correct param values is required.

In order to attribute the orders correctly & run various attribution models event click received from the ad (external) should be registered to onlinesales.ai servers with correct parameters.

How to Implement

Once the vendor account is created by OnlineSales.ai, all the ad landing page will have following the additional parameters added:

  • atag

  • asvt

  • seller_id

  • client_id

  • gclid (will be populated at the runtime by google) - only applicable for google channels

Following is the API call:

Endpoint

GET https://t.o-s.io/aclick

Following is the list of all possible query parameters to be passed to above endpoint:

device_id

The unique identifier for the user currently performing the action. Use GAID or IDFA in case of Android or iOS respectively.

Yes

cli_ubid

Client's generated user id. If sent, this takes precedence over device_id Once generated for a user - should be the same for all the api calls.

Yes if device_id is not set

client_id

Identifier for your account. The value will be shared at the time of integration and will be fixed for all API calls

Yes

seller_id

The id of the restaurant. This value will be received as a part of query parameters for web and as a part of deep-link parameters in case of the mobile app open.

Yes

asvt

This value will be received as a part of query parameters for the web and as a part of deep-link parameters in case of mobile app open. The value of asvtshould be the same as received.

Yes

atag

This value will be received as a part of query parameters for web and as a part of deep-link parameters in case of mobile app open. Value of atagshould be the same as received

Yes

gclid

Google click ID. eg: EAItIQoxChMIiYfIzLff6AIVPSsrCh0hqwA2EAYEKCPAEgJ09vD_IwE

this is available at the time of ad click from google

Yes for google click

fb_account_id

Facebook account id

No

fb_campaign_id

Facebook campaign id

No

fb_adset_id

Facebook adset id

No

fb_ad_id

Facebook ad ID

No

event_time

Time of the event in epoch miliseconds. eg. format : 1657190975000

Yes

gaid

Google advertising ID is a device identifier for advertisers that allows them to anonymously track user ad activity on Android devices

No (In case of android application)

idfa

ID for advertisers (iOS only)

No (In case of IOS application)

device_brand

Device manufacturer name

No

device_model

Device model number. eg: SM-G313HZ

No

PreviousImplementation for Sponsored AdsNextJS SDK

Last updated 2 years ago