Creative Templates

GetCreativeTemplatesList [finished]

Overlays:

    Activation:

    GetCreativeTemplatesList.php ? sessionID = ...     
        [ & templateIDs = ... ]
            
        [ & typeID = ... ]
            
        [ & isBlocked = ... ]
            
        [ & onlyPrivate = ... ]
            
        [ & supportingBatchUpload = ... ]
            
        [ & namePattern = ... ]
            
        [ & commentsPattern = ... ]
            
        [ & sortField = ... ]
            
        [ & sortOrder = ... ]
            
        [ & limit = ... ]
            
        [ & offset = ... ]

    Description:

        Returns list of creative templates matching specified criteria.

    Parameters:

    • sessionID: string(16)
    • templateIDs: uint list
    • typeID: uint
    • isBlocked: enum('Y', 'N')
    • onlyPrivate: enum('Y', 'N') default 'N' - returns only user-defined templates
    • supportingBatchUpload: enum('Y', 'N') - returns only templates for which gDE is able to fill all params which are obligatory and do not have default value
    • namePattern: string(100)
    • commentsPattern: string(255)
    • sortField: enum('name', 'ownerLogin', 'typeName', 'creationTS', 'comments')
    • sortOrder: enum('asc', 'desc')
    • limit: uint - limits result to given number of records
    • offset: uint - skips given number of records

    Results:

    <GetCreativeTemplatesList>
        <status>OK</status>
        <templatesNumber>1234</templatesNumber> : uint - all records number (if there were no limit and offset)
        <templates>
            <template>
                <templateID>12</templateID> : uint
                <name>XML - templ</name> : string(63)
                <isGlobal>Y</isGlobal> : enum('Y', 'N')
                <countryIDs>42,67,72</countryIDs> : uint list
                <isBlocked>Y</isBlocked> : enum('Y', 'N')
                <isIntrusive>Y</isIntrusive> : enum('Y', 'N')
                <alignmentPossible>Y</alignmentPossible> : enum('Y', 'N')
                <typeID>1</typeID> : uint
                <typeName>1</typeName> : string(100)
                <creativeCodeID>1234</creativeCodeID> : uint - creative template code ID, deep copies are assigned to creatives
                <creationTS>1242123024</creationTS> : uint
                <comments>lala</comments> : string
            </template>
        </templates>
    </GetCreativeTemplatesList>

    Throw Errors: