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

Landing Pages

• AddCampaignAction
• CopyCampaignAction
• UpdateCampaignAction
• DeleteCampaignAction
• GetCampaignActionsList
• GetCampaignActionInfo
• GetGt2SourcesList
• GetGt2ParamsList
• GetGt2ConditionsList
• GetActionPathsList
• AddActionPath
• DeleteActionPath
• UpdateActionPath

Successful clicks & Actions

AddCampaignAction [finished]

Overlays:

Activation:

AddCampaignAction.php ? sessionID = ... & campaignID = ...     
    [ & name = ... ]
        & type = ... & gtScriptIDs = ...     
    [ & sourceID = ... ]
        
    [ & paramID = ... ]
        
    [ & conditionID = ... ]
        
    [ & paramValue = ... ]
        
    [ & hitFlagEventType = ... ]

Description:

    Adds successful clicks or actions to campaign. No more than 1000 actions/successful clicks can be added in hour.

Parameters:

• sessionID: string(16)
• campaignID: uint | clickTagID - uint)
• name: string(255)
• type: enum('actionPage','successfulClick')
• gtScriptIDs: uint list | gTidentifier - string | gT2projectID : uint)
• sourceID: uint
• paramID: uint | [ paramName ] - string)
• conditionID: uint
• paramValue: string
• hitFlagEventType: enum('view','event')

Results:

<AddCampaignAction>
    <status>OK</status>
    <actions>
        <action>
            <actionID>1234</actionID> : nullable uint
            <actionName>label1</actionName> : string(255)
            <added>Y</added> : enum('Y','N') - whether action has been successfully added
            <scriptID>2345</scriptID> : uint
            <gtIdentifier>d658274h658234hry578234y68</gtIdentifier> : string(255) - set when action comes from gT1
            <gt2projectID>4343255</gt2projectID> : nullable uint - set when action comes from gT2
        </action>
    </actions>
</AddCampaignAction>

Throw Errors:

---

CopyCampaignAction [finished]

Overlays:

Activation:

CopyCampaignAction.php ? sessionID = ... & actionIDs = ... & destCampaignID = ...

Description:

    Copy successful clicks or actions to campaign. No more than 1000 actions/successful clicks can be added in hour.

Parameters:

• sessionID: string(16)
• actionIDs: uint list - all actions have to be from one campaign different from destination campaign
• destCampaignID: uint

Results:

<CopyCampaignAction>
    <status>OK</status>
    <actions>
        <action>
            <actionID>1234</actionID> : nullable uint
            <sourceActionID>label1</sourceActionID> : uint
            <added>Y</added> : enum('Y','N') - whether action has been successfully added
        </action>
    </actions>
</CopyCampaignAction>

Throw Errors:

---

UpdateCampaignAction [finished]

Overlays:

Activation:

UpdateCampaignAction.php ? sessionID = ... & actionID = ...     
    [ & name = ... ]
        
    [ & gtScriptID = ... ]
        
    [ & sourceID = ... ]
        
    [ & paramID = ... ]
        
    [ & conditionID = ... ]
        
    [ & paramValue = ... ]

Description:

    Changes successful click or action data.

Parameters:

• sessionID: string(16)
• actionID: uint
• name: string(255)
• gtScriptID: uint | [ gTidentifier ] - string | [ gT2projectID ] : uint)
• sourceID: uint
• paramID: uint | [ paramName ]) - string
• conditionID: uint
• paramValue: string

Results:

<UpdateCampaignAction>
    <status>OK</status>
    <actions>
        <action>
            <actionID>1234</actionID> : nullable uint
            <actionName>label1</actionName> : string(255)
            <added>Y</added> : enum('Y','N') - always Y (consistency with AddCampaignAction)
            <scriptID>2345</scriptID> : uint
            <gtIdentifier>d658274h658234hry578234y68</gtIdentifier> : string(255) - set when action comes from gT1
            <gt2projectID>4343255</gt2projectID> : nullable uint - set when action comes from gT2
        </action>
    </actions>
</UpdateCampaignAction>

Throw Errors:

---

DeleteCampaignAction [finished]

Overlays:

Activation:

DeleteCampaignAction.php ? sessionID = ... & actionIDs = ...

Description:

    Deletes successful click or action data.

Parameters:

• sessionID: string(16)
• actionIDs: uint list

Results:

<DeleteCampaignAction>
    <status>OK</status>
</DeleteCampaignAction>

Throw Errors:

---

GetCampaignActionsList [finished]

Overlays:

Activation:

GetCampaignActionsList.php ? sessionID = ... & campaignIDs = ...     
    [ & actionIDs = ... ]
        
    [ & namePattern = ... ]
        
    [ & types = ... ]
        
    [ & copyable = ... ]
        
    [ & sortField = ... ]
        
    [ & sortOrder = ... ]
        
    [ & limit = ... ]
        
    [ & offset = ... ]

Description:

        Returns successful clicks and actions for given campaigns, matching specified criteria.

Parameters:

• sessionID: string(16)
• campaignIDs: uint list
• actionIDs: uint list
• namePattern: string(32)
• types: enum('actionPage','successfulClick') list
• copyable: enum('Y','N') - filter to list only actions without (Y) or with (N) clicktags assigned
• sortField: enum('name','system','extScriptName','extProject','extAccount','type','detailedType','creationTS','modificationTS')
• sortOrder: enum('asc','desc')
• limit: uint - limits result to given number of records
• offset: uint - skips given number of records

Results:

<GetCampaignActionsList>
    <status>OK</status>
    <actionsNumber>1234</actionsNumber> : uint
    <actions>
        <action>
            <actionID>1234</actionID> : uint
            <actionName>label1</actionName> : string(255)
            <type>successfulClick</type> : enum('actionPage','successfulClick')
            <detailedType>successfulClick</detailedType> : enum('actionPage','successfulClick','successfulClickForCreative')
            <system>gT2</system> : enum('gDE,gT1,gT2)
            <scriptID>2345</scriptID> : uint
            <extScriptName>script name</extScriptName> : string(255)
            <extProjectName>projekt</extProjectName> : string(255)
            <extAccount>Gt4Gde</extAccount> : string(255)
            <campaignID>1</campaignID> : uint
            <campaignName>banner campaign</campaignName> : string
            <creationTS>1242123024</creationTS> : uint
            <modificationTS>1242123024</modificationTS> : nullable uint
        </action>
    </actions>
</GetCampaignActionsList>

Throw Errors:

---

GetCampaignActionInfo [finished]

Overlays:

Activation:

GetCampaignActionInfo.php ? sessionID = ... & actionID = ...

Description:

     Returns detailed informations about selected action/successful click

Parameters:

• sessionID: string(16)
• actionID: uint

Results:

<GetCampaignActionInfo>
    <status>OK</status>
    <actions>
        <action>
            <actionID>1234</actionID> : uint
            <actionName>label1</actionName> : string(255)
            <type>successfulClick</type> : enum('actionPage','successfulClick')
            <detailedType>successfulClick</detailedType> : enum('actionPage','successfulClick','successfulClickForCreative')
            <system>gT2</system> : enum('gDE,gT1,gT2)
            <scriptID>2345</scriptID> : uint
            <extScriptName>script name</extScriptName> : string(255)
            <extProjectName>projekt</extProjectName> : string(255)
            <extAccount>Gt4Gde</extAccount> : string(255)
            <campaignID>1</campaignID> : uint
            <campaignName>banner campaign</campaignName> : string
            <creativeID>12</creativeID> : nullable uint
            <creativeName>banner</creativeName> : string
            <clickTagID>56</clickTagID> : nullable uint
            <clickTagName>Default</clickTagName> : string
            <sourceID>3</sourceID> : nullable uint
            <sourceName>URL parameter</sourceName> : string
            <paramID>4</paramID> : nullable uint
            <paramName>domain</paramName> : string
            <conditionID>5</conditionID> : nullable uint
            <conditionName>contains</conditionName> : string
            <paramValue>blabla</paramValue> : string
            <hitFlagEventType>view</hitFlagEventType> : enum ('view','event')
            <creationTS>1242123024</creationTS> : uint
            <modificationTS>1242123024</modificationTS> : nullable uint
        </action>
    </actions>
</GetCampaignActionInfo>

Throw Errors:

---

GetGt2SourcesList [finished]

Overlays:

Activation:

GetGt2SourcesList.php ? sessionID = ... & showOptions = ...

Description:

     Returns list of gemiusTraffic2 sources

Parameters:

• sessionID: string(16)
• showOptions: enum(Y, N) - if set to Y, operation returns configuration options for particular sources

Results:

<GetGt2SourcesList>
    <status>OK</status>
    <sourcesNumber>3</sourcesNumber>
    <sources>
        <source>
            <sourceID>1</sourceID> : uint
            <name>Extra parameter</name> : string(255)
            <paramType>text</paramType> : enum(text, select)
        </source>
        <source>
            <sourceID>2</sourceID> : uint
            <name>URL Parameter</name> : string(255)
            <paramType>select</paramType> : enum(text, select)
        </source>
    </sources>
</GetGt2SourcesList>

<GetGt2SourcesList>
    <status>OK</status>
    <sourcesNumber>3</sourcesNumber>
    <sources>
        <source>
            <sourceID>1</sourceID> : uint
            <name>Extra parameter</name> : string(255)
            <options>
                <option>
                    <name>Parameter name</name>
                    <cmdParam>paramName</cmdParam>
                    <valueType>text</valueType> : enum(text, select)
                    <valueRegExp>^[0-9]+$</valueRegExp>
                    <values/>
                </option>
                <option>
                    <name>Condition</name>
                    <cmdParam>conditionID</cmdParam>
                    <valueType>select</valueType> : enum(text, select)
                    <valueRegExp/>
                    <values>
                        <value>
                            <valueID>3</valueID>
                            <name>is equal</name>
                            <cmdParamInfluence>
                                <param>
                                    <name>paramValue</name>
                                    <type>additional_regexp</type>
                                    <value>^[0-9]+$</value>
                                </param>
                            </cmdParamInfluence>
                        </value>
                    </values>
                </option>
                <option>
                    <name>Value</name>
                    <cmdParam>paramValue</cmdParam>
                    <valueType>text</valueType> : enum(text, select)
                    <valueRegExp>^[0-9]+$</valueRegExp>
                    <values/>
                </option>
            </options>
        </source>
        <source>
            <sourceID>2</sourceID> : uint
            <name>URL Parameter</name> : string(255)
            <options>
                <option>
                    <name>Parameter name</name>
                    <cmdParam>paramName</cmdParam>
                    <valueType>select</valueType>
                    <valueRegExp/>
                    <values>
                        <value>
                            <valueID>3</valueID>
                            <name>Page domain</name>
                            <cmdParamInfluence>
                                <param>
                                    <name>paramValue</name>
                                    <type>additional_regexp</type>
                                    <value>^[0-9A-Za-z]+$</value>
                                </param>
                            </cmdParamInfluence>
                        </value>
                    </values>
                </option>
                <option>
                    <name>Condition</name>
                    <cmdParam>conditionID</cmdParam>
                    <valueType>select</valueType>
                    <valueRegExp/>
                    <values>
                        <value>
                            <valueID>3</valueID>
                            <name>is equal</name>
                            <cmdParamInfluence>
                                <param>
                                    <name>paramValue</name>
                                    <type>additional_regexp</type>
                                    <value>^[0-9]+$</value>
                                </param>
                            </cmdParamInfluence>
                        </value>
                    </values>
                </option>
                <option>
                    <name>Value</name>
                    <cmdParam>paramValue</cmdParam>
                    <valueType>text</valueType>
                    <valueRegExp>^[0-9]+$</valueRegExp>
                    <values/>
                </option>
            </options>
        </source>
    </sources>
</GetGt2SourcesList>

Throw Errors:

---

GetGt2ParamsList [finished]

Overlays:

Activation:

GetGt2ParamsList.php ? sessionID = ...     
    [ & sourceID = ... ]

Description:

     Returns list of possible gT2 parameters

Parameters:

• sessionID: string(16)
• sourceID: uint

Results:

<GetGt2ParamsList>
    <status>OK</status>
    <paramsNumber>3</paramsNumber>
    <params>
        <param>
            <paramID>2</paramID> : uint
            <name>Page first level folder URL</name> : string(255)
            <sourceID>2</sourceID> : uint
            <sourceName>URL parameter</sourceName> : string(255)
            <valueRegExp>^[0-9a-z]+$</valueRegExp> : string(255)
        </param>
        <param>
            <paramID>6</paramID> : uint
            <name>Page URL</name> : string(255)
            <sourceID>2</sourceID> : uint
            <sourceName>URL parameter</sourceName> : string(255)
            <valueRegExp>^[0-9a-z]+$</valueRegExp> : string(255)
        </param>
    </params>
</GetGt2ParamsList>

Throw Errors:

---

GetGt2ConditionsList [finished]

Overlays:

Activation:

GetGt2ConditionsList.php ? sessionID = ...

Description:

     Returns list of possible gT2 conditions

Parameters:

• sessionID: string(16)

Results:

<GetGt2ConditionsList>
    <status>OK</status>
    <conditionsNumber>3</conditionsNumber>
    <conditions>
        <condition>
            <conditionID>1</conditionID> : uint
            <name>is equal</name> : string(255)
            <valueRegExp>^.*$</valueRegExp> : string(255)
        </condition>
        <condition>
            <conditionID>2</conditionID> : uint
            <name>greater than</name> : string(255)
            <valueRegExp>^[0-9]+$</valueRegExp> : string(255)
        </condition>
    </conditions>
</GetGt2ConditionsList>

Throw Errors:

---

GetActionPathsList [finished]

Overlays:

Activation:

GetActionPathsList.php ? sessionID = ... & campaignID = ...     
    [ & actionPathIDs = ... ]

Description:

  Returns list of action paths

Parameters:

• sessionID: string(16)
• campaignID: uint
• actionPathIDs: uint list

Results:

<GetActionPathsList>
    <status>OK</status>
    <actionPathsNumber>11</actionPathsNumber>
    <actionPaths>
        <actionPath>
            <actionPathID>42</actionPathID>
            <campaignID>2000987</campaignID>
            <name>shopping z fb pączki</name>
            <safeName>shopping_z_fb_paczki</safeName>
            <actions>
                <action>
                    <actionID>3</actionID>
                    <type>successfulClick</type>
                    <actionName>from facebook</actionName>
                </action>
                <action>
                    <actionID>15</actionID>
                    <type>actionPage</type>
                    <actionName>shop categories</actionName>
                </action>
                <action>
                    <actionID>13</actionID>
                    <type>actionPage</type>
                    <actionName>cart</actionName>
                </action>
                <action>
                    <actionID>19</actionID>
                    <type>actionPage</type>
                    <actionName>thank you page</actionName>
                </action>
            </actions>
        </actionPath>
    </actionPaths>
</GetActionPathsList>

Throw Errors:

---

AddActionPath [finished]

Overlays:

Activation:

AddActionPath.php ? sessionID = ... & campaignID = ... & name = ... & actionIDs = ...

Description:

    Adds action path.

Parameters:

• sessionID: string(16)
• campaignID: uint
• name: string (255)
• actionIDs: uint list

Results:

<AddActionPath>
    <status>OK</status>
    <actionPathID>42</actionPathID>
</AddActionPath>

Throw Errors:

---

DeleteActionPath [finished]

Overlays:

Activation:

DeleteActionPath.php ? sessionID = ... & actionPathIDs = ...

Description:

    Deletes action paths.

Parameters:

• sessionID: string(16)
• actionPathIDs: uint list

Results:

<DeleteActionPath>
    <status>OK</status>
</DeleteActionPath>

Throw Errors:

---

UpdateActionPath [finished]

Overlays:

Activation:

UpdateActionPath.php ? sessionID = ... & actionPathID = ... & name = ...

Description:

    Updates action path's name.

Parameters:

• sessionID: string(16)
• actionPathID: uint
• name: string (255)

Results:

<UpdateActionPath>
    <status>OK</status>
</UpdateActionPath>

Throw Errors:

---