The Segment Service lets you create segment IDs, which are then used to create pixels for placement on inventory pages (see Pixel Services for more information). If you are working with third-party data providers through the AppNexus platform, it will also show you a list of segments for those providers.
- Segments are associated with members.
- All segment data will be stored in the User Data Store (the user's cookie) and passed to the bidder associated with the owning member on every bid request.
Segments will not fire unless associated with active members
A segment will not fire if its owning member is not active. This is true even if the segment itself is active.
To see all Segments for a member:
GET calls to this service will receive a maximum of 100 segments in the response. For more information about pagination, see API Best Practices.
To see a particular Segment:
To add a new Segment:
To modify an existing Segment:
To delete an existing Segment:
yes (on update only)
AppNexus ID assigned by the API to reference this segment.
no, default is active
Boolean value - determines whether the segment can be used.
Optional description for this segment.
The member ID that owns this segment.
User-defined field for calling this segment via codes. More info can be found on the Segment Pixels Page.
User-defined string (optional) to designate the provider of the data
no, default is $0
Deprecated. This field is currently not operational
A name used to describe the segment. This will be passed on the bid requests.
The number of minutes the user is kept in the segment. If you want to keep the user in the segment for retargeting purposes, set to the desired number of minutes (or
To keep users in the segment for the 180 day maximum, set this to
Read only for now. Can be null.
The timestamp of last modification to this segment.
Not currently in use.
To create a segment, you will create a text file in JSON format. Below we have used the "cat" command to output an example segment JSON file.
You will add this JSON-formatted file with a POST request and receive the segment ID, which in this case is 5005.
To view information about a particular segment, use a GET request.
See Pixel Services to learn more about segment pixels. The basic format is: