targetingProfile
Get a list of targeting profiles.
Request format
Note
Pagination available.
https://adfox.yandex.com/api/v1
? object=account
& action=list
& actionObject=targetingProfile
& [actionObjectID=<integer>]
|
|
To get data for only one profile, specify its ID. Default value: |
* Required
Response format
<response>
<status>
<code>{integer}</code>
</status>
<result>
<data>
<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>
</data>
</result>
</response>
Response parameters
|
|
Request processing status. If the value is |
|
|
Number of items in the response tree. |
|
|
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). |
|
|
Unique ID of the targeting profile. |
|
|
Profile name. |
|
|
Campaign ID. |
|
|
Banner ID. |
|
|
Ad network ID. |
|
|
Category ID. |
|
|
Site ID. |
|
|
Section ID. |
|
|
Placement ID. |
|
Targeting profile settings: |
|
|
|
by time. |
|
|
by frequency. |
|
|
by behavior. |
|
|
by geography. |
|
|
by position. |
|
|
by keywords. |
|
|
by search queries. |
|
|
by operating system. |
|
|
by browser. |
|
|
Additional targeting settings. |
|
|
by IP address. |
|
|
Targeting by geography is available. |
|
|
Targeting by position is available. |
|
|
Targeting by operating system is available. |
|
|
Targeting by browser is available. |
|
|
Allowed addresses for targeting by IP. |
|
|
Prohibited addresses for targeting by IP. |
|
|
Keywords for targeting by keywords. |
|
|
Prohibited keywords for targeting by keywords. |
|
|
Search queries for targeting by search queries. |
|
|
Prohibited search queries for targeting by search queries. |
|
|
Maximum number of impressions per user for targeting by frequency. |
|
|
Maximum number of clicks per user for targeting by frequency. |
|
|
Impression frequency period for targeting by frequency. |
|
|
Special impression period for targeting by frequency (value in seconds). |
|
|
Number of impressions per period for targeting by frequency. |
|
|
Click frequency period for targeting by frequency. Acceptable values:
|
|
|
Special click period for targeting by frequency (value in seconds). |
|
|
Number of clicks per period for targeting by frequency. |
|
|
Period start date for targeting by frequency. |
|
|
Profile creation date. |
Sample request and response
Request:
https://adfox.yandex.com/api/v1?object=account&action=list&actionObject=targetingProfileResponse:
<response> <status> <code>0</code> </status> <result> <data> <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>00000000000000000000000000</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> </data> </result> </response>
To get data for only one profile, specify its ID.
Default value: 0 (display the list of all targeting profiles).
Required