getCode

Получить код вставки для точки учета действия. Код точки учета действия обычно устанавливается на сайт рекламодателя для отслеживания поведения пользователя после контакта с рекламным объявлением.

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

https://adfox.yandex.ru/api/v1
  ? object=tracingPoint
  & action=getCode
  & objectID=<integer>

objectID*

ID объекта, над которым производится действие.

* Обязательный параметр

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

<response>
<status>
  <code>{integer}</code>
</status>
<result>
  <name1>{string}</name1>
  <code1>{string}</code1>
  <name2>{string}</name2>
  <code2>{string}</code2>
  <name3>{string}</name3>
  <code3>{string}</code3>
</result>
</response>

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

code

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

name1

Код загрузчика рекламы — название параметра.

code1

Код загрузчика, устанавливается в head страницы сайта.

name2

Код вставки точки учета (https) — название параметра.

code2

Код вставки точки учета действия.

name3

Ссылка на точку учета действий — название параметра.

code3

Ссылка на точку учета действия.

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

Запрос:

https://adfox.yandex.ru/api/v1?object=tracingPoint&action=getCode&objectID=3

Ответ:

<response>
<status>
  <code>0</code>
</status>
<result>
  <name1>Код загрузчика рекламы</name1>
  <code1>&lt;!--В &lt;head&gt; сайта один раз добавьте код загрузчика--&gt;
&lt;script&gt;window.yaContextCb = window.yaContextCb || []&lt;/script&gt;
&lt;script src="https://yandex.ru/ads/system/context.js" async&gt;&lt;/script&gt;</code1>
  <name2>Код вставки точки учета (https):</name2>
  <code2>&lt;!--AdFox START--&gt;
&lt;!--yandex_example--&gt;
&lt;!--Рекламодатель: advertiser_example--&gt;
&lt;!--Точка учета действия: ATP_Ex--&gt;
&lt;div id="adfox_123456789987654321"&gt;&lt;/div&gt;
&lt;script&gt;
window.yaContextCb.push(()=&gt;{
        window.Ya.adfoxCode.tracePoint({
            ownerId: 123456,
            containerId: 'adfox_123456789987654321',
            params: {
                p7: 'wtvn',
                p8: 'b'
            }
        })
    })
&lt;/script&gt;
&lt;!--AdFox END--&gt;</code2>
  <name3>Ссылка на точку учета действий</name3>
  <code3>https://yandex.ru/ads/adfox/123456/tracePoint?p7=wtvn&amp;p8=b</code3>
</result>
</response>

Другие действия с объектом

Читайте также о других действиях с объектом tracingPoint:

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