advertiser
Get a list of users with the “advertiser” type.
Request format
Note
Pagination available.
https://adfox.yandex.com/api/v1
? object=account
& action=list
& actionObject=advertiser
& actionObjectID=<integer>
|
To get data for only one advertiser, specify their ID. Default value: |
* Required
Response format
<response>
<status>
<code>{integer}</code>
</status>
<result>
<data>
<row0>
<ID>{integer}</ID>
<account>{string}</account>
<company>{string}</company>
<firstName>{string}</firstName>
<lastName>{string}</lastName>
<eMail>{string}</eMail>
<country>{string}</country>
<state/>
<city>{string}</city>
<ZIPCode>{string}</ZIPCode>
<address1>{string}</address1>
<address2>{string}</address2>
<phone>{string}</phone>
<fax/>
<dateAdded>{string}</dateAdded>
<isByAssistantCreated>{integer}</isByAssistantCreated>
</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 |
|
Unique ID of the user with the “advertiser” type. |
|
Advertiser's account. |
|
Company name. |
|
Advertiser's name. |
|
Email address that the advertiser's access is registered to. |
|
Country. |
|
Region. |
|
City. |
|
Postal code. |
|
Address. |
|
Address (continued). |
|
Phone number. |
|
Fax. |
|
Add date. |
|
User with the “assistant” type is created. |
Sample request and response
Request:
https://adfox.yandex.com/api/v1?object=account&action=list&actionObject=advertiser
Response:
<response> <status> <code>0</code> </status> <result> <data> <row0> <ID>203478</ID> <account>ivanov</account> <company>Example LLC</company> <firstName>Ivan</firstName> <lastName>Ivanov</lastName> <eMail>ivanov@yandex.com</eMail> <country>Russian Federation</country> <state/> <city>Moscow</city> <ZIPCode>123456</ZIPCode> <address1>ul. Stroiteley, 3</address1> <address2>room 305</address2> <phone>+7 (495) 555-55-55</phone> <fax/> <dateAdded>0000-00-00</dateAdded> <isByAssistantCreated>0</isByAssistantCreated> </row0> </data> </result> </response>
Other actions with the object
See more actions with the advertiser
object:
- Add an advertiser.
- Delete an advertiser.
- Edit an advertiser.
- Add an action tracing point for the advertiser.
To get data for only one advertiser, specify their ID.
Default value: 0
(display the list of all users with the “advertiser” type).
Required