Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table Plus
sortColumnField

Field

Type

Description

Default

Required On

id

int

The AppNexus ID assigned by the API to reference the segment. When switching a segment from advertiser-owned to network-owned, you must pass this information in the querystring.

 

PUT, in querystring

code

string(50)

The user-defined code for calling the segment. For more information, see Working with Segments (Customer login required).

Info

The value of the code field is not case-sensitive (e.g., "Test" is the same as "test"), so each code must be unique regardless of case. However, when referring to the code in query string targeting, case-sensitivity matters (e.g., if the value of the code field is "Test", the parameter in a query string referring to it must also be "Test").

  

state

enum

The state of the segment. This determines whether the segment can be used. Possible values: active or inactive.

active

 

short_name

string(255)

The short name used to describe the segment.

  

description

string

The optional description for this segment.

  

member_id

int

The ID of the member that owns this segment.

Tip

When switching a segment from advertiser-owned to network-owned, you must pass this information in the query string. See this example for more details.

  

category

string

Deprecated. This field is read-only.  

price

double

Deprecated. This field is currently not operational

0

 

expire_minutes

int

The number of minutes the user is kept in the segment. Segments with no expiration time will be expired from AppNexus's server-side data store within 90 days. If you want to add the user to the segment only for the duration of the ad call, set to 0. Changing this value does not retroactively affect users already in the segment. Also, if a user is re-added, the expiration window resets.

Tip

To keep users in the segment for the 180 day maximum, set this to null.

  

enable_rm_piggyback

boolean

If true, piggybacking RM pixels is enabled.

  

max_usersync_pixels

int

The maximum number of third-party user sync pixels to piggyback onto the segment pixel. Set to 0 to block all third-party user sync pixels. If blank (null), the segment defaults to 0.

0 

last_modified

timestamp

The date and time when the segment was last modified.

  

provider_id

string

Not yet supported.

int

The ID of the data provider that owns the segment. It is read-only and can be used for filtering segments.

 

null

 

advertiser_id

int

The ID of the advertiser using the segment if the segment should be on the Advertiser level rather than the Network level. If null, the segment will be usable by all advertisers for that member. This information is for reference in Console.

null

 

piggyback_pixels

array

The URLs of the pixels you want us to fire when the segment pixel fires. See Piggyback Pixels below for more details.

  

parent_segment_id

int

The ID of the parent segment. If the parent segment is targeted in a profile, the direct child segments are targeted as well.

Note

The parent_segment_id field will be deprecated on January 1, 2019

Info

The parent-child logic extends only one level deep. Example: Segment A is the parent of segment B and segment C, and segment C is the parent of segment D. When segment A is targeted, segment B and segment C are targeted as well, but segment D is not.

  

querystring_mapping

object

A query string that allows you to assign a set of parameters and values to a segment. See About Query Strings for a general description of query strings and Query String Mapping for more details.

Note

Invalid if a querystring_mapping_key_value object is also included.

  
querystring_mapping_key_valueobject

A query string that allows you to reuse a key and assign a single key-value pair to a segment. See About Query Strings for a general description of query strings and Query String Mapping Key Value for more details.

Note

Invalid if a querystring_mapping object is also included.

Note

The value of the querystring_mapping_key_value field is case-insensitive when it is looked up in an auction.

  

...