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

Campaign

• AddCampaign
• UpdateCampaign
• GetCampaignsList
• SearchCampaign
• GetCampaignInfo
• GetCampaignAttributes
• SuspendEmission
• GetPossibleTargetURLElementValuesList
• SetTargetURLElements
• GetTargetURLElementsList

AddCampaign [finished]

Overlays:

Activation:

AddCampaign.php ? sessionID = ... & name = ... & clientID = ...     
    [ & emiterID = ... ]
        
    [ & isBlocked = ... ]
        & targetUrl = ...     
    [ & trafficIDs = ... ]
        
    [ & mediaplannerIDs = ... ]
        & startTS = ... & endTS = ...     
    [ & countryID = ... ]
        
    [ & timeZoneID = ... ]
        
    [ & impressionGoal = ... ]
        
    [ & actionGoal = ... ]
        
    [ & clickGoal = ... ]
        
    [ & costCurrency = ... ]
        
    [ & limitPV = ... ]
        
    [ & limitPC = ... ]
        
    [ & comments = ... ]
        
    [ & starred = ... ]
        
    [ & tag1ID = ... ]
        
    [ & tag2ID = ... ]
        
    [ & label1 = ... ]
        
    [ & label2 = ... ]
        
    [ & gAnalytics = ... ]

Description:

    Adds a new campaign and assigns an ID to it. No more than 1000 campaigns can be added in hour.

Parameters:

• sessionID: string(16)
• name: string(255)
• clientID: uint
• emiterID: uint
• isBlocked: enum('Y', 'N') - default=N only for campaigns that have set emiterID, blocked campaign is not emitted
• targetUrl: string(255)
• trafficIDs: uint list
• mediaplannerIDs: uint list
• startTS: uint
• endTS: uint
• countryID: uint
• timeZoneID: uint
• impressionGoal: uint
• actionGoal: uint
• clickGoal: uint
• costCurrency: enum('GBP', 'EUR', 'BYR', 'BAM', 'BGN', 'HRK', 'CZK', 'DKK', 'EEK', 'RSD', 'LTL', 'LVL', 'NOK', 'PLN', 'RON', 'EUR', 'SEK', 'UAH', 'HUF', 'RUB', 'TRY', 'ILS', 'USD')
• limitPV: uint - time limit for post view actions counting after campaign end
• limitPC: uint - time limit for post click actions counting after campaign end
• comments: string(255)
• starred: enum('Y','N') default 'N' - marked as favourite (per user)
• tag1ID: uint
• tag2ID: uint
• label1: string(63)
• label2: string(63)
• gAnalytics: enum('Y', 'N') - default=N defines if targetUrl should be integrated with googleAnalytics

Results:

<AddCampaign>
    <status>OK</status>
    <campaigns>
        <campaign>
            <campaignID>8</campaignID> : uint
            <name>test</name> : string(255)
            <clientID>15</clientID> : uint
            <clientLogin>Clients03</clientLogin> : string(255)
            <clientName>cl name</clientName> : string(255)
            <userID>4</userID> : uint - ID of campaign creator
            <userLogin>Creator</userLogin> : string(255) - login of campaign creator
            <status>finished</status> : enum('waiting', 'current', 'finished')
            <impressionGoal>701120</impressionGoal> : nullable uint
            <clickGoal>426437</clickGoal> : nullable uint
            <actionGoal/> : nullable uint
            <startTS>1249077600</startTS> : uint
            <endTS>1251324000</endTS> : uint
            <creationTS>1250090119</creationTS> : uint
            <modificationTS/> : nullable uint
            <comments/> : string(255)
            <starred>Y</starred> : enum('Y', 'N') - marked as favourite (per user)
            <tag1ID>42</tag1ID> : nullable uint
            <tag1Name>mega</tag1Name> : string(255)
            <tag2ID>9</tag2ID> : nullable uint
            <tag2Name>category 2</tag2Name> : string(255)
            <label1>ppp</label1> : string(63)
            <label2>ppp</label2> : string(63)
            <gAnalytics>N</gAnalytics> : enum('Y', 'N')
            <rootPlacementID>25</rootPlacementID> : uint
            <targetUrl>http://wp.pl</targetUrl> : string(255)
            <trafficIDs>7</trafficIDs> : uint list
            <trafficLogins>adam</trafficLogins> : uint list
            <mediaPlannerIDs/> : uint list
            <mediaPlannerLogins/> : string(255) list
            <emiterID>1</emiterID> : nullable uint
            <emiterName>ad.adocean.pl</emiterName> : string(64)
            <isBlocked>N</isBlocked> : enum('Y', 'N')
            <countryID>42</countryID> : uint
            <countryName>Poland</countryName> : string(255)
            <timeZoneID>283</timeZoneID> : uint
            <timeZoneName>Warsaw</timeZoneName> : string(255)
            <limitPC>NULL</limitPC> : nullable uint - time limit for post click actions counting after campaign end
            <limitPV>NULL</limitPV> : nullable uint - time limit for post view actions counting after campaign end
            <maxLimitPCPV>7200</maxLimitPCPV> : uint
            <costCurrency/> : enum('GBP', 'EUR', 'BYR', 'BAM', 'BGN', 'HRK', 'CZK', 'DKK', 'EEK', 'RSD', 'LTL', 'LVL', 'NOK', 'PLN', 'RON', 'EUR', 'SEK', 'UAH', 'HUF', 'RUB', 'TRY', 'ILS', 'USD')
            <basicStatsTU>1249077600</basicStatsTU> : uint - approximate time to when statistics are calculated (as time unit; to convert time unit format to human readable, one needs to interpret the timestamp in GMT time zone)
            <statsUpdateTS>1249077600</statsUpdateTS> : uint - time of the last campaign statistics update (UNIX timestamp)
            <statsResetTS/> : nullable uint - time, when statistics became invalid because of significant campaign change (UNIX timestamp)
            <ruStatEnabled>N</ruStatEnabled> : enum('Y', 'N')
            <socDemStatEnabled>N</socDemStatEnabled> : enum('Y', 'N')
            <isSocDemReady>N</isSocDemReady> : enum('Y', 'N')
            <isGdePlus>Y</isGdePlus> : enum('Y', 'N')
        </campaign>
    </campaigns>
</AddCampaign>

Throw Errors:

---

UpdateCampaign [finished]

Overlays:

Activation:

UpdateCampaign.php ? sessionID = ... & campaignID = ...     
    [ & name = ... ]
        
    [ & clientID = ... ]
        
    [ & emiterID = ... ]
        
    [ & isBlocked = ... ]
        
    [ & targetUrl = ... ]
        
    [ & trafficIDs = ... ]
        
    [ & mediaplannerIDs = ... ]
        
    [ & startTS = ... ]
        
    [ & endTS = ... ]
        
    [ & countryID = ... ]
        
    [ & timeZoneID = ... ]
        
    [ & impressionGoal = ... ]
        
    [ & actionGoal = ... ]
        
    [ & clickGoal = ... ]
        
    [ & costCurrency = ... ]
        
    [ & limitPV = ... ]
        
    [ & limitPC = ... ]
        
    [ & comments = ... ]
        
    [ & starred = ... ]
        
    [ & tag1ID = ... ]
        
    [ & tag2ID = ... ]
        
    [ & label1 = ... ]
        
    [ & label2 = ... ]
        
    [ & gAnalytics = ... ]

Description:

    Changes campaign data.

Parameters:

• sessionID: string(16)
• campaignID: uint
• name: string(255)
• clientID: uint
• emiterID: uint - only set, cannot change if it had been set before
• isBlocked: enum('Y', 'N') - only for GDE+ Campaigns, blocked campaigns are not emitted.
• targetUrl: string(255)
• trafficIDs: uint list
• mediaplannerIDs: uint list
• startTS: uint
• endTS: uint
• countryID: uint
• timeZoneID: uint
• impressionGoal: uint
• actionGoal: uint
• clickGoal: uint
• costCurrency: enum('GBP', 'EUR', 'BYR', 'BAM', 'BGN', 'HRK', 'CZK', 'DKK', 'EEK', 'RSD', 'LTL', 'LVL', 'NOK', 'PLN', 'RON', 'EUR', 'SEK', 'UAH', 'HUF', 'RUB', 'TRY', 'ILS', 'USD')
• limitPV: uint - time limit for post view actions counting after campaign end
• limitPC: uint - time limit for post click actions counting after campaign end
• comments: string(255)
• starred: enum('Y','N') - marked as favourite (per user)
• tag1ID: uint
• tag2ID: uint
• label1: string(63)
• label2: string(63)
• gAnalytics: enum('Y', 'N') - defines if targetUrl should be integrated with googleAnalytics

Results:

<UpdateCampaign>
    <status>OK</status>
    <campaigns>
        <campaign>
            <campaignID>8</campaignID> : uint
            <name>test_jacka</name> : string(255)
            <clientID>15</clientID> : uint
            <clientLogin>Clients03</clientLogin> : string(255)
            <clientName>cl name</clientName> : string(255)
            <userID>4</userID> : uint - ID of campaign creator
            <userLogin>Creator</userLogin> : string(255) - login of campaign creator
            <status>finished</status> : enum('waiting', 'current', 'finished')
            <impressionGoal>701120</impressionGoal> : nullable uint
            <clickGoal>426437</clickGoal> : nullable uint
            <actionGoal/> : nullable uint
            <startTS>1249077600</startTS> : uint
            <endTS>1251324000</endTS> : uint
            <creationTS>1250090119</creationTS> : uint
            <modificationTS/> : nullable uint
            <comments/> : string(255)
            <starred>Y</starred> : enum('Y', 'N') - marked as favourite (per user)
            <tag1ID>42</tag1ID> : nullable uint
            <tag1Name>mega</tag1Name> : string(255)
            <tag2ID>9</tag2ID> : nullable uint
            <tag2Name>category 2</tag2Name> : string(255)
            <label1>ppp</label1> : string(63)
            <label2>ppp</label2> : string(63)
            <gAnalytics>N</gAnalytics> : enum('Y', 'N')
            <rootPlacementID>25</rootPlacementID> : uint
            <targetUrl>http://wp.pl</targetUrl> : string(255)
            <trafficIDs>7</trafficIDs> : uint list
            <trafficLogins>adam</trafficLogins> : uint list
            <mediaPlannerIDs/> : uint list
            <mediaPlannerLogins/> : string(255) list
            <emiterID>1</emiterID> : nullable uint
            <emiterName>ad.adocean.pl</emiterName> : string(64)
            <isBlocked>N</isBlocked> : enum('Y', 'N')
            <countryID>42</countryID> : uint
            <countryName>Poland</countryName> : string(255)
            <timeZoneID>283</timeZoneID> : uint
            <timeZoneName>Warsaw</timeZoneName> : string(255)
            <limitPC>NULL</limitPC> : nullable uint - time limit for post click actions counting after campaign end
            <limitPV>NULL</limitPV> : nullable uint - time limit for post view actions counting after campaign end
            <maxLimitPCPV>7200</maxLimitPCPV> : uint
            <costCurrency/> : enum('GBP', 'EUR', 'BYR', 'BAM', 'BGN', 'HRK', 'CZK', 'DKK', 'EEK', 'RSD', 'LTL', 'LVL', 'NOK', 'PLN', 'RON', 'EUR', 'SEK', 'UAH', 'HUF', 'RUB', 'TRY', 'ILS', 'USD')
            <basicStatsTU>1249077600</basicStatsTU> : uint - approximate time to when statistics are calculated (as time unit; to convert time unit format to human readable, one needs to interpret the timestamp in GMT time zone)
            <statsUpdateTS>1249077600</statsUpdateTS> : uint - time of the last campaign statistics update (UNIX timestamp)
            <statsResetTS/> : nullable uint - time, when statistics became invalid because of significant campaign change (UNIX timestamp)
            <ruStatEnabled>N</ruStatEnabled> : enum('Y', 'N')
            <socDemStatEnabled>N</socDemStatEnabled> : enum('Y', 'N')
            <isSocDemReady>N</isSocDemReady> : enum('Y', 'N')
            <isGdePlus>Y</isGdePlus> : enum('Y', 'N')
        </campaign>
    </campaigns>
</UpdateCampaign>

Throw Errors:

---

GetCampaignsList [finished]

Overlays:

Activation:

GetCampaignsList.php ? sessionID = ...     
    [ & campaignIDs = ... ]
        
    [ & namePattern = ... ]
        
    [ & status = ... ]
        
    [ & startTS = ... ]
        
    [ & endTS = ... ]
        
    [ & commentsPattern = ... ]
        
    [ & starred = ... ]
        
    [ & isGdePlus = ... ]
        
    [ & creatorID = ... ]
        
    [ & clientID = ... ]
        
    [ & clientLoginPattern = ... ]
        
    [ & clientNamePattern = ... ]
        
    [ & clientPattern = ... ]
        
    [ & combinePatterns = ... ]
        
    [ & tag1IDs = ... ]
        
    [ & tag2IDs = ... ]
        
    [ & labels1 = ... ]
        
    [ & labels2 = ... ]
        
    [ & indicatorIDs = ... ]
        
    [ & sortField = ... ]
        
    [ & sortOrder = ... ]
        
    [ & limit = ... ]
        
    [ & offset = ... ]

Description:

    Returns a list of campaigns for an account, matching specified criteria.

Parameters:

• sessionID: string(16)
• campaignIDs: uint list
• namePattern: string(32)
• status: enum('waiting','finished','current') list
• startTS: uint
• endTS: uint
• commentsPattern: string(32)
• starred: enum('Y','N') - marked as favourite (per user)
• isGdePlus: enum('Y','N')
• creatorID: uint - ID of campaign creator
• clientID: uint
• clientLoginPattern: string(32)
• clientNamePattern: string(32)
• clientPattern: string(32)
• combinePatterns: enum('Y','N')
• tag1IDs: uint list
• tag2IDs: uint list
• labels1: string(63) list
• labels2: string(63) list
• indicatorIDs: uint list
• sortField: enum('name','clientName','clientLogin','ownerLogin','status','impressionGoal','clickGoal','actionGoal','startTS','endTS','creationTS','modificationTS', 'comments','tag1Name','tag2Name','label1','label2')
• sortOrder: enum('asc','desc')
• limit: uint - limits result to given number of records
• offset: uint - skips given number of records

Results:

<GetCampaignsList>
    <status>OK</status>
    <campaignsNumber>1234</campaignsNumber> : uint - all records number (if there were no limit and offset)
    <campaigns>
        <campaign>
            <campaignID>8</campaignID> : uint
            <name>test</name> : string(255)
            <clientID>15</clientID> : uint
            <clientLogin>Clients03</clientLogin> : string(255)
            <clientName>cl name</clientName> : string(255)
            <userLogin>user</userLogin> : string(255) - login of user who created campaign
            <isCreatedByMe>N</isCreatedByMe> : enum('Y', 'N')
            <isGdePlus>Y</isGdePlus> : enum('Y', 'N')
            <isBlocked>N</isBlocked> : enum('Y', 'N')
            <status>finished</status> : enum('waiting', 'current', 'finished')
            <impressionGoal>701120</impressionGoal> : nullable uint
            <clickGoal>426437</clickGoal> : nullable uint
            <actionGoal/> : nullable uint
            <startTS>1249077600</startTS> : uint
            <endTS>1251324000</endTS> : uint
            <creationTS>1250090119</creationTS> : uint
            <modificationTS/> : nullable uint
            <comments/> : string(255)
            <starred>Y</starred> : enum('Y', 'N') - marked as favourite (per user)
            <tag1ID>42</tag1ID> : nullable uint
            <tag1Name>mega</tag1Name> : string(255)
            <tag2ID>9</tag2ID> : nullable uint
            <tag2Name>category 2</tag2Name> : string(255)
            <label1>ppp</label1> : string(63)
            <label2>ppp</label2> : string(63)
            <cachedStatistics>
                <cachedStatistic>
                    <indicatorID>2</indicatorID> : uint
                    <indicatorName>impressions</indicatorName> : string(255)
                    <value>45334</value> : nullable float
                </cachedStatistic>
            </cachedStatistics>
        </campaign>
    </campaigns>
</GetCampaignsList>

Throw Errors:

---

SearchCampaign [finished]

Overlays:

Activation:

SearchCampaign.php ? sessionID = ...     
    [ & pattern = ... ]
        
    [ & matchingField = ... ]
        
    [ & status = ... ]
        
    [ & startTS = ... ]
        
    [ & endTS = ... ]
        
    [ & copyActionsCampaignID = ... ]
        
    [ & sortField = ... ]
        
    [ & sortOrder = ... ]
        
    [ & limit = ... ]
        
    [ & offset = ... ]

Description:

    Simplified and faster version of GetCampaignList. Returns a list of campaigns for an account, matching specified criteria.

Parameters:

• sessionID: string(16)
• pattern: string(100) - pattern for matching field
• matchingField: enum('name','comments','targetUrl','label1','label2')
• status: enum('waiting','finished','current') list
• startTS: uint
• endTS: uint
• copyActionsCampaignID: uint - returns only campaigns from which one can copy campaign actions to requested campaign (campaign with id=copyActionsCampaignID)
• sortField: enum('name','status','startTS','endTS','creationTS','modificationTS','comments','label1','label2')
• sortOrder: enum('asc','desc')
• limit: uint - limits result to given number of records
• offset: uint - skips given number of records

Results:

<SearchCampaign>
    <status>OK</status>
    <campaignsNumber>1234</campaignsNumber> : uint - all records number (if there were no limit and offset)
    <campaigns>
        <campaign>
            <campaignID>1234</campaignID> : uint
            <matchingField>some campaign</matchingField> : string(255)
        </campaign>
    </campaigns>
</SearchCampaign>

Throw Errors:

---

GetCampaignInfo [finished]

Overlays:

Activation:

GetCampaignInfo.php ? sessionID = ... & campaignID = ...

Description:

    Returns information about a given campaign.

Parameters:

• sessionID: string(16)
• campaignID: uint

Results:

<GetCampaignInfo>
    <status>OK</status>
    <campaigns>
        <campaign>
            <campaignID>8</campaignID> : uint
            <name>test</name> : string(255)
            <clientID>15</clientID> : uint
            <clientLogin>Clients03</clientLogin> : string(255)
            <clientName>cl name</clientName> : string(255)
            <userID>4</userID> : uint - ID of campaign creator
            <userLogin>Creator</userLogin> : string(255) - login of campaign creator
            <status>finished</status> : enum('waiting', 'current', 'finished')
            <impressionGoal>701120</impressionGoal> : nullable uint
            <clickGoal>426437</clickGoal> : nullable uint
            <actionGoal/> : nullable uint
            <startTS>1249077600</startTS> : uint
            <endTS>1251324000</endTS> : uint
            <creationTS>1250090119</creationTS> : uint
            <modificationTS/> : nullable uint
            <comments/> : string(255)
            <starred>Y</starred> : enum('Y', 'N')
            <tag1ID>42</tag1ID> : nullable uint
            <tag1Name>mega</tag1Name> : string(255)
            <tag2ID>9</tag2ID> : nullable uint
            <tag2Name>category 2</tag2Name> : string(255)
            <label1>ppp</label1> : string(63)
            <label2>ppp</label2> : string(63)
            <gAnalytics>N</gAnalytics> : enum('Y', 'N')
            <rootPlacementID>25</rootPlacementID> : uint
            <targetUrl>http://wp.pl</targetUrl> : string(255)
            <trafficIDs>7</trafficIDs> : uint list
            <trafficLogins>adam</trafficLogins> : uint list
            <mediaPlannerIDs/> : uint list
            <mediaPlannerLogins/> : string(255) list
            <emiterID>1</emiterID> : nullable uint
            <emiterName>ad.adocean.pl</emiterName> : string(64)
            <isBlocked>N</isBlocked> : enum('Y', 'N')
            <countryID>42</countryID> : uint
            <countryName>Poland</countryName> : string(255)
            <timeZoneID>283</timeZoneID> : uint
            <timeZoneName>Warsaw</timeZoneName> : string(255)
            <limitPC>NULL</limitPC> : nullable uint
            <limitPV>NULL</limitPV> : nullable uint
            <maxLimitPCPV>7200</maxLimitPCPV> : uint
            <costCurrency/> : enum('GBP', 'EUR', 'BYR', 'BAM', 'BGN', 'HRK', 'CZK', 'DKK', 'EEK', 'RSD', 'LTL', 'LVL', 'NOK', 'PLN', 'RON', 'EUR', 'SEK', 'UAH', 'HUF', 'RUB', 'TRY', 'ILS', 'USD')
            <basicStatsTU>1249077600</basicStatsTU> : uint - approximate time to when statistics are calculated (as time unit; to convert time unit format to human readable, one needs to interpret the timestamp in GMT time zone)
            <statsUpdateTS>1249077600</statsUpdateTS> : uint - time of the last campaign statistics update (UNIX timestamp)
            <statsResetTS/> : nullable uint - time, when statistics became invalid because of significant campaign change (UNIX timestamp)
            <ruStatEnabled>N</ruStatEnabled> : enum('Y', 'N')
            <socDemStatEnabled>N</socDemStatEnabled> : enum('Y', 'N')
            <isSocDemReady>N</isSocDemReady> : enum('Y', 'N')
            <isGdePlus>Y</isGdePlus> : enum('Y', 'N')
        </campaign>
    </campaigns>
</GetCampaignInfo>

Throw Errors:

---

GetCampaignAttributes [finished]

Overlays:

Activation:

GetCampaignAttributes.php ? sessionID = ... & campaignID = ...

Description:

    Returns information about objects in a given campaign.

Parameters:

• sessionID: string(16)
• campaignID: uint

Results:

<GetCampaignAttributes>
    <status>OK</status>
    <campaign>
        <orderIDs/> : uint list
        <orderNames/> : string(512) list
        <publisherIDs/> : uint list
        <publisherLogins/> : string(255) list
        <placementCategoryIDs/> : uint list
        <placementCategoryNames/> : string(255) list
        <placementTouchPointIDs/> : uint list
        <placementTouchPointNames/> : string(255) list
        <placementTag1IDs/> : uint list
        <placementTag1Names/> : string(255) list
        <placementTag2IDs/> : uint list
        <placementTag2Names/> : string(255) list
        <creatives>
            <creative>
                <creativeID>123</creativeID> : uint
                <creativeName>kreacja1</creativeName> : string(255)
                <creativeCodeID>50123</creativeCodeID> : uint
                <creativeCodeName>ckreacja1</creativeCodeName> : string(255)
            </creative>
            <creative>
                <creativeID>124</creativeID> : uint
                <creativeName>kreacja2</creativeName> : string(255)
                <creativeCodeID>50124</creativeCodeID> : uint
                <creativeCodeName>ckreacja2</creativeCodeName> : string(255)
            </creative>
        </creatives>
        <creativeFormIDs/> : uint list
        <creativeFormNames/> : string(255) list
        <creativeTypeIDs/> : uint list
        <creativeTypeNames/> : string(100) list
        <creativeClickTagIDs/> : uint list
        <creativeClickTagNames/> : string(63) list
        <creativeEventIDs/> : uint list
        <creativeEventNames/> : string(63) list
        <creativeTag1IDs/> : uint list
        <creativeTag1Names/> : string(255) list
        <creativeTag2IDs/> : uint list
        <creativeTag2Names/> : string(255) list
        <realUsersLimit>1000</realUsersLimit> : uint - number of unique users required to be achieved to calculate RU for campaign
    </campaign>
</GetCampaignAttributes>

Throw Errors:

---

SuspendEmission [finished]

Overlays:

Activation:

SuspendEmission.php ? sessionID = ... & campaignIDs = ... & isBlocked = ...

Description:

  Allows to suspend or resume creatives or campaigns. Note: all creatives/campaigns must be GDE+.

Parameters:

• sessionID: string(16)
• campaignIDs: uint list | creativeIDs - uint list ) : campaigns or creatives which emission should be resumed/suspended
• isBlocked: enum('Y', 'N')

Results:

<SuspendEmission>
    <status>OK</status>
</SuspendEmission>

Throw Errors:

---

GetPossibleTargetURLElementValuesList [finished]

Overlays:

Activation:

GetPossibleTargetURLElementValuesList.php ? sessionID = ...     
    [ & ownerID = ... ]

Description:

  Returns the list of automatic values, which can be appended to a target URL.

Parameters:

• sessionID: string(16)
• ownerID: uint

Results:

<GetPossibleTargetURLElementValuesList>
    <status>OK</status>
    <valuesNumber>1</valuesNumber> : uint
    <values>
        <value>
            <valueID>34</valueID> : uint
            <name>Campaign name</name> : string(255)
            <url_macro>CampaignName</url_macro> : string(255)
            <nameType>system</nameType> : enum('system','user')
        </value>
    </values>
</GetPossibleTargetURLElementValuesList>

Throw Errors:

---

SetTargetURLElements [finished]

Overlays:

Activation:

SetTargetURLElements.php ? sessionID = ... & campaignID = ... & values = ...

Description:

  Sets automatic values, that will be appended to target URL. See GetPossibleTargetURLElementValuesList.

Parameters:

• sessionID: string(16)
• campaignID: uint
• values: JSON array of objects with fields 'name' and 'value' (eg. [{"name" - "aaa", "value":"bbb"}, {"name":"xxx", "value":"yyy"}] )

Results:

<SetTargetURLElements>
    <status>OK</status>
</SetTargetURLElements>

Throw Errors:

---

GetTargetURLElementsList [finished]

Overlays:

Activation:

GetTargetURLElementsList.php ? sessionID = ... & campaignID = ...

Description:

  Returns the list of elements, that will be appended to target URL. See GetPossibleTargetURLElementValuesList.

Parameters:

• sessionID: string(16)
• campaignID: uint

Results:

<GetTargetURLElementsList>
    <status>OK</status>
    <elementsNumber>1</elementsNumber> : uint
    <elements>
        <element>
            <elementID>3</elementID> : uint
            <name>My parameter</name> : string(255)
            <value>CampaignName_xyz</value> : string(255)
        </element>
    </elements>
</GetTargetURLElementsList>

Throw Errors:

---