Skip to content

Commit b28746c

Browse files
Applying documentation updates.
1 parent 466b137 commit b28746c

File tree

647 files changed

+7169
-6100
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

647 files changed

+7169
-6100
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [advertiserId](./node-tracker.adclickevent.advertiserid.md)
4+
5+
## AdClickEvent.advertiserId property
6+
7+
Identifier for the advertiser which the campaign belongs to
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
advertiserId?: string;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [bannerId](./node-tracker.adclickevent.bannerid.md)
4+
5+
## AdClickEvent.bannerId property
6+
7+
Identifier for the ad banner being displayed
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
bannerId?: string;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [campaignId](./node-tracker.adclickevent.campaignid.md)
4+
5+
## AdClickEvent.campaignId property
6+
7+
Identifier for the advertiser which the campaign belongs to
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
campaignId?: string;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [clickId](./node-tracker.adclickevent.clickid.md)
4+
5+
## AdClickEvent.clickId property
6+
7+
Identifier for the particular click instance
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
clickId?: string;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [cost](./node-tracker.adclickevent.cost.md)
4+
5+
## AdClickEvent.cost property
6+
7+
Advertisement cost
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
cost?: number;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [costModel](./node-tracker.adclickevent.costmodel.md)
4+
5+
## AdClickEvent.costModel property
6+
7+
The cost model for the campaign
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
costModel?: "cpa" | "cpc" | "cpm";
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [impressionId](./node-tracker.adclickevent.impressionid.md)
4+
5+
## AdClickEvent.impressionId property
6+
7+
Identifier for the particular impression instance
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
impressionId?: string;
13+
```
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md)
4+
5+
## AdClickEvent interface
6+
7+
An Ad Click Event Used to track an advertisement click
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
interface AdClickEvent
13+
```
14+
15+
## Remarks
16+
17+
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
18+
19+
## Properties
20+
21+
| Property | Type | Description |
22+
| --- | --- | --- |
23+
| [advertiserId?](./node-tracker.adclickevent.advertiserid.md) | string | <i>(Optional)</i> Identifier for the advertiser which the campaign belongs to |
24+
| [bannerId?](./node-tracker.adclickevent.bannerid.md) | string | <i>(Optional)</i> Identifier for the ad banner being displayed |
25+
| [campaignId?](./node-tracker.adclickevent.campaignid.md) | string | <i>(Optional)</i> Identifier for the advertiser which the campaign belongs to |
26+
| [clickId?](./node-tracker.adclickevent.clickid.md) | string | <i>(Optional)</i> Identifier for the particular click instance |
27+
| [cost?](./node-tracker.adclickevent.cost.md) | number | <i>(Optional)</i> Advertisement cost |
28+
| [costModel?](./node-tracker.adclickevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | <i>(Optional)</i> The cost model for the campaign |
29+
| [impressionId?](./node-tracker.adclickevent.impressionid.md) | string | <i>(Optional)</i> Identifier for the particular impression instance |
30+
| [targetUrl](./node-tracker.adclickevent.targeturl.md) | string | The destination URL of the advertisement |
31+
| [zoneId?](./node-tracker.adclickevent.zoneid.md) | string | <i>(Optional)</i> Identifier for the zone where the ad banner is located |
32+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [targetUrl](./node-tracker.adclickevent.targeturl.md)
4+
5+
## AdClickEvent.targetUrl property
6+
7+
The destination URL of the advertisement
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
targetUrl: string;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [zoneId](./node-tracker.adclickevent.zoneid.md)
4+
5+
## AdClickEvent.zoneId property
6+
7+
Identifier for the zone where the ad banner is located
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
zoneId?: string;
13+
```

0 commit comments

Comments
 (0)