targetingProfile
Получить список профилей таргетирования.
Формат запроса
Примечание
Доступна пагинация.
https://adfox.yandex.ru/api/v1
? object=account
& action=list
& actionObject=targetingProfile
& [actionObjectID=<integer>]
|
Чтобы получить данные только по одному профилю, укажите его идентификатор. Значение по умолчанию: 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>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Количество элементов в дереве ответа. |
|
Порядковый номер элемента в дереве ответа, где N — число от 0 до rows-1 (где rows — общее количество элементов в ответе). |
|
Уникальный идентификатор профиля таргетирования. |
|
Название профиля. |
|
ID кампании. |
|
ID баннера. |
|
ID рекламной сети. |
|
ID категории. |
|
ID сайта. |
|
ID раздела. |
|
ID площадки. |
Настройки профиля таргетирования: |
|
|
По времени. |
|
По частоте. |
|
По поведению. |
|
По географии. |
|
По расположениям. |
|
По ключевым словам. |
|
По поисковым запросам. |
|
По операционным системам. |
|
По браузерам. |
|
Дополнительные таргетинги. |
|
По IP-адресу. |
|
Доступно таргетирование по географии. |
|
Доступно таргетирование по расположениям. |
|
Доступно таргетирование по операционным системам. |
|
Доступно таргетирование по браузерам. |
|
Разрешенные адреса в таргетировании по IP. |
|
Запрещенные адреса в таргетировании по IP. |
|
Ключевые фразы в таргетировании по ключевым словам. |
|
Запрещенные ключевые фразы в таргетировании по ключевым словам. |
|
Поисковые запросы таргетировании по поисковым запросам. |
|
Запрещенные поисковые запросы в таргетировании по поисковым запросам. |
|
Максимальное количество показов посетителю в таргетировании по частоте. |
|
Максимальное количество переходов для посетителя в таргетировании по частоте. |
|
Период частоты показов таргетировании по частоте. |
|
Специальный период показов в таргетировании по частоте (значение в секундах). |
|
Количество показов за период таргетировании по частоте. |
|
Период частоты переходов в таргетировании по частоте. Возможные значения:
|
|
Специальный период переходов в таргетировании по частоте (значение в секундах). |
|
Количество переходов за период в таргетировании по частоте. |
|
Дата начала периода в таргетировании по частоте. |
|
Дата создания профиля. |
Пример запроса и ответа
Запрос:
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>
Чтобы получить данные только по одному профилю, укажите его идентификатор.
Значение по умолчанию: 0 — выводить список всех профилей таргетирования.
Обязательный параметр