Creative Codes
- GetCreativeCodePreview
- UpdateCreativeCode
- GetCreativeCodeVersionsList
- GetCreativeCodeInfo
- GetCreativeCodeMacrosList
- GetCreativeCodeFilesList
- SetCreativeCodeParamValue
- GetCreativeCodeParamTypesList
- GetCreativeCodeParamAutocompleteTypesList
- GetCreativeFormsList
- GetCreativeTypesList
GetCreativeCodePreview [finished]
Overlays:
Activation:
GetCreativeCodePreview.php ? sessionID = ... & codeID = ... & proto = ...
[ & iframe = ... ]
Description:
Returns preview of creative. Warning: code is neither escaped, nor packed in any way.
Parameters:
- sessionID: string(16)
- codeID: uint
- proto: enum('http', 'https')
- iframe: enum('Y', 'N') - default=N
Results:
<GetCreativeCodePreview>
<status>OK</status>
<code>...</code>
</GetCreativeCodePreview>
Throw Errors:
UpdateCreativeCode [finished]
Overlays:
Activation:
UpdateCreativeCode.php ? sessionID = ... & codeID = ...
[ & code = ... ]
[ & newVersion = ... ]
Description:
Updates creative code.
Parameters:
- sessionID: string(16)
- codeID: uint
- code: string(32766)
- newVersion: enum('Y', 'N') default 'N' - whether new creative version should be created (deep copy of creative code will be made)
Results:
<UpdateCreativeCode>
<status>OK</status>
<codeID>1</codeID> : uint
<paramsNumber>1</paramsNumber> : uint - number of parameters copied from old creative code version (if new version was created).
<params>
<param>
<paramID>123</paramID> : uint - new creative code parameter id
<copyParamID>124</copyParamID> : uint - old (copied) creative code parameter id
</param>
</params>
</UpdateCreativeCode>
Throw Errors:
GetCreativeCodeVersionsList [finished]
Overlays:
Activation:
GetCreativeCodeVersionsList.php ? sessionID = ... & creativeIDs = ...
Description:
Returns versions list for given creatives.
Parameters:
- sessionID: string(16)
- creativeIDs: uint list
Results:
<GetCreativeCodeVersionsList>
<status>OK</status>
<codesNumber>2</codesNumber> : uint
<codes>
<code>
<creativeID>11</creativeID> : uint
<codeID>113</codeID> : uint
<version>1</version> : uint
</code>
<code>
<creativeID>11</creativeID> : uint
<codeID>117</codeID> : uint
<version>2</version> : uint
</code>
</codes>
</GetCreativeCodeVersionsList>
Throw Errors:
GetCreativeCodeInfo [finished]
Overlays:
Activation:
GetCreativeCodeInfo.php ? sessionID = ... & codeID = ... & languageIDs = ...
Description:
Returns information about given creative code. Several params can have different names in different languages. This commands returns name accordingly to languageIDs list given as parameter. To get languageIDs see GetLanguagesList.
Parameters:
- sessionID: string(16)
- codeID: uint
- languageIDs: uint list
Results:
<GetCreativeCodeInfo>
<status>OK</status>
<code>...</code> : string
<version>13</version> : uint
<paramsNumber>1234</paramsNumber> : uint
<params>
<param>
<paramID>1234</paramID> : uint
<names>szerokość,width</names> : string list - length is determined by length of languageIDs list
<ordinalNumber>4</ordinalNumber> : uint
<macro>PARAM_1</macro> : string(100)
<typeID>13</typeID> : uint
<typeName>13</typeName> : string(100)
<addSlashes>Y</addSlashes> : nullable enum('Y','N')
<size>255</size> : uint
<possibleValues>value1,value2</possibleValues> : string list
<validationExpression/> : string(100)
<autocompleteTypeID>1</autocompleteTypeID> : uint
<isMandatory>N</isMandatory> : enum('Y', 'N')
<value>133</value> : string
</param>
</params>
</GetCreativeCodeInfo>
Throw Errors:
GetCreativeCodeMacrosList [finished]
Overlays:
Activation:
GetCreativeCodeMacrosList.php ? sessionID = ... & codeID = ...
[ & macroTypes = ... ]
Description:
Returns macros list for given creative code, matching specified criteria.
Parameters:
- sessionID: string(16)
- codeID: uint
- macroTypes: enum('param', 'file', 'clicktag', 'system', 'interaction') list
Results:
<GetCreativeCodeMacrosList>
<status>OK</status>
<macrosNumber>1234</macrosNumber> : uint
<macros>
<macro>
<macro>WIDTH</macro> : string(100)
<macroType>param</macroType> : enum('param', 'file', 'clicktag', 'system', 'interaction')
</macro>
</macros>
</GetCreativeCodeMacrosList>
Throw Errors:
GetCreativeCodeFilesList [finished]
Overlays:
Activation:
GetCreativeCodeFilesList.php ? sessionID = ... & codeID = ... & languageIDs = ...
Description:
Returns list of files for given creative code.
Parameters:
- sessionID: string(16)
- codeID: uint
- languageIDs: uint list
Results:
<GetCreativeCodeFilesList>
<status>OK</status>
<filesNumber>1234</filesNumber>
<files>
<file>
<paramID>1234</paramID> : uint
<names>plik</names> : string list - param names in same order as in languageIDs
<ordinalNumber>4</ordinalNumber> : uint
<typeID>8</typeID> : uint
<typeName>13</typeName> : string(100)
<mimeTypeIDs>13,15</mimeTypeIDs> : uint list
<mimeTypeNames>png,jpg</mimeTypeNames> : string list
<fileID>133</fileID> : uint
<location>http://gemius.pl/plik.gif</location> : string(1023)
<slaveFiles>
<file>
<fileID>122</fileID> : uint
<location>http://gemius.pl/folder/plik.js</location> : string(1023)
</file>
<file>
<fileID>122</fileID> : uint
<location>http://gemius.pl/folder/plik.js</location> : string(1023)
</file>
</slaveFiles>
<macro>FILE_1</macro> : string(100)
<autocompleteTypeID>1</autocompleteTypeID> : uint
<isMandatory>N</isMandatory> : enum('Y', 'N')
</file>
</files>
</GetCreativeCodeFilesList>
Throw Errors:
SetCreativeCodeParamValue [finished]
Overlays:
Activation:
SetCreativeCodeParamValue.php ? sessionID = ... & paramID = ...
[ & fileID = ... ]
[ & value = ... ]
Description:
Requirements for value vary depending on parameter type:
- if param type is input_text or select_area and has size set, then value should not be longer than size.
- if param type is input_text or select_area and has validationExpression set, then value should match that regexp.
- if param type is select, radio_button or check_box then value should be one of posibbleValues
Parameters:
- sessionID: string(16)
- paramID: uint
- fileID: uint - required for file parameter
- value: string(65535) - required for non-file parameter
Results:
<SetCreativeCodeParamValue>
<status>OK</status>
</SetCreativeCodeParamValue>
Throw Errors:
GetCreativeCodeParamTypesList [finished]
Overlays:
Activation:
GetCreativeCodeParamTypesList.php ? sessionID = ...
[ & namePattern = ... ]
Description:
Returns list of possible creative code param types.
- input_text
- text_area
- select
- file
- check_box
- radio_button
- color
- label
- html5
Parameters:
- sessionID: string(16)
- namePattern: string(100)
Results:
<GetCreativeCodeParamTypesList>
<status>OK</status>
<typesNumber>1234</typesNumber>
<types>
<type>
<typeID>1</typeID>
<name>input_text</name>
</type>
</types>
</GetCreativeCodeParamTypesList>
Throw Errors:
GetCreativeCodeParamAutocompleteTypesList [finished]
Overlays:
Activation:
GetCreativeCodeParamAutocompleteTypesList.php ? sessionID = ...
Description:
Returns list of possible creative code param autocompleted types.
Parameters:
- sessionID: string(16)
Results:
<GetCreativeCodeParamAutocompleteTypesList>
<status>OK</status>
<typesNumber>1</typesNumber>
<types>
<type>
<typeID>1</typeID>
<name>File</name>
</type>
</types>
</GetCreativeCodeParamAutocompleteTypesList>
Throw Errors:
GetCreativeFormsList [finished]
Overlays:
Activation:
GetCreativeFormsList.php ? sessionID = ...
[ & namePattern = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns List of all creative forms, matching specified criteria.
Parameters:
- sessionID: string(16)
- namePattern: string(100)
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetCreativeFormsList>
<status>OK</status>
<formsNumber>1234</formsNumber> : uint - all records number (if there were no limit and offset)
<forms>
<form>
<formID>1</formID>
<name>HTML</name>
</form>
</forms>
</GetCreativeFormsList>
Throw Errors:
GetCreativeTypesList [finished]
Overlays:
Activation:
GetCreativeTypesList.php ? sessionID = ...
[ & namePattern = ... ]
Description:
Returns list of creative types.
Parameters:
- sessionID: string(16)
- namePattern: string(100)
Results:
<GetCreativeTypesList>
<status>OK</status>
<typesNumber>1234</typesNumber>
<types>
<type>
<typeID>1</typeID>
<name>HTML</name>
</type>
</types>
</GetCreativeTypesList>