adClick Redirection Endpoint V3

Based on the user's qualifying criteria, the publisher publishes a customized advertisement on the user's application interface. When the user clicks on this Ad, the adClickRedirection endpoint redirects the user to the advertiser's landing page.

GET https://adclick.zendrive.com/iql/v3/ad_unit/<ad_id>/driver_id/<user_id>/click

Query Parameters

Name	Type	Description
auth_token	String	A Security Token that is used for verification of the request.
pl	String	A URL safe base64 encoded version of the JSON String representing the request payload.

302: Found The request was successful and the user is redirected to the advertiser's landing page.

{
    // Response
}

400: Bad Request This can happen if the JSON schema is invalid.

{
    // Response
}

401: Unauthorized The authorization token HTTP header might not be set properly. If it is, then the authorization token has expired or is invalid.

{
    // Response
}

404: Not Found The ad_id or user_id might be incorrect.

{
    // Response}

Sample Request URL

https://adclick.zendrive.com/iql/v3/ad_unit/ad_1/driver_id/010e0a60-4ca3-9000-e29064401/click?auth_token=gAAAAABjobIQzVN5wc3hanuE1Xng4y4_DKojdzmdI1AzVdOD9b3g6-3bkB65_7_iOWo9hPqGFo3XvkmZTZ6COu8dhrP8TVKb1d_FqAprIBmy2D-WxPa-45ZJku4xyhmvksPjTiehhSCtM7hdWfY9JEhjXQhjaqde01hSwTyrRHDGtqCjoRL0BZZRM5P4MuzRrDX05RPAXGsa6Xyw==&pl=eyJmaXJzdF9uYW1lIjoiQXNoIiwibGFzdF9uYW1lIjoiS2V0Y2h1bSIsImVtYWlsX2FkZHJlc3MiOiJhc2gua2V0Y2h1bUBwYWxsZXR0b3duLmNvbSIsInBob25lX251bWJlciI6IjEyMzQ1Njc4OTAiLCJhZGRyZXNzIjp7InN0cmVldCI6IjY1MSBNYWluIFN0IiwiY2l0eSI6Ik5ld2FyayIsInN0YXRlX2NvZGUiOiJDQSIsInppcGNvZGUiOiI5NDU2MCJ9LCJET0IiOiIxOTkwLTAxLTAxIn0=adclick.zendrive.com

A Sample Request With CURL

curl --location --request GET 'https://adclick.zendrive.com/iql/v3/ad_unit/ad_1/driver_id/010e0a60-8f71-4ca3-9000-e2657c4401/click?auth_token=gAAABjobIQzVN6q6KrLjuO4a705f8Pu5wc3hanuE1Xng4y4_DKojdzmdI1AzVdOD9b3g6-3bkB65_7_iOWo9hPqGFo3XvkmZTZ6COu8dhrP8TVKb1d_FqAprIBmy2D-WxPa-45ZJku4xyhmvksPjTiehhSCtM7hdWfY9JEhjXQhjaqde01hSwTyrRHDGtqCjoRL0BZZRM5P4MuzRrDX05RPAXGsa6Xyw==&pl=eyJmaXJzdF9uYW1lIjoiQXNoIiwibGFzdF9uYW1lIjoiS2V0Y2h1bSIsImVtYWlsX2FkZHJlc3MiOiJhc2gua2V0Y2h1bUBwYWxsZXR0b3duLmNvbSIsInBob25lX251bWJlciI6IjEyMzQ1Njc4OTAiLCJhZGRyZXNzIjp7InN0cmVldCI6IjY1MSBNYWluIFN0IiwiY2l0eSI6Ik5ld2FyayIsInN0YXRlX2NvZGUiOiJDQSIsInppcGNvZGUiOiI5NDU2MCJ9LCJET0IiOiIxOTkwLTAxLTAxIn0%3D'

Response

Redirection to the advertiser's landing page with HTTP status code 302.

Publisher Integration Steps

The Publisher is meant to receive the adClickRedirection URL as part of the adUnit Api. The response is populated in the in the field ad_unit.button_click_url.

Sample URL

The following is a sample URL:

https://adclick.zendrive.com/iql/v3/ad_unit/ad_1/driver_id/010e0a60-8f71-4ca3-9000-e2906c4401/click?auth_token=gAAABjobIQzVN6q6KrLjuO4a705f8Pu5wc3hanuE1Xng4y4_DKojdzmdI1AzVdOD9b3g6-3bkB65_7_iOWo9hPqGFo3XvkmZTZ6COu8dhrP8TVKb1d_FqAprIBmy2D-WxPa-45ZJku4xyhmvksPjTiehhSCtM7hdWfY9JEhjXQhjaqde01hSwTyrRHDGtqCjoRL0BZZRM5P4MuzRrDX05RPAXGsa6Xyw==&pl=%3Cpayload%3Eadclick.zendrive.com

The parameter <payload> serves as placeholder for the URL that will replace it, at the Publisher's end. This will be a URL safe base64 encoded version of the JSON String representing the request payload.

Steps to Generate the Payload String

The following topics detail the steps to generate the payload string:

1. Request Payload as JSON

{
  "first_name": "Ash",
  "last_name": "Ketchum",
  "email_address": "[email protected]",
  "phone_number": "1234567890",
  "address": {
    "street": "651 Main St",
    "city": "Newark",
    "state_code": "CA",
    "zipcode": "94560"
  },
  "DOB": "1990-01-01"
}

2. Convert Payload to JSON String

{"first_name":"Ash","last_name":"Ketchum","email_address":"[email protected]","phone_number":"1234567890","address":{"street":"651 Main St","city":"Newark","state_code":"CA","zipcode":"94560"},"DOB":"1990-01-01"}

3. Convert Payload from a JSON String to a Base64 Encoded String

eyJmaXJzdF9uYW1lIjoiQXNoIiwibGFzdF9uYW1lIjoiS2V0Y2h1bSIsImVtYWlsX2FkZHJlc3MiOiJhc2gua2V0Y2h1bUBwYWxsZXR0b3duLmNvbSIsInBob25lX251bWJlciI6IjEyMzQ1Njc4OTAiLCJhZGRyZXNzIjp7InN0cmVldCI6IjY1MSBNYWluIFN0IiwiY2l0eSI6Ik5ld2FyayIsInN0YXRlX2NvZGUiOiJDQSIsInppcGNvZGUiOiI5NDU2MCJ9LCJET0IiOiIxOTkwLTAxLTAxIn0=

4. Convert Payload to (URL-encoded) Base64 Encoded String

eyJmaXJzdF9uYW1lIjoiQXNoIiwibGFzdF9uYW1lIjoiS2V0Y2h1bSIsImVtYWlsX2FkZHJlc3MiOiJhc2gua2V0Y2h1bUBwYWxsZXR0b3duLmNvbSIsInBob25lX251bWJlciI6IjEyMzQ1Njc4OTAiLCJhZGRyZXNzIjp7InN0cmVldCI6IjY1MSBNYWluIFN0IiwiY2l0eSI6Ik5ld2FyayIsInN0YXRlX2NvZGUiOiJDQSIsInppcGNvZGUiOiI5NDU2MCJ9LCJET0IiOiIxOTkwLTAxLTAxIn0%3D

Request Payload Description

Request Parameter	Description	Type
first_name	First name of the user.	String
last_name	Last name of the user.	String
email_address	Email address of the user.	String
phone_number	Phone number of the user.	String
address	Address of the user. (street, city, state_code, and zipcode).	Object {street : string, city : string, state_code: string, zipcode: string }
DOB	The date of birth of the user.	String (Format - YYYY-MM-DD )

Publishers can now send only the necessary fields based on the advertiser's offer. Tailor the data based on advertiser requirements, following the mandatory fields as needed:

• For Progressive: first_name, last_name, email_address.

• For Geico: first_name, last_name, email_address, zipcode, DOB.

• For Geico Affiliate and Media Alpha: No fields are required.