publisher/creative/generic
The generic creative resource allows a publisher to pull a generic link for the advertisers they're working with.
Note:
Each advertiser's program has exactly one Generic Link creative. While the destination of the link can change, the content of the generic creative (i.e. the URL in the response) will remain static. Therefore, this creative only needs to be pulled once and can be stored locally.
GET | ||||
---|---|---|---|---|
Request Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
id | A comma-separated list of ids to filter by. | * 123,456,789 | N/A | No |
programId | A comma-separated list of program ids to filter by. | * 123,456,789 | N/A | No |
websiteId | A single website id used for website tracking. Adding this will add this parameter to your tracking link. | * 123,456,789 | N/A | No |
sid | A single SID parameter used for publisher tracking. Adding this will add this parameter to your tracking link. | * Any generic string | N/A | No |
deepLink | A single parameter used to deep link creatives. Adding this will add this parameter to your tracking link if the creative allows deep linking. | * A URL of the resource you want to link to | N/A | No |
encrypted | A single boolean value that indicates whether the tracking link should be encrypted. Adding this will encrypt your tracking link. | 1, 0 | Un-encrypted | No |
Response Fields | ||||
Field | Description | Notes | ||
id | Advertiser's generic link ID | |||
allow_deep_link | Boolean flag that determines whether deep linking is enabled | |||
code | The actual code for the creative | |||
program_id | The id of the program that the creative belongs to | |||
program_name | The name of the program the creative belongs to |
* Values shown are placeholder values. Please replace with actual data.