erirRegions

Get the list of ERIR's (Unified Register of Online Advertising) ad impression regions.

Request format

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

Response format

<response>
  <status>
    <code>{integer}</code>
  </status>
  <result>
    <links>
      <first></first>
      <prev></prev>
      <next></next>
      <last></last>
    </links>
    <limit>{integer}</limit>
    <offset>{integer}</offset>
    <total_pages>{integer}</total_pages>
    <page>{integer}</page>
    <total_rows>{integer}</total_rows>
    <rows>{integer}</rows>
    <data>
      <row0>
        <ID>{integer}</ID>
        <NAME>{string}</NAME>
      </row0>
    </data>
  </result>
</response>

Response parameters

`code`	Request processing status. A value of `0` means the request was completed successfully. For the key, see Error handling.
`row0`	List item with its corresponding number.
`ID`	Region ID in the ERIR's reference list. Use the obtained value to update the `markingSelectedRegions` field.
`NAME`	Name of the region in text form.

Sample request and response

Request:

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

Response:

<response>
  <status>
    <code>0</code>
  </status>
  <result>
    <links>
      <first></first>
      <prev></prev>
      <next></next>
      <last></last>
    </links>
    <limit>86</limit>
    <offset>0</offset>
    <total_pages>1</total_pages>
    <page>1</page>
    <total_rows>86</total_rows>
    <rows>86</rows>
    <data>
      <row0>
        <ID>1</ID>
        <NAME>Республика Адыгея</NAME>
      </row0>
      ...
      <row85>
        <ID>99</ID>
        <NAME>Иные территории</NAME>
      </row85>
    </data>
  </result>
</response>

Was the article helpful?

defaultBanner

place