Welcome‎ > ‎Version 3‎ > ‎Broadcast Api (Read Only)‎ > ‎Data Structures‎ > ‎

Broadcast 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.
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.
state
string
 The segment state.  One of {Current, Coming Soon}
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.
 

Sample JSON Response:
{
    "description": "",
    "externalRefId": "",
    "facebookUrl": "",
    "key": "new-york",
    "latitude": 40.47,
    "longitude": -73.58,
    "name": "New York",
    "notes": null,
    "state": "Current",
    "timezone": "Eastern Standard Time",
    "twitterUrl": "",
    "viewOrder": 2
}



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

Comments