snowplow/snowplow-javascript-tracker

View on GitHub
api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.md

Summary

Maintainability
Test Coverage
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md)

## AdClickEvent interface

An Ad Click Event Used to track an advertisement click

<b>Signature:</b>

```typescript
interface AdClickEvent 
```

## Remarks

If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [advertiserId?](./node-tracker.adclickevent.advertiserid.md) | string | <i>(Optional)</i> Identifier for the advertiser which the campaign belongs to |
|  [bannerId?](./node-tracker.adclickevent.bannerid.md) | string | <i>(Optional)</i> Identifier for the ad banner being displayed |
|  [campaignId?](./node-tracker.adclickevent.campaignid.md) | string | <i>(Optional)</i> Identifier for the advertiser which the campaign belongs to |
|  [clickId?](./node-tracker.adclickevent.clickid.md) | string | <i>(Optional)</i> Identifier for the particular click instance |
|  [cost?](./node-tracker.adclickevent.cost.md) | number | <i>(Optional)</i> Advertisement cost |
|  [costModel?](./node-tracker.adclickevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | <i>(Optional)</i> The cost model for the campaign |
|  [impressionId?](./node-tracker.adclickevent.impressionid.md) | string | <i>(Optional)</i> Identifier for the particular impression instance |
|  [targetUrl](./node-tracker.adclickevent.targeturl.md) | string | The destination URL of the advertisement |
|  [zoneId?](./node-tracker.adclickevent.zoneid.md) | string | <i>(Optional)</i> Identifier for the zone where the ad banner is located |