Tracking Scripts

GetTrackingScripts [finished]

Overlays:

    Activation:

    GetTrackingScripts.php ? sessionID = ... & campaignID = ...     
        [ & placementIDs = ... ]
            
        [ & creativeIDs = ... ]
            
        [ & eventTypes = ... ]
            
        [ & impressionScriptType = ... ]
            
        [ & interactionScriptType = ... ]
            
        [ & addTargetUrl = ... ]
            
        [ & orderBy = ... ]
            
        [ & sortOrder = ... ]

    Description:

        Returns list of tracking scripts.

    Parameters:

    • sessionID: string(16)
    • campaignID: uint
    • placementIDs: uint list
    • creativeIDs: uint list
    • eventTypes: enum('impressions', 'clicks', 'interactions') list
    • impressionScriptType: enum('JS', 'HTML', 'TAG') list
    • interactionScriptType: enum('JS', 'HTML') list
    • addTargetUrl: enum('Y', 'N') default=Y - campaign or click tag target url will be inserted into script
    • orderBy: enum('Publishers', 'Nodes') default=Nodes
    • sortOrder: enum('asc', 'desc')

    Results:

    <GetTrackingScripts>
        <status>OK</status>
        <scriptsNumber>123</scriptsNumber> : uint - all records number
        <scripts>
            <script>
                <placementID>456</placementID> : uint
                <placementPath>asd/dfg/wer</placementPath> : string - size depends on placement tree depth
                <creativeID>567</creativeID> : uint
                <creativeName>sdf</creativeName> : string(63)
                <orderStartTS>345345</orderStartTS> : nullable uint
                <orderEndTS>4564546</orderEndTS> : nullable uint
                <eventType>impressions</eventType> : string(31)
                <interactionFunction>funkcja_eventu1</interactionFunction> : nullable string
                <clickTagMacro>CLICK_TAG_MACRO</clickTagMacro> : nullable string
                <scriptType>JS</scriptType> : string
                <code>(c) 2000-2009 Gemius SA, GDE+ 3.0: ....</code> : string
            </script>
        </scripts>
    </GetTrackingScripts>

    Throw Errors:



    GetPlacementCodes [finished]

    Overlays:

      Activation:

      GetPlacementCodes.php ? sessionID = ... & campaignID = ...     
          [ & placementIDs = ... ]
              
          [ & displayScriptType = ... ]
              
          [ & orderBy = ... ]
              
          [ & sortOrder = ... ]

      Description:

          Returns list of display scripts for placements.

      Parameters:

      • sessionID: string(16)
      • campaignID: uint
      • placementIDs: uint list
      • displayScriptType: enum('JS', 'IFRAME', 'XML') - default=JS
      • orderBy: enum('Publishers', 'Nodes') - default=Nodes
      • sortOrder: enum('asc', 'desc')

      Results:

      <GetPlacementCodes>
          <status>OK</status>
          <scriptsNumber>123</scriptsNumber> : uint - all records number
          <scripts>
              <script>
                  <placementID>456</placementID> : uint
                  <placementName>asd</placementName> : string(255)
                  <placementPath>wer/dfg/asd</placementPath> : string
                  <code>(c) 2000-2009 Gemius SA, GDE+ 3.0: ....</code> : string
              </script>
          </scripts>
      </GetPlacementCodes>

      Throw Errors: