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

Broadcast Offer Image

Data Structure holding information about an offer's image.  Will also contain a list of sizes so that the best size can be selected.  The sizes shown below are subject to change and can also be defined for each publisher.

Fields:
Field Data Type Nulls Description
caption string
Y
The caption associated with the image.
displayOrder
int
The display order for the image. Useful for slideshows
height int
The height of the image
isOfferImage bool

If the image is part of the main offer images.
sizes list
Contains a list of possible image sizes.
{ description, height, url, width }
tags list

Will contain a list of tags associated with the image.
url string
The url for the image.
width string

The width of the image.
 

Sample JSON Response:
{
    "caption": "Deal Asset",
    "displayOrder": 0,
    "height": 270,
    "isOfferImage": true,
    "sizes": [
        {
            "description": "Publisher Defined",
            "height": 400,
            "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_600_400.jpg",
            "width": 600
        },
        {
            "description": "Google Offers",
            "height": 255,
            "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_340_255.jpg",
            "width": 340
        },
        {
            "description": "GC Small Square",
            "height": 48,
            "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_48_48.jpg",
            "width": 48
        },
        {
            "description": "GC Medium Square",
            "height": 125,
            "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_125_125.jpg",
            "width": 125
        },
        {
            "description": "IAB Wide Skyscraper",
            "height": 600,
            "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_160_600.jpg",
            "width": 160
        },
        {
            "description": "IAB Rectangle",
            "height": 150,
            "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_180_150.jpg",
            "width": 180
        },
        {
            "description": "IAB Medium Rectangle",
            "height": 250,
            "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_300_250.jpg",
            "width": 300
        },
        {
            "description": "IAB Leaderboard",
            "height": 90,
            "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_728_90.jpg",
            "width": 728
        },
        {
            "description": "Groupon Affiliate",
            "height": 90,
            "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_120_90.jpg",
            "width": 120
        },
        {
            "description": "Mobile Portrait",
            "height": 50,
            "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_320_50.jpg",
            "width": 320
        }
    ],
    "tags": [],
    "url": "http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage.jpg",
    "width": "620"
}



Sample XML Response:
<image>
    <caption>Deal Asset</caption>
    <displayOrder>0</displayOrder>
    <height>270</height>
    <isOfferImage>true</isOfferImage>
    <sizes>
        <size>
            <description>Publisher Defined</description>
            <height>400</height>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_600_400.jpg</url>
            <width>600</width>
        </size>
        <size>
            <description>Google Offers</description>
            <height>255</height>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_340_255.jpg</url>
            <width>340</width>
        </size>
        <size>
            <description>GC Small Square</description>
            <height>48</height>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_48_48.jpg</url>
            <width>48</width>
        </size>
        <size>
            <description>GC Medium Square</description>
            <height>125</height>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_125_125.jpg</url>
            <width>125</width>
        </size>
        <size>
            <description>IAB Wide Skyscraper</description>
            <height>600</height>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_160_600.jpg</url>
            <width>160</width>
        </size>
        <size>
            <description>IAB Rectangle</description>
            <height>150</height>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_180_150.jpg</url>
            <width>180</width>
        </size>
        <size>
            <description>IAB Medium Rectangle</description>
            <height>250</height>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_300_250.jpg</url>
            <width>300</width>
        </size>
        <size>
            <description>IAB Leaderboard</description>
            <height>90</height>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_728_90.jpg</url>
            <width>728</width>
        </size>
        <size>
            <description>Groupon Affiliate</description>
            <height>90</height>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_120_90.jpg</url>
            <width>120</width>
        </size>
        <size>
            <description>Mobile Portrait</description>
            <height>50</height>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage_320_50.jpg</url>
            <width>320</width>
        </size>
    </sizes>
    <tags/>
    <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/8069/7754/DCimage.jpg</url>
    <width>620</width>
</image>

Comments