API GDE 2.0

• Introduction
• Error messages
• Users
• Campaign
• Placements
• Media Plan
• Creatives
• Creative Templates
• Creative Codes
• Creative Events
• File Upload
• Tracking Scripts
• Landing Pages
• gT for gDE
• Gemius Traffic
• Indicators
• Basic Stats
• Cost Stats
• Outer Stats
• Progress Stats
• SingleSource
• Filtered Reports
• Systems
• Tech
• Geo
• Campaign Tag1
• Campaign Tag2
• Placement Tag1
• Placement Tag2
• Creative Tag1
• Creative Tag2
• Session

Media Plan

• AddOrder
• UpdateOrder
• DeleteOrder
• GetOrdersList
• GetOrderInfo
• ReplaceCreative
• GetOrderImpressionModesList

AddOrder [finished]

Overlays:

Activation:

AddOrder.php ? sessionID = ... & placementID = ... & creativeIDs = ... & isGdePlus = ...     
    [ & impressionModeID = ... ]
        
    [ & startTS = ... ]
        
    [ & endTS = ... ]
        
    [ & impressionGoal = ... ]
        
    [ & actionGoal = ... ]
        
    [ & clickGoal = ... ]
        
    [ & sharesOfVoices = ... ]
        
    [ & indicatorID = ... ]
        
    [ & threshold = ... ]
        
    [ & daysNumber = ... ]
        
    [ & pricingModelID = ... ]
        
    [ & cost = ... ]

Description:

    Creates new order (flight). No more than 1000 orders can be added in hour.

Parameters:

• sessionID: string(16)
• placementID: uint
• creativeIDs: uint list - creativeIDs can repeat only for ImpressionMode=sequential
• isGdePlus: enum('Y','N')
• impressionModeID: uint
• startTS: nullable uint
• endTS: nullable uint
• impressionGoal: nullable uint
• actionGoal: nullable uint
• clickGoal: nullable uint
• sharesOfVoices: uint list - only for ImpressionMode=ShareOfVoices
• indicatorID: uint - only for ImpressionMode=BestPerforming
• threshold: uint - percentage value (only for ImpressionMode=BestPerforming)
• daysNumber: uint - number of days, after which only the best creatives will be used (only for ImpressionMode=BestPerforming)
• pricingModelID: nullable uint - for cost stats
• cost: nullable uint - for cost stats

Results:

<AddOrder>
    <status>OK</status>
    <orderID>123</orderID>
</AddOrder>

Throw Errors:

---

UpdateOrder [finished]

Overlays:

Activation:

UpdateOrder.php ? sessionID = ... & orderID = ...     
    [ & creativeIDs = ... ]
        
    [ & impressionModeID = ... ]
        
    [ & startTS = ... ]
        
    [ & endTS = ... ]
        
    [ & impressionGoal = ... ]
        
    [ & actionGoal = ... ]
        
    [ & clickGoal = ... ]
        
    [ & sharesOfVoices = ... ]
        
    [ & indicatorID = ... ]
        
    [ & threshold = ... ]
        
    [ & daysNumber = ... ]
        
    [ & pricingModelID = ... ]
        
    [ & cost = ... ]

Description:

    Updates given order (flight).

Parameters:

• sessionID: string(16)
• orderID: uint
• creativeIDs: uint list
• impressionModeID: uint - creativeIDs is required to change this
• startTS: nullable uint
• endTS: nullable uint
• impressionGoal: nullable uint
• actionGoal: nullable uint
• clickGoal: nullable uint
• sharesOfVoices: uint list - only for ImpressionMode=ShareOfVoices, creativeIDs is required to change this
• indicatorID: uint - only for ImpressionMode=BestPerforming
• threshold: uint - percentage value (only for ImpressionMode=BestPerforming)
• daysNumber: uint - number of days, after which only the best creatives will be used (only for ImpressionMode=BestPerforming)
• pricingModelID: nullable uint - for cost stats
• cost: nullable uint - for cost stats

Results:

<UpdateOrder>
    <status>OK</status>
</UpdateOrder>

Throw Errors:

---

DeleteOrder [finished]

Overlays:

Activation:

DeleteOrder.php ? sessionID = ...    
    ( & orderIDs = ... | & placementIDs = ... )

Description:

    Removes given orders (flights)

Parameters:

• sessionID: string(16)
• orderIDs: uint list
• placementIDs: uint list - removes all orders on given placements

Results:

<DeleteOrder>
    <status>OK</status>
</DeleteOrder>

Throw Errors:

---

GetOrdersList [finished]

Overlays:

Activation:

GetOrdersList.php ? sessionID = ...     
    [ & campaignIDs = ... ]
        
    [ & orderIDs = ... ]
        
    [ & placementIDs = ... ]
        
    [ & creativeIDs = ... ]
        
    [ & unassigned = ... ]
        
    [ & startTS = ... ]
        
    [ & endTS = ... ]
        
    [ & sortField = ... ]
        
    [ & sortOrder = ... ]
        
    [ & limit = ... ]
        
    [ & offset = ... ]

Description:

    Returns orders matching specified criteria.

Parameters:

• sessionID: string(16)
• campaignIDs: uint list
• orderIDs: uint list
• placementIDs: uint list
• creativeIDs: uint list
• unassigned: enum('Y','N') default 'N' - shows removed orders and removed creative assignments
• startTS: uint
• endTS: uint
• sortField: enum('creationTS', 'modificationTS', 'startTS', 'endTS')
• sortOrder: enum('asc', 'desc')
• limit: uint - limits result to given number of records
• offset: uint - skips given number of records

Results:

<GetOrdersList>
    <status>OK</status>
    <ordersNumber>1234</ordersNumber> : uint - all records number (if there were no limit and offset)
    <orders>
        <order>
            <orderID>123</orderID> : uint
            <campaignID>123</campaignID> : uint
            <campaignName>banner</campaignName> : string(255)
            <placementID>123</placementID> : uint
            <placementName>asd</placementName> : string(255)
            <orderName>asd</orderName> : string(355)
            <creatives>: creative assignments
                <creative>
                    <creativeID>123</creativeID> : uint
                    <creativeName>kreacja1</creativeName> : string
                </creative>
                <creative>
                    <creativeID>124</creativeID> : uint
                    <creativeName>kreacja2</creativeName> : string
                </creative>
            </creatives>
            <startTS>1242123024</startTS> : nullable uint
            <endTS>1242123024</endTS> : nullable uint
            <isGdePlus>N</isGdePlus> : enum('Y', 'N)
            <impressionModeID>234</impressionModeID> : uint
            <creationTS>1242123024</creationTS> : uint
            <modificationTS>1242123024</modificationTS> : nullable uint
            <deleteTS>1242123024</deleteTS> : nullable uint
        </order>
    </orders>
</GetOrdersList>

Throw Errors:

---

GetOrderInfo [finished]

Overlays:

Activation:

GetOrderInfo.php ? sessionID = ... & orderID = ...

Description:

    Returns information about given order.

Parameters:

• sessionID: string(16)
• orderID: uint

Results:

<GetOrderInfo>
    <status>OK</status>
    <orders>
        <order>
            <campaignID>123</campaignID> : uint
            <placementID>123</placementID> : uint
            <placementName>asd</placementName> : string(255)
            <orderName>asd</orderName> : string(355)
            <creativeIDs>123,124</creativeIDs> : uint list - creative assignments
            <startTS>1242123024</startTS> : nullable uint
            <endTS>1242123024</endTS> : nullable uint
            <isGdePlus>N</isGdePlus> : enum('Y', N')
            <creationTS>1242123024</creationTS> : uint
            <modificationTS>1242123024</modificationTS> : nullable uint
            <deleteTS>1242123024</deleteTS> : nullable uint
            <impressionGoal>124</impressionGoal> : nullable uint
            <clickGoal>124</clickGoal> : nullable uint
            <actionGoal>124</actionGoal> : nullable uint
            <pricingModelID>3</pricingModelID> : nullable uint
            <pricingModelName>3</pricingModelName> : string(100)
            <cost>1000</cost> : nullable uint
            <impressionModeID>234</impressionModeID> : nullable uint
            <impressionModeName>234</impressionModeName> : string(100)
            <sharesOfVoices>30,70</sharesOfVoices> : uint list
            <indicatorID>3</indicatorID> : nullable uint
            <indicatorName>CRU</indicatorName> : string(63)
            <threshold>4</threshold> : nullable uint
            <daysNumber>6</daysNumber> : nullable uint
        </order>
    </orders>
</GetOrderInfo>

Throw Errors:

---

ReplaceCreative [finished]

Overlays:

Activation:

ReplaceCreative.php ? sessionID = ... & campaignID = ...     
    [ & placementIDs = ... ]
        
    [ & orderIDs = ... ]
        & creativeID = ... & newCreativeID = ...

Description:

    Replaces creative in orders, depends on impression mode:
    - for Sequential: 1-2-3 replacing 1 -> 2 will result in 2-2-3
    - for other: 1-2-3 replacing 1 -> 2 will result in 2-3

Parameters:

• sessionID: string(16)
• campaignID: uint
• placementIDs: uint list
• orderIDs: uint list
• creativeID: uint
• newCreativeID: uint

Results:

<ReplaceCreative>
    <status>OK</status>
</ReplaceCreative>

Throw Errors:

---

GetOrderImpressionModesList [finished]

Overlays:

Activation:

GetOrderImpressionModesList.php ? sessionID = ...

Description:

    Returns list of possible impression modes:
        - Random
        - BestPerforming
        - Cycled
        - Sequential
        - ShareOfVoices

Parameters:

• sessionID: string(16)

Results:

<GetOrderImpressionModesList>
    <status>OK</status>
    <modesNumber>1234</modesNumber> : uint - records number
    <modes>
        <mode>
            <modeID>1</modeID> : uint
            <name>Random</name> : string(100)
        </mode>
    </modes>
</GetOrderImpressionModesList>

Throw Errors:

---