Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Data Structures‎ > ‎

Segment

Data Structure holding publisher segment information.

Fields:
Field Data Type Nulls Description
description
string
Y
The description associated with the segment.
externalRefId string
Y
An external identifier for the segment (defined by the publisher).
facebookUrl string
Y
The facebook url defined for the segment.
images
list
 A list of segment images associated with this segment.
key string

Will contain the key name for the segment.  This is the value to be used on all <segmentKey> requests.
latitude float

The latitude entered for the segment location.
longitude float

The longitude entered for the segment location.
name string

Will contain the name of the segment.
notes string
Y
Any notes associated with the segment.
segmentType
string
 The type of the segment.  One of {Geographical, Store}.
state
string
 The segment state.  One of {Current, Coming Soon, Discontinued, Unadvertised}.
timezone string
Y
The timezone id.
twitterUrl string
Y
The twitter Url defined for the segment.
viewOrder int

The order the segments should appear in.
visibleStartDate
datetime
Y
The UTC datetime at which this segment should become visible to users.
visibleEndDate
datetime
Y
The UTC datetime at which this segment should no longer be visible to users.
 

Sample JSON Response:
{
    "description": "",
    "externalRefId": "",
    "facebookUrl": "",
    "images": [ {/*
see segment image */},
                {/*
see segment image */}
],
    "key": "new-york",
    "latitude": 40.47,
    "longitude": -73.58,
    "name": "New York",
    "notes": null,
    "segmentType": "Store",
    "state": "Current",
    "timezone": "Eastern Standard Time",
    "twitterUrl": "",
    "viewOrder": 2,
    "visibleEndDate": null,
    "visibleStartDate": null
}


Sample XML Response:
<segment>
    <description/>
    <externalRefId/>
    <facebookUrl/>
    <images>
        <image><!-- see segment image --></image>
        <image><!-- see segment image --></image>
    </images>
    <key>new-york</key>
    <latitude>40.47</latitude>
    <longitude>-73.58</longitude>
    <name>New York</name>
    <notes i:nil="true"/>
    <segmentType>Store</segmentType>
    <state>Current</state>
    <timezone>Eastern Standard Time</timezone>
    <twitterUrl/>
    <viewOrder>2</viewOrder>
    <visibleEndDate i:nil="true" />
    <visibleStartDate i:nil="true" />
</segment>

Comments