Placements

AddPlacement [finished]

Overlays:

    Activation:

    AddPlacement.php ? sessionID = ... & parentID = ...     
        [ & publisherID = ... ]
            
        [ & hitCollectorID = ... ]
            
        [ & touchPointID = ... ]
            & name = ... & isFolder = ...     
        [ & iframeWidth = ... ]
            
        [ & iframeHeight = ... ]
            
        [ & categoryIDs = ... ]
            
        [ & impressionGoal = ... ]
            
        [ & clickGoal = ... ]
            
        [ & actionGoal = ... ]
            
        [ & pricingModelID = ... ]
            
        [ & cost = ... ]
            
        [ & comments = ... ]
            
        [ & tag1ID = ... ]
            
        [ & tag2ID = ... ]
            
        [ & label1 = ... ]
            
        [ & label2 = ... ]
            
        [ & microsoftClickTracking = ... ]
            
        [ & environment = ... ]
            
        [ & protocol = ... ]
            
        [ & domains = ... ]
            
        [ & inscreenDelay = ... ]
            
        [ & inscreenDuration = ... ]
            
        [ & inscreenThreshold = ... ]

    Description:

        Adds new placement to placements tree. No more than 1000 placements can be added in hour.

    Parameters:

    • sessionID: string(16)
    • parentID: uint - id of parent placement node
    • publisherID: nullable uint
    • hitCollectorID: nullable uint
    • touchPointID: nullable uint
    • name: string(255)
    • isFolder: enum('Y', 'N')
    • iframeWidth: nullable uint
    • iframeHeight: nullable uint
    • categoryIDs: uint list
    • impressionGoal: nullable uint
    • clickGoal: nullable uint
    • actionGoal: nullable uint
    • pricingModelID: nullable uint
    • cost: nullable uint
    • comments: string(255)
    • tag1ID: nullable uint
    • tag2ID: nullable uint
    • label1: string(63)
    • label2: string(63)
    • microsoftClickTracking: enum('Y', 'N')
    • environment: enum('application', 'browser_sync', 'browser_async')
    • protocol: enum('auto', 'http', 'https') default=auto
    • domains: string(4095)
    • inscreenDelay: nullable uint
    • inscreenDuration: nullable uint
    • inscreenThreshold: nullable uint

    Results:

    <AddPlacement>
        <status>OK</status>
        <placements>
            <placement>
                <placementID>1234</placementID> : uint
                <parentID>1234</parentID> : nullable uint
                <isFolder>Y</isFolder> : enum('Y', N')
                <name>nazwa</name> : string(255)
                <isGdePlus>Y</isGdePlus> : enum('Y', N')
                <iframeWidth>1234</iframeWidth> : nullable uint
                <iframeHeight>1234</iframeHeight> : nullable uint
                <publisherID>1234</publisherID> : nullable uint
                <hitCollectorID>8</hitCollectorID> : nullable uint
                <categoryIDs>12,31</categoryIDs> : uint list
                <touchPointID>31</touchPointID> : nullable uint
                <impressionGoal>124</impressionGoal> : nullable uint
                <clickGoal>124</clickGoal> : nullable uint
                <actionGoal>124</actionGoal> : nullable uint
                <pricingModelID>124</pricingModelID> : nullable uint
                <pricingModelName>Cost per Week</pricingModelName> : string(100)
                <cost>124</cost> : nullable uint
                <comments>124</comments> : nullable string(255)
                <creationTS>1234</creationTS> : uint
                <modificationTS>1235</modificationTS> : nullable uint
                <tag1ID>23</tag1ID> : nullable uint
                <tag1Name>aa</tag1Name> : string
                <tag2ID>34</tag2ID> : nullable uint
                <tag2Name>bb</tag2Name> : string
                <label1>23asda453h45jkh345</label1> : nullable string(63)
                <label2>23asda453h45jkh345</label2> : nullable string(63)
                <microsoftClickTracking>N</microsoftClickTracking> : enum('Y', N')
                <environment>browser_sync</environment> : enum('application', 'browser_sync', 'browser_async')
                <protocol>http</protocol> : enum('auto', 'http', 'https')
                <domains>bing.com,google.com</domains> : string
                <inscreenDelay>1000</inscreenDelay> : nullable uint
                <inscreenDuration>20000</inscreenDuration> : nullable uint
                <inscreenThreshold>25</inscreenThreshold> : nullable uint
            </placement>
        </placements>
    </AddPlacement>

    Throw Errors:


    UpdatePlacement [finished]

    Overlays:

      Activation:

      UpdatePlacement.php ? sessionID = ... & placementID = ...     
          [ & parentID = ... ]
              
          [ & publisherID = ... ]
              
          [ & hitCollectorID = ... ]
              
          [ & touchPointID = ... ]
              
          [ & name = ... ]
              
          [ & iframeWidth = ... ]
              
          [ & iframeHeight = ... ]
              
          [ & categoryIDs = ... ]
              
          [ & impressionGoal = ... ]
              
          [ & clickGoal = ... ]
              
          [ & actionGoal = ... ]
              
          [ & pricingModelID = ... ]
              
          [ & cost = ... ]
              
          [ & comments = ... ]
              
          [ & tag1ID = ... ]
              
          [ & tag2ID = ... ]
              
          [ & label1 = ... ]
              
          [ & label2 = ... ]
              
          [ & microsoftClickTracking = ... ]
              
          [ & environment = ... ]
              
          [ & protocol = ... ]
              
          [ & domains = ... ]
              
          [ & inscreenDelay = ... ]
              
          [ & inscreenDuration = ... ]
              
          [ & inscreenThreshold = ... ]

      Description:

          Changes given placement.

      Parameters:

      • sessionID: string(16)
      • placementID: uint
      • parentID: uint
      • publisherID: nullable uint
      • hitCollectorID: nullable uint
      • touchPointID: nullable uint
      • name: string
      • iframeWidth: nullable uint
      • iframeHeight: nullable uint
      • categoryIDs: uint list
      • impressionGoal: nullable uint
      • clickGoal: nullable uint
      • actionGoal: nullable uint
      • pricingModelID: nullable uint
      • cost: nullable uint
      • comments: string
      • tag1ID: nullable uint
      • tag2ID: nullable uint
      • label1: string
      • label2: string
      • microsoftClickTracking: enum('Y', 'N')
      • environment: enum('application', 'environment')
      • protocol: enum('auto', 'http', 'https') default=auto
      • domains: string(4095)
      • inscreenDelay: nullable uint
      • inscreenDuration: nullable uint
      • inscreenThreshold: nullable uint

      Results:

      <UpdatePlacement>
          <status>OK</status>
          <placements>
              <placement>
                  <placementID>1234</placementID> : uint
                  <parentID>1234</parentID> : nullable uint
                  <isFolder>Y</isFolder> : enum('Y', N')
                  <name>nazwa</name> : string(255)
                  <isGdePlus>Y</isGdePlus> : enum('Y', N')
                  <iframeWidth>1234</iframeWidth> : nullable uint
                  <iframeHeight>1234</iframeHeight> : nullable uint
                  <publisherID>1234</publisherID> : nullable uint
                  <hitCollectorID>8</hitCollectorID> : nullable uint
                  <categoryIDs>12,31</categoryIDs> : uint list
                  <touchPointID>31</touchPointID> : nullable uint
                  <impressionGoal>124</impressionGoal> : nullable uint
                  <clickGoal>124</clickGoal> : nullable uint
                  <actionGoal>124</actionGoal> : nullable uint
                  <pricingModelID>124</pricingModelID> : nullable uint
                  <pricingModelName>Cost per Week</pricingModelName> : string(100)
                  <cost>124</cost> : nullable uint
                  <comments>124</comments> : nullable string(255)
                  <creationTS>1234</creationTS> : uint
                  <modificationTS>1235</modificationTS> : nullable uint
                  <tag1ID>23</tag1ID> : nullable uint
                  <tag1Name>aa</tag1Name> : string
                  <tag2ID>34</tag2ID> : nullable uint
                  <tag2Name>bb</tag2Name> : string
                  <label1>23asda453h45jkh345</label1> : nullable string(63)
                  <label2>23asda453h45jkh345</label2> : nullable string(63)
                  <microsoftClickTracking>N</microsoftClickTracking> : enum('Y', N')
                  <environment>browser_sync</environment> : enum('application', 'browser_sync', 'browser_async')
                  <protocol>http</protocol> : enum('auto', 'http', 'https')
                  <domains>google.com,bing.com</domains> : string
                  <inscreenDelay>1000</inscreenDelay> : nullable uint
                  <inscreenDuration>20000</inscreenDuration> : nullable uint
                  <inscreenThreshold>25</inscreenThreshold> : nullable uint
              </placement>
          </placements>
      </UpdatePlacement>

      Throw Errors:


      DeletePlacement [finished]

      Overlays:

        Activation:

        DeletePlacement.php ? sessionID = ... & placementID = ...     
            [ & force = ... ]

        Description:

            Deletes given placement. If force is set to 'Y', then all orders for this placement will also be removed. If force is set to 'N', or not set and there exist orders for this placement this command will fail.

        Parameters:

        • sessionID: string(16)
        • placementID: uint
        • force: enum('Y', 'N')

        Results:

        <DeletePlacement>
            <status>OK</status>
        </DeletePlacement>

        Throw Errors:


        GetPlacementsList [finished]

        Overlays:

          Activation:

          GetPlacementsList.php ? sessionID = ...     
              [ & parentID = ... ]
                  
              [ & campaignID = ... ]
                  
              [ & userID = ... ]
                  
              [ & placementIDs = ... ]
                  
              [ & tag1IDs = ... ]
                  
              [ & tag2IDs = ... ]
                  
              [ & labels1 = ... ]
                  
              [ & labels2 = ... ]
                  
              [ & publisherID = ... ]
                  
              [ & categoryID = ... ]
                  
              [ & namePattern = ... ]
                  
              [ & commentsPattern = ... ]
                  
              [ & withParents = ... ]
                  
              [ & isFolder = ... ]
                  
              [ & showPaths = ... ]
                  
              [ & sortField = ... ]
                  
              [ & sortOrder = ... ]
                  
              [ & limit = ... ]
                  
              [ & offset = ... ]

          Description:

              Returns list of placements matching specified criteria. If withParents=Y,
              the returned list will be sorted in pre-order. (First root, then recursively
              his children in given order). Even if sortField is chosen, the stable pre-order
              sorting will be performed.
              Example:
                  (R)oot has 3 children: A, F, P
                  A has 3 children : D, J, Y
                  F has 2 children : C, H
                  P has no children.
                  Returned Order: R, A, D, J, Y, F, C, H, P

          Parameters:

          • sessionID: string(16)
          • parentID: uint
          • campaignID: uint
          • userID: uint
          • placementIDs: uint list
          • tag1IDs: uint list
          • tag2IDs: uint list
          • labels1: string(63) list
          • labels2: string(63) list
          • publisherID: uint
          • categoryID: uint
          • namePattern: string(100)
          • commentsPattern: string(255)
          • withParents: enum('Y','N') default=Y - completes ancestors recursively
          • isFolder: enum('Y','N') - N will work only when withParents=N
          • showPaths: enum('Y','N')
          • sortField: enum('name', 'creationTS', 'modificationTS', 'comments', 'label1', 'label2')
          • sortOrder: enum('asc','desc')
          • limit: uint - cannot be given when withParents=Y
          • offset: uint - cannot be given when withParents=Y

          Results:

          <GetPlacementsList>
              <status>OK</status>
              <placementsNumber>1234</placementsNumber> : uint - all records number (if there were no limit and offset)
              <placements>
                  <placement>
                      <placementID>1234</placementID> : uint
                      <parentID>1234</parentID> : nullable uint
                      <isFolder>Y</isFolder> : enum('Y', 'N')
                      <name>master</name> : string(255)
                      <comments>master</comments> : string(255)
                      <placementPath>../node3/master/</placementPath> : string
                      <placementFullPath>/node1/node2/node3/master/</placementFullPath> : string
                      <ordersCount>12</ordersCount> : uint
                      <isGdePlus>Y</isGdePlus> : enum('Y', 'N')
                      <creationTS>1234</creationTS> : uint
                      <modificationTS></modificationTS> : nullable uint
                      <tag1ID>23</tag1ID> : nullable uint
                      <tag2ID>34</tag2ID> : nullable uint
                      <label1>23asda453h45jkh345</label1> : nullable string(63)
                      <label2>23asda453h45jkh345</label2> : nullable string(63)
                      <environment>browser_sync</environment> : enum('application', 'browser_sync', 'browser_async')
                      <protocol>http</protocol> : enum('auto', 'http', 'https')
                      <domains>google.com,bing.com</domains> : string
                  </placement>
              </placements>
          </GetPlacementsList>

          Throw Errors:


          GetPlacementInfo [finished]

          Overlays:

            Activation:

            GetPlacementInfo.php ? sessionID = ... & placementID = ...

            Description:

                Returns detailed information about given placement.

            Parameters:

            • sessionID: string(16)
            • placementID: uint

            Results:

            <GetPlacementInfo>
                <status>OK</status>
                <placements>
                    <placement>
                        <placementID>1234</placementID> : uint
                        <parentID>1234</parentID> : nullable uint
                        <isFolder>Y</isFolder> : enum('Y', N')
                        <name>nazwa</name> : string(255)
                        <isGdePlus>Y</isGdePlus> : enum('Y', N')
                        <iframeWidth>1234</iframeWidth> : nullable uint
                        <iframeHeight>1234</iframeHeight> : nullable uint
                        <publisherID>1234</publisherID> : nullable uint
                        <hitCollectorID>8</hitCollectorID> : nullable uint
                        <categoryIDs>12,31</categoryIDs> : uint list
                        <touchPointID>31</touchPointID> : nullable uint
                        <impressionGoal>124</impressionGoal> : nullable uint
                        <clickGoal>124</clickGoal> : nullable uint
                        <actionGoal>124</actionGoal> : nullable uint
                        <pricingModelID>124</pricingModelID> : nullable uint
                        <pricingModelName>Cost per Week</pricingModelName> : string(100)
                        <cost>124</cost> : nullable uint
                        <comments>124</comments> : nullable string(255)
                        <creationTS>1234</creationTS> : uint
                        <modificationTS>1235</modificationTS> : nullable uint
                        <tag1ID>23</tag1ID> : nullable uint
                        <tag1Name>aa</tag1Name> : string
                        <tag2ID>34</tag2ID> : nullable uint
                        <tag2Name>bb</tag2Name> : string
                        <label1>23asda453h45jkh345</label1> : nullable string(63)
                        <label2>23asda453h45jkh345</label2> : nullable string(63)
                        <microsoftClickTracking>N</microsoftClickTracking> : enum('Y', N')
                        <environment>browser_sync</environment> : enum('application', 'browser_sync', 'browser_async')
                        <protocol>http</protocol> : enum('auto', 'http', 'https')
                        <domains>google.com,bing.com</domains> : string
                        <inscreenDelay>1000</inscreenDelay> : nullable uint
                        <inscreenDuration>20000</inscreenDuration> : nullable uint
                        <inscreenThreshold>25</inscreenThreshold> : nullable uint
                    </placement>
                </placements>
            </GetPlacementInfo>

            Throw Errors:


            CopyPlacementsTree [finished]

            Overlays:

              Activation:

              CopyPlacementsTree.php ? sessionID = ... & sourceNodeID = ... & destNodeID = ...

              Description:

                  following attributes are copied:
                      - publisherID
                      - hitCollectorID
                      - name
                      - comments
                      - categoryIDs
                      - touchPointID
                      - stawki dla statystyk kosztowych
                  If destNodeID is in a campaign:
                      - campaignID is copied from destNodeID
                      - publisherID is copied from destNodeID if it is defined there

                  No more than 1000 placements can be created in hour.

              Parameters:

              • sessionID: string(16)
              • sourceNodeID: uint
              • destNodeID: uint - this node will be parent for copied tree

              Results:

              <CopyPlacementsTree>
                  <status>OK</status>
                  <placementIDs>1234,1235,1236</placementIDs> : uint list - list of newly created placementIDs
              </CopyPlacementsTree>

              Throw Errors:


              GetPlacementCategoriesList [finished]

              Overlays:

                Activation:

                GetPlacementCategoriesList.php ? sessionID = ...

                Description:

                    Returns list of placement categories.

                Parameters:

                • sessionID: string(16)

                Results:

                <GetPlacementCategoriesList>
                    <status>OK</status>
                    <categoriesNumber>1234</categoriesNumber> : uint - records number
                    <categories>
                        <category>
                            <categoryID>1234</categoryID> : uint
                            <parentID>1234</parentID> : nullable uint
                            <name>Hobby</name> : string(255)
                            <comments>Hobby</comments> : nullable string(255)
                        </category>
                    </categories>
                </GetPlacementCategoriesList>

                Throw Errors:


                GetPlacementTouchPointsList [finished]

                Overlays:

                  Activation:

                  GetPlacementTouchPointsList.php ? sessionID = ...

                  Description:

                      Returns list of touch points.

                  Parameters:

                  • sessionID: string(16)

                  Results:

                  <GetPlacementTouchPointsList>
                      <status>OK</status>
                      <touchPointsNumber>1234</touchPointsNumber> : uint - records number
                      <touchPoints>
                          <touchPoint>
                              <touchPointID>1234</touchPointID> : uint
                              <name>Mailing</name> : string(255)
                              <comments>Hobby</comments> : string(255)
                          </touchPoint>
                      </touchPoints>
                  </GetPlacementTouchPointsList>

                  Throw Errors: