website

Get an ad tag from the site level. You should obtain the site-level ad tag for the placement once and install it on all the pages of your site.

When the site page loads, the ad tag sends a request to Adfox along with information about the site page address.

With section page templates, Adfox determines which section the page that the request was sent from belongs to and finds a placement in this section. If there are banners from commercial campaigns on the placement, the system selects the most suitable banner to serve. If there are no commercial campaigns to display, either the backup ad from the placement level or the backup ad from the banner type level is served.

Request format

https://adfox.yandex.com/api/v1
  ? object=placement
  & action=info
  & mode=website
  & websiteID=<integer>
  & bannerTypeID=<integer>
  & positionID=<integer>
  & [synchronousFactor=<integer>]
  & [parametersDivider=<integer>]
  & [nonRepeatingPlaces=<integer>]

websiteID*

Site ID.

Read also:

bannerTypeID*

The ID of the banner type that's specified for the placement.

Read also:

positionID*

Placement position ID.

Read also:

synchronousFactor

Ad tag type.

Acceptable values:

  • 1: Asynchronous.
  • 2: Asynchronous with scroll check.
  • 3: Adaptive.

Default value: 1.

parametersDivider

Request parameter separator. Not used in ad tags with a loader.

Acceptable values:

  • 0 — &amp;
  • 1 — &.

Default value: 0.

nonRepeatingPlaces

Get a specific number of ad tags for unrepeatable placements.

Acceptable values: from 1 to 20.

Default value: 1.

Sample request

Request:

https://adfox.yandex.com/api/v1?object=placement&action=info&mode=website&websiteID=3453&bannerTypeID=123&positionID=3

Other actions with the object

See more actions with the website object:

Site ID.

Read also:

The ID of the banner type that's specified for the placement.

Read also:

Placement position ID.

Read also:

Ad tag type.

Acceptable values:

  • 1: Asynchronous.
  • 2: Asynchronous with scroll check.
  • 3: Adaptive.

Default value: 1.

Request parameter separator. Not used in ad tags with a loader.

Acceptable values:

  • 0 — &amp;
  • 1 — &.

Default value: 0.

Get a specific number of ad tags for unrepeatable placements.

Acceptable values: from 1 to 20.

Default value: 1.

Required parameter.

Previous