targetingProfile

Получить список профилей таргетирования.

Формат запроса

Примечание

Доступна пагинация.

https://adfox.yandex.ru/api/v1
  ? object=account
  & action=list
  & actionObject=targetingProfile
  & [actionObjectID=<integer>]

actionObjectID

Чтобы получить данные только по одному объекту, укажите его ID.

Значение по умолчанию: 0 — выводить весь список.

Формат ответа

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>{integer}</ID>
     <name>{string}</name>
     <campaignID>{integer}</campaignID>
     <bannerID>{integer}</bannerID>
     <adnetworkID>{integer}</adnetworkID>
     <categoryID>{integer}</categoryID>
     <siteID>{integer}</siteID>
     <zoneID>{integer}</zoneID>
     <placeID>{integer}</placeID>
     <isTimeRedefined>{integer}</isTimeRedefined>
     <isFrequencyRedefined>{integer}</isFrequencyRedefined>
     <isUTRedefined>{integer}</isUTRedefined>
     <isGeographyRedefined>{integer}</isGeographyRedefined>
     <isPositionsRedefined>{integer}</isPositionsRedefined>
     <isKeywordsRedefined>{integer}</isKeywordsRedefined>
     <isSearchRequestsRedefined>{integer}</isSearchRequestsRedefined>
     <isOSsRedefined>{integer}</isOSsRedefined>
     <isBrowsersRedefined>{integer}</isBrowsersRedefined>
     <isCriteriasRedefined>{integer}</isCriteriasRedefined>
     <isIPsRedefined>{integer}</isIPsRedefined>
     <isGeographyEnabled>{integer}</isGeographyEnabled>
     <isPositionsEnabled>{integer}</isPositionsEnabled>
     <isOSsEnabled>{integer}</isOSsEnabled>
     <isBrowsersEnabled>{integer}</isBrowsersEnabled>
     <isAIPRubricatorEnabled>{integer}</isAIPRubricatorEnabled>
     <allowedIPs>{string}</allowedIPs>
     <notAllowedIPs>{string}</notAllowedIPs>
     <keywords>{string}</keywords>
     <keywordsNotAllowed>{string}</keywordsNotAllowed>
     <searchRequestKeywords>{string}</searchRequestKeywords>
     <searchRequestKeywordsNotAllowed>{string}</searchRequestKeywordsNotAllowed>
     <maxUniqueImpressions>{integer}</maxUniqueImpressions>
     <maxUniqueClicks>{integer}</maxUniqueClicks>
     <frequencyTypeImpressions>{integer}</frequencyTypeImpressions>
     <uniquePeriodImpressions>{integer}</uniquePeriodImpressions>
     <impressionsPerPeriod>{integer}</impressionsPerPeriod>
     <frequencyTypeClicks>{integer}</frequencyTypeClicks>
     <uniquePeriodClicks>{integer}</uniquePeriodClicks>
     <clicksPerPeriod>{integer}</clicksPerPeriod>
     <datePeriod>{date}</datePeriod>
     <dateAdded>{date}</dateAdded>
   </row0>
</response>

Параметры ответа

code

Статус обработки запроса. Значение 0 — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.

rows

Количество элементов в дереве ответа.

rowN

Порядковый номер элемента в дереве ответа, где N — число от 0 до rows-1 (где rows — общее количество элементов в ответе).

ID

ID профиля таргетирования.

name

Название профиля.

campaignID

ID кампании.

bannerID

ID баннера.

adnetworkID

ID рекламной сети.

categoryID

ID категории.

siteID

ID сайта.

zoneID

ID раздела сайта.

placeID

ID площадки.

Настройки профиля таргетирования:

isTimeRedefined

По времени.

isFrequencyRedefined

По частоте.

isUTRedefined

По поведению.

isGeographyRedefined

По географии.

isPositionsRedefined

По расположениям.

isKeywordsRedefined

По ключевым словам.

isSearchRequestsRedefined

По поисковым запросам.

isOSsRedefined

По операционным системам.

isBrowsersRedefined

По браузерам.

isCriteriasRedefined

Дополнительные таргетинги.

isIPsRedefined

По IP-адресу.

isGeographyEnabled

Доступно таргетирование по географии.

isPositionsEnabled

Доступно таргетирование по расположениям.

isOSsEnabled

Доступно таргетирование по операционным системам.

isBrowsersEnabled

Доступно таргетирование по браузерам.

allowedIPs

Разрешенные адреса в таргетировании по IP.

notAllowedIPs

Запрещенные адреса в таргетировании по IP.

keywords

Ключевые фразы в таргетировании по ключевым словам.

keywordsNotAllowed

Запрещенные ключевые фразы в таргетировании по ключевым словам.

searchRequestKeywords

Поисковые запросы в таргетировании по поисковым запросам.

searchRequestKeywordsNotAllowed

Запрещенные поисковые запросы в таргетировании по поисковым запросам.

maxUniqueImpressions

Максимальное количество показов посетителю в таргетировании по частоте.

maxUniqueClicks

Максимальное количество переходов для посетителя в таргетировании по частоте.

frequencyTypeImpressions

Период частоты показов в таргетировании по частоте.

uniquePeriodImpressions

Специальный период показов в таргетировании по частоте (в секундах).

impressionsPerPeriod

Количество показов за период в таргетировании по частоте.

frequencyTypeClicks

Период частоты переходов в таргетировании по частоте.

Допустимые значения:

  • 0 — не задано;
  • 1 — 1 час;
  • 2 — 4 часа;
  • 3 — 6 часов;
  • 4 — 12 часов;
  • 5 — сутки;
  • 6 — неделя;
  • 7 — месяц;
  • 8 — другой период;
  • 9 — 14 дней.

uniquePeriodClicks

Специальный период переходов в таргетировании по частоте (в секундах).

clicksPerPeriod

Количество переходов за период в таргетировании по частоте.

datePeriod

Дата начала периода в таргетировании по частоте.

dateAdded

Дата добавления.

Пример запроса и ответа

Запрос:

https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=targetingProfile

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>523447</ID>
     <name>example</name>
     <campaignID>0</campaignID>
     <bannerID>0</bannerID>
     <adnetworkID>0</adnetworkID>
     <categoryID>0</categoryID>
     <siteID>0</siteID>
     <zoneID>0</zoneID>
     <placeID>0</placeID>
     <isTimeRedefined>1</isTimeRedefined>
     <isFrequencyRedefined>0</isFrequencyRedefined>
     <isUTRedefined>0</isUTRedefined>
     <isGeographyRedefined>0</isGeographyRedefined>
     <isPositionsRedefined>0</isPositionsRedefined>
     <isKeywordsRedefined>0</isKeywordsRedefined>
     <isSearchRequestsRedefined>0</isSearchRequestsRedefined>
     <isOSsRedefined>0</isOSsRedefined>
     <isBrowsersRedefined>0</isBrowsersRedefined>
     <isCriteriasRedefined>000000000000000000000000000000000000000000000000000000000000000
</isCriteriasRedefined>
     <isIPsRedefined>0</isIPsRedefined>
     <isGeographyEnabled>0</isGeographyEnabled>
     <isPositionsEnabled>0</isPositionsEnabled>
     <isOSsEnabled>0</isOSsEnabled>
     <isBrowsersEnabled>0</isBrowsersEnabled>
     <isAIPRubricatorEnabled>0</isAIPRubricatorEnabled>
     <allowedIPs/>
     <notAllowedIPs/>
     <keywords/>
     <keywordsNotAllowed/>
     <searchRequestKeywords/>
     <searchRequestKeywordsNotAllowed/>
     <maxUniqueImpressions>0</maxUniqueImpressions>
     <maxUniqueClicks>0</maxUniqueClicks>
     <frequencyTypeImpressions>0</frequencyTypeImpressions>
     <uniquePeriodImpressions>0</uniquePeriodImpressions>
     <impressionsPerPeriod>1</impressionsPerPeriod>
     <frequencyTypeClicks>0</frequencyTypeClicks>
     <uniquePeriodClicks>0</uniquePeriodClicks>
     <clicksPerPeriod>1</clicksPerPeriod>
     <datePeriod/>
     <dateAdded>2021-11-06</dateAdded>
   </row0>
</response>

Чтобы получить данные только по одному объекту, укажите его ID.

Значение по умолчанию: 0 — выводить весь список.

Предыдущая
superCampaign
Следующая
template