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

Creatives

• AddCreative
• CopyCreative
• UpdateCreative
• DeleteCreative
• GetCreativesList
• SearchCreative
• GetCreativeInfo

AddCreative [finished]

Overlays:

Activation:

AddCreative.php ? sessionID = ... & campaignID = ... & name = ... & formID = ... & isGdePlus = ...    
    ( & typeID = ... | & templateID = ... )    
    [ & isBlocked = ...]
        
    [ & comments = ... ]
        
    [ & tag1ID = ... ]
        
    [ & tag2ID = ... ]
        
    [ & label1 = ... ]
        
    [ & label2 = ... ]
        
    [ & isRetargeted = ... ]

Description:

    Adds new Creative. If it is GdePlus then templateID should be provided, else typeID should be provided.
    No more than 1000 creatives can be added in hour.

Parameters:

• sessionID: string(16)
• campaignID: uint
• name: string(255)
• formID: uint
• isGdePlus: enum('Y', 'N')
• typeID: uint
• templateID: uint
• isBlocked: enum('Y', 'N') - default=N only for GDE+ creative, blocked creative is not emitted
• comments: string(255)
• tag1ID: nullable uint
• tag2ID: nullable uint
• label1: string(63)
• label2: string(63)
• isRetargeted: enum('Y', 'N') - default=N

Results:

<AddCreative>
    <status>OK</status>
    <creatives>
        <creative>
            <creativeID>1234</creativeID> : uint
            <campaignID>1234</campaignID> : uint
            <creativeCodeID>1234</creativeCodeID> : uint - ID of current creative code assigned to creative
            <name>some creative</name> : string(255)
            <formID>12</formID> : uint
            <formName>100x300</formName> : string(100)
            <typeID>13</typeID> : uint
            <typeName>XML</typeName> : string(100)
            <isGdePlus>Y</isGdePlus> : enum('Y', 'N')
            <isBlocked>N</isBlocked> : enum('Y', 'N')
            <alignmentPossible>Y</alignmentPossible> : enum('Y', 'N')
            <templateID>14</templateID> : nullable uint
            <templateName>XML</templateName> : string(63)
            <version>13</version> : uint - current version of creative
            <modificationTS>1242123024</modificationTS> : nullable uint
            <creationTS>1242123024</creationTS> : uint
            <comments>abc</comments> : string(255)
            <tag1ID>23</tag1ID> : nullable uint
            <tag1Name>1a</tag1Name> : string(255)
            <tag2ID>34</tag2ID> : nullable uint
            <tag2Name>2b</tag2Name> : string(255)
            <label1>23asda453h45jkh345</label1> : string(63)
            <label2>23asda453h45jkh345</label2> : string(63)
            <isRetargeted>N</isRetargeted> : enum('Y', 'N')
            <hasEmitterCode>Y</hasEmitterCode> : nullable enum('Y', 'N') - only for GDE+ creatives
        </creative>
    </creatives>
</AddCreative>

Throw Errors:

---

CopyCreative [finished]

Overlays:

Activation:

CopyCreative.php ? sessionID = ... & sourceCreativeID = ... & destCampaignID = ...

Description:

    Copies given creative into given campaign. The last version of creative code is copied.
    No more than 1000 creatives can be created in hour.

Parameters:

• sessionID: string(16)
• sourceCreativeID: uint
• destCampaignID: uint

Results:

<CopyCreative>
    <status>OK</status>
    <creativeID>1234</creativeID> : uint - ID of copied creative
    <codeID>34</codeID> : uint - ID of creative code assigned to copied creative
</CopyCreative>

Throw Errors:

---

UpdateCreative [finished]

Overlays:

Activation:

UpdateCreative.php ? sessionID = ... & creativeID = ...     
    [ & name = ... ]
        
    [ & formID = ... ]
        
    [ & typeID = ... ]
        
    [ & isBlocked = ... ]
        
    [ & comments = ... ]
        
    [ & tag1ID = ... ]
        
    [ & tag2ID = ... ]
        
    [ & label1 = ... ]
        
    [ & label2 = ... ]

Description:

    Changes creative.

Parameters:

• sessionID: string(16)
• creativeID: uint
• name: string(255)
• formID: uint
• typeID: uint
• isBlocked: enum('Y', 'N') - only for GDE+
• comments: string(255)
• tag1ID: nullable uint
• tag2ID: nullable uint
• label1: string
• label2: string

Results:

<UpdateCreative>
    <status>OK</status>
    <creatives>
        <creative>
            <creativeID>1234</creativeID> : uint
            <campaignID>1234</campaignID> : uint
            <creativeCodeID>1234</creativeCodeID> : uint - ID of current creative code assigned to creative
            <name>some creative</name> : string(255)
            <formID>12</formID> : uint
            <formName>100x300</formName> : string(100)
            <typeID>13</typeID> : uint
            <typeName>XML</typeName> : string(100)
            <isGdePlus>Y</isGdePlus> : enum('Y', 'N')
            <isBlocked>N</isBlocked> : enum('Y', 'N')
            <alignmentPossible>Y</alignmentPossible> : enum('Y', 'N')
            <templateID>14</templateID> : nullable uint
            <templateName>XML</templateName> : string(63)
            <version>13</version> : uint - current version of creative
            <modificationTS>1242123024</modificationTS> : nullable uint
            <creationTS>1242123024</creationTS> : uint
            <comments>14</comments> : string(255)
            <tag1ID>23</tag1ID> : nullable uint
            <tag1Name>1a</tag1Name> : string(255)
            <tag2ID>34</tag2ID> : nullable uint
            <tag2Name>2b</tag2Name> : string(255)
            <label1>23asda453h45jkh345</label1> : string(63)
            <label2>23asda453h45jkh345</label2> : string(63)
            <isRetargeted>N</isRetargeted> : enum('Y', 'N')
            <hasEmitterCode>Y</hasEmitterCode> : nullable enum('Y', 'N') - only for GDE+ creatives
        </creative>
    </creatives>
</UpdateCreative>

Throw Errors:

---

DeleteCreative [finished]

Overlays:

Activation:

DeleteCreative.php ? sessionID = ... & creativeID = ...

Description:

    Deletes creative.

Parameters:

• sessionID: string(16)
• creativeID: uint

Results:

<DeleteCreative>
    <status>OK</status>
</DeleteCreative>

Throw Errors:

---

GetCreativesList [finished]

Overlays:

Activation:

GetCreativesList.php ? sessionID = ...     
    [ & campaignIDs = ... ]
        
    [ & creativeIDs = ... ]
        
    [ & tag1IDs = ... ]
        
    [ & tag2IDs = ... ]
        
    [ & labels1 = ... ]
        
    [ & labels2 = ... ]
        
    [ & formID = ... ]
        
    [ & typeID = ... ]
        
    [ & isGdePlus = ... ]
        
    [ & isBlocked = ... ]
        
    [ & hasEmitterCode = ... ]
        
    [ & namePattern = ... ]
        
    [ & commentsPattern = ... ]
        
    [ & sortField = ... ]
        
    [ & sortOrder = ... ]
        
    [ & limit = ... ]
        
    [ & offset = ... ]

Description:

    Returns creative list matching specified criteria.

Parameters:

• sessionID: string(16)
• campaignIDs: uint list
• creativeIDs: uint list
• tag1IDs: uint list
• tag2IDs: uint list
• labels1: string list
• labels2: string list
• formID: uint
• typeID: uint
• isGdePlus: enum('Y', 'N')
• isBlocked: enum('Y', 'N')
• hasEmitterCode: enum('Y', 'N')
• namePattern: string(100)
• commentsPattern: string(255)
• sortField: enum('name', 'typeName', 'formName', 'templateName', 'isGdePlus', 'version', 'label1', 'label2','tag1Name','tag2Name', 'creationTS', 'modificationTS')
• sortOrder: enum('asc', 'desc')
• limit: uint - limits result to given number of records
• offset: uint - skips given number of records

Results:

<GetCreativesList>
    <status>OK</status>
    <creativesNumber>1234</creativesNumber> : uint - all records number (if there were no limit and offset)
    <creatives>
        <creative>
            <creativeID>1234</creativeID> : uint
            <creativeCodeID>1234</creativeCodeID> : uint - ID of current creative code assigned to creative
            <name>some creative</name> : string(255)
            <campaignID>23</campaignID> : uint
            <campaignName>banner</campaignName> : string(255)
            <typeID>13</typeID> : uint
            <typeName>13</typeName> : string(100)
            <formID>13</formID> : uint
            <formName>100x200</formName> : string(100)
            <templateID>13</templateID> : nullable uint
            <templateName>XML</templateName> : string(63)
            <isGdePlus>Y</isGdePlus> : enum('Y', 'N')
            <isBlocked>N</isBlocked> : enum('Y', 'N')
            <unresolvedMacros>Y</unresolvedMacros> : deprecated nullable enum('Y', 'N') - only for GDE+ creatives
            <version>3</version> : uint - current version of creative
            <tag1ID>23</tag1ID> : uint
            <tag1Name>Funny Pictures</tag1Name> : string(255)
            <tag2ID>23</tag2ID> : uint
            <tag2Name>Animals</tag2Name> : string(255)
            <label1>23asda453h45jkh345</label1> : string(63)
            <label2>23asda453h45jkh345</label2> : string(63)
            <isRetargeted>N</isRetargeted> : enum('Y', 'N')
            <hasEmitterCode>Y</hasEmitterCode> : nullable enum('Y', 'N') - only for GDE+ creatives
            <comments>blablabla</comments> : string(255)
            <creationTS>1242123024</creationTS> : uint
            <modificationTS>1242123024</modificationTS> : nullable uint
        </creative>
    </creatives>
</GetCreativesList>

Throw Errors:

---

SearchCreative [finished]

Overlays:

Activation:

SearchCreative.php ? sessionID = ...     
    [ & campaignID = ... ]
        
    [ & placementIDs = ... ]
        
    [ & orderIDs = ... ]
        
    [ & assigned = ... ]
        
    [ & pattern = ... ]
        
    [ & matchingField = ... ]
        
    [ & isGdePlus = ... ]
        
    [ & formID = ... ]
        
    [ & typeID = ... ]
        
    [ & sortField = ... ]
        
    [ & sortOrder = ... ]
        
    [ & limit = ... ]
        
    [ & offset = ... ]

Description:

    Returns list containing creativeID and matching field, matching specified criteria. Faster than GetCreativesList.

Parameters:

• sessionID: string(16)
• campaignID: uint
• placementIDs: uint list - publishers cannot pass placement nodes here
• orderIDs: uint list
• assigned: enum('Y', 'N') default Y
• pattern: string(100) - pattern for matching field
• matchingField: enum('name', 'comments', 'label1', 'label2')
• isGdePlus: enum('Y', 'N')
• formID: uint
• typeID: uint
• sortField: enum('name', 'typeName', 'formName', 'templateName', 'isGdePlus', 'version', 'label1', 'label2','tag1Name','tag2Name', 'creationTS', 'modificationTS')
• sortOrder: enum('asc', 'desc')
• limit: uint - limits result to given number of records
• offset: uint - skips given number of records

Results:

<SearchCreative>
    <status>OK</status>
    <creativesNumber>1234</creativesNumber> : uint - all records number (if there were no limit and offset)
    <creatives>
        <creative>
            <creativeID>1234</creativeID> : uint
            <matchingField>some creative</matchingField> : string(255)
            <isGdePlus>Y</isGdePlus> : enum('Y', 'N')
        </creative>
    </creatives>
</SearchCreative>

Throw Errors:

---

GetCreativeInfo [finished]

Overlays:

Activation:

GetCreativeInfo.php ? sessionID = ... & creativeID = ...

Description:

    Returns information about given creative.

Parameters:

• sessionID: string(16)
• creativeID: uint

Results:

<GetCreativeInfo>
    <status>OK</status>
    <creatives>
        <creative>
            <creativeID>1234</creativeID> : uint
            <campaignID>1234</campaignID> : uint
            <creativeCodeID>1234</creativeCodeID> : uint - ID of current creative code assigned to creative
            <name>some creative</name> : string(255)
            <formID>12</formID> : uint
            <formName>100x300</formName> : string(100)
            <typeID>13</typeID> : uint
            <typeName>XML</typeName> : string(100)
            <isGdePlus>Y</isGdePlus> : enum('Y', 'N')
            <isBlocked>N</isBlocked> : enum('Y', 'N')
            <alignmentPossible>Y</alignmentPossible> : enum('Y', 'N')
            <templateID>14</templateID> : nullable uint
            <templateName>XML</templateName> : string(63)
            <version>13</version> : uint - current version of creative
            <modificationTS>1242123024</modificationTS> : nullable uint
            <creationTS>1242123024</creationTS> : uint
            <comments>14</comments> : string(255)
            <tag1ID>23</tag1ID> : nullable uint
            <tag1Name>1a</tag1Name> : string(255)
            <tag2ID>34</tag2ID> : nullable uint
            <tag2Name>2b</tag2Name> : string(255)
            <label1>23asda453h45jkh345</label1> : string(63)
            <label2>23asda453h45jkh345</label2> : string(63)
            <isRetargeted>N</isRetargeted> : enum('Y', 'N')
            <hasEmitterCode>Y</hasEmitterCode> : nullable enum('Y', 'N') - only for GDE+ creatives
        </creative>
    </creatives>
</GetCreativeInfo>

Throw Errors:

---