snowplow/snowplow-javascript-tracker

View on GitHub
api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.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; [AdConversionEvent](./node-tracker.adconversionevent.md)

## AdConversionEvent interface

An Ad Conversion Event Used to track an advertisement click

<b>Signature:</b>

```typescript
interface AdConversionEvent 
```

## 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 |
|  --- | --- | --- |
|  [action?](./node-tracker.adconversionevent.action.md) | string | <i>(Optional)</i> The type of user interaction e.g. 'purchase' |
|  [advertiserId?](./node-tracker.adconversionevent.advertiserid.md) | string | <i>(Optional)</i> Identifier for the advertiser which the campaign belongs to |
|  [campaignId?](./node-tracker.adconversionevent.campaignid.md) | string | <i>(Optional)</i> Identifier for the advertiser which the campaign belongs to |
|  [category?](./node-tracker.adconversionevent.category.md) | string | <i>(Optional)</i> Conversion category |
|  [conversionId?](./node-tracker.adconversionevent.conversionid.md) | string | <i>(Optional)</i> Identifier for the particular conversion instance |
|  [cost?](./node-tracker.adconversionevent.cost.md) | number | <i>(Optional)</i> Advertisement cost |
|  [costModel?](./node-tracker.adconversionevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | <i>(Optional)</i> The cost model for the campaign |
|  [initialValue?](./node-tracker.adconversionevent.initialvalue.md) | number | <i>(Optional)</i> How much the conversion is initially worth |
|  [property?](./node-tracker.adconversionevent.property.md) | string | <i>(Optional)</i> Describes the object of the conversion |