-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
8 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,17 @@ | ||
# Adform Tracking | ||
# Facebook CAPI Server Tag | ||
|
||
This is an unofficial Adform tracking tag for the Google Tag Manager Community Template Gallery. Please raise an issue if you find any bugs or have a question! | ||
This is an unofficial Facebook CAPI server tag for the Google Tag Manager Community Template Gallery. Please raise an issue if you find any bugs or have a question! | ||
|
||
## Documentation | ||
|
||
### Adform Server Domain | ||
### API Access Token | ||
|
||
You can change the default domain of the server (usually track.adform.net) to suit your own needs. Do **not** change this if you were not explicitly asked to! | ||
In order to use Facebook's CAPI, you need an access token for the API. You can generate one [here](https://developers.facebook.com/docs/marketing-api/conversions-api/get-started#access-token). | ||
|
||
### Adform Tracking ID (pm) | ||
### Test Event Code | ||
|
||
This is the Adform client ID, also referred to as *pm*. | ||
You can verify that the tracking works as expected by using the Test Events Tool. [Read more](https://developers.facebook.com/docs/marketing-api/conversions-api/using-the-api#testEvents). | ||
|
||
### Tracking Point Name (pagename) | ||
### Action Source | ||
|
||
This is the name of the tracking point, also referred to as *pagename*. You can set this to a specific string, but it is recommended to either use URL path or custom *pagenames* when tracking across multiple pages. | ||
|
||
`{{Page Path}}` can be used and will generate a tracking point for each page the tag is fired on. You might want to exclude pages which should not be tracked when using the `All Pages` trigger. | ||
|
||
### Variables | ||
|
||
You can track [custom variables](https://support.adform.com/documentation/implement-tracking-points/standard-javascript/variables/) such as sales, order ids, product names or other custom values in addition to the default values. | ||
|
||
#### Variables Object | ||
|
||
You can use a variable which returns an `Object` to track custom variables. Any other type than `Object` is discarded. | ||
|
||
This is helpful when you need to include product data on certain pages, simply return the values you need on the product pages and `undefined` on the rest. | ||
|
||
#### Variables Table | ||
|
||
In addition to a variable, you can also use a table to track custom variables. | ||
|
||
### Optional Parameters | ||
|
||
#### Divider | ||
|
||
Tells Adform which character to use to split up the pagename. The default value is the pipe character `|`. | ||
You can specifiy where your conversions occurred. [Read more](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#action-source). |