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

Segment Image

Data Structure holding image information for an image associated with a publisher segment.

Fields:
Field Data Type Nulls Description
caption
string
Y
A short description of the segment image.
fileName
string

The image file name.
imageName string

A logical grouping name for the image. One of  {Background, Segment, Logo, Other}.
height int

The image height.
tags
list

A list of tags (strings) associated with the image.
url string

A url where you can find the image.
width int

The image width.
 

Sample JSON Response:
{
    "caption": "Big bad dinosaur",
    "fileName": "background.jpg",
    "height": 771,
    "imageName": "Background",
    "tags": [],
    "url": "http://www.testsite.com/theimage.jpg",
    "width": 1028
}



Sample XML Response:
<image>
    <caption>Big bad dinosaur</caption>
    <fileName>background.jpg</fileName>
    <height>771</height>
    <imageName>Background</imageName>
    <tags />
    <url>http://www.testsite.com/theimage.jpg</url>
    <width>1028</width>
</image>

Comments