Creative Events
- AddCreativeEvent
- UpdateCreativeEvent
- DeleteCreativeEvent
- GetCreativeEventsList
- GetCreativeEventTypesList
- AddCreativeClickTag
- UpdateCreativeClickTag
- DeleteCreativeClickTag
- GetCreativeClickTagsList
AddCreativeEvent [finished]
Overlays:
Activation:
AddCreativeEvent.php ?sessionID = ...
( & creativeID = ... | & templateID = ... )& creativeEventTypeID = ...
[ & name = ... ]
[ & function = ... ]
Description:
Creates new interaction. No more than 1000 interactions can be added in hour.
Parameters:
- sessionID: string(16)
- creativeID: uint
- templateID: uint
- creativeEventTypeID: uint
- name: string(63) - required for "custom" EventType
- function: string(63) - required for "custom" EventType
Results:
<AddCreativeEvent>
<status>OK</status>
<creativeEventID>1234</creativeEventID> : uint
</AddCreativeEvent>
Throw Errors:
UpdateCreativeEvent [finished]
Overlays:
Activation:
UpdateCreativeEvent.php ? sessionID = ... & eventID = ...
[ & name = ... ]
[ & function = ... ]
Description:
Modifies given interaction.
Parameters:
- sessionID: string(16)
- eventID: uint
- name: string(63)
- function: string(63)
Results:
<UpdateCreativeEvent>
<status>OK</status>
</UpdateCreativeEvent>
Throw Errors:
DeleteCreativeEvent [finished]
Overlays:
Activation:
DeleteCreativeEvent.php ? sessionID = ... & eventID = ...
Description:
Deletes interaction.
Parameters:
- sessionID: string(16)
- eventID: uint
Results:
<DeleteCreativeEvent>
<status>OK</status>
</DeleteCreativeEvent>
Throw Errors:
GetCreativeEventsList [finished]
Overlays:
Activation:
GetCreativeEventsList?sessionID = ...
( & campaignIDs | & creativeIDs | & templateIDs )
[ & namePattern ]
[ & limit ]
[ & offset ]
Description:
Parameters:
- sessionID: string(16)
- campaignIDs: uint list
- creativeIDs: uint list
- templateIDs: uint list
- namePattern: string(100)
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetCreativeEventsList>
<status>OK</status>
<eventsNumber>1234</eventsNumber> : uint - all records number (if there were no limit and offset)
<events>
<event>
<eventID>1</eventID> : uint
<creativeEventTypeID>1</creativeEventTypeID> : uint
<creativeEventTypeName>custom</creativeEventTypeName> : string(100)
<name>name1</name> : string(63)
<function>gdeMeasure1</function> : string(63)
<campaignID>123</campaignID> : nullable uint
<campaignName>banner</campaignName> : string(255)
<creativeID>123</creativeID> : nullable uint
<creativeName>banner</creativeName> : string(63)
</event>
</events>
</GetCreativeEventsList>
Throw Errors:
GetCreativeEventTypesList [finished]
Overlays:
Activation:
GetCreativeEventTypesList.php ? sessionID = ...
Description:
Returns list of possible interaction types.
Parameters:
- sessionID: string(16)
Results:
<GetCreativeEventTypesList>
<status>OK</status>
<creativeEventTypesNumber>1234</creativeEventTypesNumber> : uint - all records number (if there were no limit and offset)
<creativeEventTypes>
<creativeEventType>
<creativeEventTypeID>1</creativeEventTypeID> : uint
<name>custom</name> : string(100)
</creativeEventType>
<creativeEventType>
<creativeEventTypeID>2</creativeEventTypeID> : uint
<name>end</name> : string(100)
</creativeEventType>
<creativeEventType>
<creativeEventTypeID>3</creativeEventTypeID> : uint
<name>expand</name> : string(100)
</creativeEventType>
</creativeEventTypes>
</GetCreativeEventTypesList>
Throw Errors:
AddCreativeClickTag [finished]
Overlays:
Activation:
AddCreativeClickTag.php ?sessionID = ...
( & creativeID = ... | & templateID = ... )& name = ...
[ & macro = ... ]
[ & targetUrl = ... ]
& clickTag = ...
Description:
Adds new creative click Tag. No more than 1000 click tags can be added in hour.
Parameters:
- sessionID: string(16)
- creativeID: uint
- templateID: uint
- name: string(63)
- macro: string(63) - required if given templateID or creative is gde+
- targetUrl: string(255)
- clickTag: string(255)
Results:
<AddCreativeClickTag>
<status>OK</status>
<clickTagID>1234</clickTagID> : uint
</AddCreativeClickTag>
Throw Errors:
UpdateCreativeClickTag [finished]
Overlays:
Activation:
UpdateCreativeClickTag.php ? sessionID = ... & clickTagID = ...
[ & name = ... ]
[ & macro = ... ]
[ & targetUrl = ... ]
[ & clickTag = ... ]
Description:
Modifies given creative click tag.
Parameters:
- sessionID: string(16)
- clickTagID: uint
- name: string(63)
- macro: string(63)
- targetUrl: string(255)
- clickTag: string(255)
Results:
<UpdateCreativeClickTag>
<status>OK</status>
</UpdateCreativeClickTag>
Throw Errors:
DeleteCreativeClickTag [finished]
Overlays:
Activation:
DeleteCreativeClickTag.php ? sessionID = ... & clickTagID = ...
Description:
Deletes given creative click tag.
Parameters:
- sessionID: string(16)
- clickTagID: uint
Results:
<DeleteCreativeClickTag>
<status>OK</status>
</DeleteCreativeClickTag>
Throw Errors:
GetCreativeClickTagsList [finished]
Overlays:
Activation:
GetCreativeClickTagsList ?sessionID = ...
( & campaignIDs | & creativeIDs | & templateIDs )
[ & namePattern ]
[ & limit ]
[ & offset ]
Description:
Returns list of creative click tags matching specified criteria.
Parameters:
- sessionID: string(16)
- campaignIDs: uint list
- creativeIDs: uint list
- templateIDs: uint list
- namePattern: string(100)
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetCreativeClickTagsList>
<status>OK</status>
<clickTagsNumber>1234</clickTagsNumber> : uint - all records number (if there were no limit and offset)
<clickTags>
<clickTag>
<clickTagID>1</clickTagID> : uint
<name>nazwa1</name> : string(63)
<macro>zmienna_1</macro> : string(63)
<clickTag>clicktag</clickTag> : string(100)
<targetUrl>www.gemius.pl</targetUrl> : string(1023)
<campaignID>123</campaignID> : nullable uint
<campaignName>banner</campaignName> : string(255)
<creativeID>123</creativeID> : nullable uint
<creativeName>banner</creativeName> : string(63)
<actionID>1234</actionID> : nullable uint
<actionName>akcja</actionName> : string(255)
</clickTag>
</clickTags>
</GetCreativeClickTagsList>