placement2

Get information about campaign placement.

Request format

Note

Pagination available.

https://adfox.yandex.com/api/v1
  ? object=campaign
  & action=info
  & actionObject=placement2
  & objectID=<integer>
  & dataType=<string>
  & websiteID=<integer>
  & sectionID=<integer>
  & isOn=<string>

objectID*

Campaign ID.

dataType*

Data type.

Acceptable values:

  • campaignSites: Site.

  • campaignSections: Section.

  • campaignPlaces: Placement.

  • placesComputed: A list of sites, sections, and placements.

websiteID*

Site ID.

The parameter is required for the campaignSections data type.

sectionID*

Section ID.

The parameter is required for the campaignPlaces data type.

isOn*

Output data about enabled/disabled placements.

Acceptable values:

  • on: Show data only about enabled placements.
  • off: Show data about enabled and disabled placements.

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <websiteID>{integer}</websiteID>
    <websiteName>{string}</websiteName>
    <isSiteOn>{integer}</isSiteOn>
    <pricingModel>{integer}</pricingModel>
    <itemCost>{integer}</itemCost>
    <itemQty>{integer}</itemQty>
    <maxImpressions>{integer}</maxImpressions>
    <maxImpressionsPerDay>{integer}</maxImpressionsPerDay>
    <maxImpressionsPerHour>{integer}</maxImpressionsPerHour>
    <impressions>{integer}</impressions>
    <impressionsPerDay>{integer}</impressionsPerDay>
    <impressionsPerHour>{integer}</impressionsPerHour>
    <maxClicks>{integer}</maxClicks>
    <maxClicksPerDay>{integer}</maxClicksPerDay>
    <maxClicksPerHour>{integer}</maxClicksPerHour>
    <clicks>{integer}</clicks>
    <clicksPerDay>{integer}</clicksPerDay>
    <clicksPerHour>{integer}</clicksPerHour>
    <maxActiveEvents>{integer}</maxActiveEvents>
    <maxActiveEventsPerDay>{integer}</maxActiveEventsPerDay>
    <maxActiveEventsPerHour>{integer}</maxActiveEventsPerHour>
    <activeEvents>{integer}</activeEvents>
    <activeEventsPerDay>{integer}</activeEventsPerDay>
    <activeEventsPerHour>{integer}</activeEventsPerHour>
    <isSiteLimitsOff>{integer}</isSiteLimitsOff>
    <dateStart>{date}</dateStart>
    <dateEnd>{date}</dateEnd>
    <rotationMethodID>{integer}</rotationMethodID>
    <targetingProfileID>{integer}</targetingProfileID>
    <profileWebsiteID>{integer}</profileWebsiteID>
    <isFullRedefinition>{integer}</isFullRedefinition>
    <isFullRedefinitionSimplified>{integer}</isFullRedefinitionSimplified>
    <daysElapsed>{integer}</daysElapsed>
  </row0>
</data>
</result>
</response>

Response parameters

code

Request processing status. For the key, see Error handling.

rows

Number of items in the response tree.

rowN

The item number in the response tree, where N is a number from 0 to rows-1 (where rows is the total number of items in the response).

websiteID

Website ID.

websiteName

The name of the website.

isSiteOn

Indicates whether the placement is enabled.

Acceptable values:

  • 0: Disabled.
  • 1: Enabled.

pricingModel

Pricing model.

itemCost

Unit cost.

itemQty

Number of units.

maxImpressions

Maximum number of impressions for this placement.

maxImpressionsPerDay

Maximum number of impressions per day for this placement.

maxImpressionsPerHour

Maximum number of impressions per hour for this placement.

impressions

Tag information for this placement represents impressions over the entire period.

impressionsPerDay

Tag information for this placement represents impressions in 24 hours.

impressionsPerHour

Tag information for this placement represents impressions in an hour.

maxClicks

Maximum number of clicks for this placement.

maxClicksPerDay

Maximum number of clicks per day for this placement.

maxClicksPerHour

Maximum number of clicks per hour for this placement.

clicks

Tag information for this placement represents clicks over the entire period.

clicksPerDay

Tag information for this placement represents clicks that occurred today.

clicksPerHour

Tag information for this placement represents clicks in an hour.

maxActiveEvents

Maximum number of event calls for this placement.

maxActive

Maximum number of event calls per day for this placement.

maxActiveEventsPerHour

Maximum number of event calls per hour for this placement.

activeEvents

Tag information for this placement represents events over the entire period.

activeEventsPerDay

Tag information for this placement represents events in 24 hours.

activeEventsPerHour

Tag information for this placement represents events in an hour.

dateStart

Start date for this placement.

dateEnd

End date of the campaign delivery for this placement.

rotationMethodID

Rotation method ID for this placement.

targetingProfileID

Targeting profile ID.

Acceptable values:

  • −1: Not redefined (the value is inherited from the level above).
  • 0: by priority.
  • 1: by % of traffic.

profileWebsiteID

Placement profile ID.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=campaign&action=info&actionObject=placement2&objectID=474205&dataType=campaignSites

Response:

<response>
<status>
  <code>0</code>
  <ID>474205</ID>
</status>
<result>
<data>
  <row0>
    <websiteID>35862</websiteID>
    <websiteName>1</websiteName>
    <isSiteOn>1</isSiteOn>
    <pricingModel>0</pricingModel>
    <itemCost>0.00</itemCost>
    <itemQty>0</itemQty>
    <maxImpressions>0</maxImpressions>
    <maxImpressionsPerDay>0</maxImpressionsPerDay>
    <maxImpressionsPerHour>0</maxImpressionsPerHour>
    <impressions>11</impressions>
    <impressionsPerDay>0</impressionsPerDay>
    <impressionsPerHour>0</impressionsPerHour>
    <maxClicks>0</maxClicks>
    <maxClicksPerDay>0</maxClicksPerDay>
    <maxClicksPerHour>0</maxClicksPerHour>
    <clicks>0</clicks>
    <clicksPerDay>0</clicksPerDay>
    <clicksPerHour>0</clicksPerHour>
    <maxActiveEvents>0</maxActiveEvents>
    <maxActiveEventsPerDay>0</maxActiveEventsPerDay>
    <maxActiveEventsPerHour>0</maxActiveEventsPerHour>
    <activeEvents>0</activeEvents>
    <activeEventsPerDay>0</activeEventsPerDay>
    <activeEventsPerHour>0</activeEventsPerHour>
    <isSiteLimitsOff>0</isSiteLimitsOff>
    <dateStart/>
    <dateEnd/>
    <rotationMethodID>-1</rotationMethodID>
    <targetingProfileID>-1</targetingProfileID>
    <profileWebsiteID>0</profileWebsiteID>
    <isFullRedefinition/>
    <isFullRedefinitionSimplified>0</isFullRedefinitionSimplified>
    <daysElapsed>0</daysElapsed>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the campaign object:

Previous
placement
Next
targeting
In this article: