PixelService provides operations for creating and managing pixels.
- Operations
- WSDL (sandbox)
- WSDL (production)
- About Pixels
- Pixel Management
About Pixels
Pixels are Javascript code or transparent images that are inserted into advertiser webpages to count events that occurred on advertiser sites (such as user visits to pages).
Data from the pixel code can provide advertisers insight behind the conversion that occurs on a webpage. A conversion typically occurs when a user makes a purchase on a website; the user converts from shopper to a customer.
A specific trigger action (such as a click, impression, or both) indicates how the user interacted with the ad that resulted in the conversion. When you associate a lookback period with that trigger, data is collected over a specified period of time. The lookback period (click lookback period, impression lookback period, or click and impression lookback period) records data for the specified number of days prior to when the pixel ran and helps you identify how far back in time the user engaged with the ad in order to qualify the conversion as resulting from the ad. You can count every conversion, one conversion per user, or no more than one conversion during a specified time period (blackout).
The pixel code contains criteria for tracking conversions.
Data from the pixel code can be used to track users who visit advertiser pages for audience segments. The expiration time period (up to 28 days) specifies the expiration time for the segment pixel.
The pixel code contains the criteria for tracking user visits for audience segments.
Pixel Management
PixelService provides operations for adding, activating, updating, retrieving, deactivating, and deleting pixels.
Add, Update, Retrieve, and Delete Pixels
To add a pixel, use the addPixel operation and to add a list of pixels, use the addPixels operation. After you add the pixel, use the getPixelCode operation to get pixel code for ad tag types of Javascript and/or image. You can then copy and paste the pixel code into your selected webpage or ad tag.
To update a pixel, use the updatePixel operation and to update a list of pixels, use the updatePixels operation. You can make changes to all tracking criteria.
To set the pixel for a placement, use the setPlacementPixel operation in PlacementService.
To retrieve a pixel by ID, use the getPixel operation and to retrieve a list of pixels by IDs, use the getPixels operation. To retrieve a count of the pixels for an account, use the getPixelCountByAccountID operation and to retrieve the pixels for an account, use the getPixelsByAccountID operation.
Activate and Deactivate Pixels
To activate pixel tracking, use the activatePixel operation and to activate a list of pixels, use the activatePixels operation. To deactivate pixels, use the deactivatePixel operation and to deactivate a list of pixels, use the deactivatePixels operation.
Note: You can deactivate pixels at any time if you don’t want to associate it to any new placements. However, to stop the pixel from running, it must be removed from the web site.
Create, Retrieve, and Delete Piggyback Pixels
Optionally, you can add piggyback pixels to run after your pixel code. Piggyback pixels contain pixel code (typically, third-party pixel code) to run after your pixel code.
To add piggyback pixel, use the setPiggybackPixel operation. You can add more than one piggyback pixel.
To retrieve the piggyback pixel, use the getPiggybackPixels operation. You must provide the ID of the pixel after which the piggyback pixel is set to run.
To delete piggyback pixels, use the deletePiggybackPixels operation.