Запрос: спецификация отчета. Апи директ
клики и стоимость — Технологии Яндекса
Пример демонстрирует получение количества кликов и их стоимости (в валюте рекламодателя, с учетом НДС) для кампаний в разбивке по дням. Период отчета определяется автоматически (см. раздел Как получить актуальную статистику).
Запрос curl \ -H 'Authorization: Bearer 0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f' \ -H 'Accept-Language: en' \ -H 'Client-Login: agrom' \ -H 'returnMoneyInMicros: false' \ -d '{ "params": { "SelectionCriteria": { "Filter": [{ "Field": "CampaignId", "Operator": "IN", "Values": [ "10002", "10007" ] }] }, "FieldNames": [ "Date", "CampaignId", "Clicks", "Cost" ], "OrderBy": [{ "Field": "Date" }], "ReportName": "Actual Data", "ReportType": "CAMPAIGN_PERFORMANCE_REPORT", "DateRangeType": "AUTO", "Format": "TSV", "IncludeVAT": "YES", "IncludeDiscount": "YES" } }' \ https://api.direct.yandex.com/json/v5/reports curl \ -H 'Authorization: Bearer 0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f' \ -H 'Accept-Language: en' \ -H 'Client-Login: agrom' \ -H 'returnMoneyInMicros: false' \ -d '<?xml version="1.0" encoding="UTF-8"?> <ReportDefinition xmlns="http://api.direct.yandex.com/v5/reports"> <SelectionCriteria> <Filter> <Field>CampaignId</Field> <Operator>IN</Operator> <Values>10002</Values> <Values>10007</Values> </Filter> </SelectionCriteria> <FieldNames>Date</FieldNames> <FieldNames>CampaignId</FieldNames> <FieldNames>Clicks</FieldNames> <FieldNames>Cost</FieldNames> <OrderBy> <Field>Date</Field> </OrderBy> <ReportName>Actual Data</ReportName> <ReportType>CAMPAIGN_PERFORMANCE_REPORT</ReportType> <DateRangeType>AUTO</DateRangeType> <Format>TSV</Format> <IncludeVAT>YES</IncludeVAT> <IncludeDiscount>YES</IncludeDiscount> </ReportDefinition>' \ https://api.direct.yandex.com/v5/reports Отчет "Actual Data (2018-04-01 - 2018-04-03)" Date CampaignId Clicks Cost 2018-04-01 10002 6 90.20 2018-04-01 10007 397 1496.50 2018-04-02 10002 13 158.60 2018-04-02 10007 314 1181.40 2018-04-03 10002 15 165.10 2018-04-03 10007 447 1619.60 Total rows: 6API Директа — Группа объявлений (AdGroup) — Технологии Яндекса
Тип группы задается при создании и недоступен для изменения.
Набор параметров группы зависит от ее типа.
Общими параметрами для всех типов групп являются название, регионы показа и единые минус-фразы на группу. При создании или редактировании группы эти параметры необходимо передать в структуре AdGroups методов add, update. Чтобы получить эти параметры, необходимо перечислить имена параметров во входном параметре FieldNames метода get.
Параметры, зависящие от типа группы, передаются в дочерней структуре с соответствующим именем.
В настоящее время существуют следующие типы групп:
-
TEXT_AD_GROUP — группа текстово-графических объявлений.
Группа имеет только параметры, общие для всех типов групп.
Группа может иметь дочерние объекты — объявления, ключевые фразы и условия нацеливания на аудиторию. Для группы можно задать корректировки ставок.
-
MOBILE_APP_AD_GROUP — группа для рекламы мобильных приложений.
Для группы этого типа необходимо дополнительно указать ссылку на приложение в магазине приложений AppStore или Google Play, а также типы устройств, типы подключения к интернету и минимальную версию операционной системы, на которых может быть показано объявление. Подробнее о рекламе мобильных приложений см. в разделе Реклама мобильных приложений помощи Директа.
Чтобы создать или отредактировать группу, специфичные параметры для данного типа группы необходимо передать в структуре MobileAppAdGroup методов add, update.
При получении параметров группы необходимо перечислить имена параметров, общих для всех типов групп, во входном параметре FieldNames, а имена специфичных параметров — во входном параметре MobileAppAdGroupFieldNames метода get.
Группа может иметь дочерние объекты — объявления, ключевые фразы и условия нацеливания на аудиторию. Для группы можно задать корректировки ставок.
-
DYNAMIC_TEXT_AD_GROUP — группа динамических объявлений. Подробнее о динамических объявлениях см. в разделе Динамические объявления помощи Директа.
Существуют два подтипа групп динамических объявлений:
-
WEBPAGE — источником данных для генерации объявлений являются страницы сайта.
Для группы этого подтипа необходимо дополнительно указать рекламируемый домен.
Чтобы создать или отредактировать группу, специфичные параметры для данного типа группы необходимо передать в структуре DynamicTextAdGroup методов add, update.
При получении параметров группы необходимо перечислить имена параметров, общих для всех типов групп, во входном параметре FieldNames, а имена специфичных параметров — во входном параметре DynamicTextAdGroupFieldNames метода get.
Группа может иметь дочерние объекты — объявления и условия нацеливания. Для группы можно задать корректировки ставок.
-
FEED — источником данных для генерации объявлений является фид — файл с товарными предложениями.
Создание и редактирование группы этого подтипа в настоящее время возможно только в веб-интерфейсе.
При получении параметров группы необходимо перечислить имена параметров, общих для всех типов групп, во входном параметре FieldNames, а имена специфичных параметров — во входном параметре DynamicTextFeedAdGroupFieldNames метода get.
Группа может иметь дочерние объекты — объявления и фильтры для отбора товарных предложений из фида. Управление фильтрами доступно только в веб-интерфейсе. Для группы можно задать корректировки ставок.
-
tech.yandex.ru
API Директа — Роли и доступы пользователей Директа — Технологии Яндекса
Агентство может разрешить клиенту-рекламодателю доступ к его данным:-
Если агентство предоставило рекламодателю доступ в веб-интерфейс только на чтение, то и через API представители рекламодателя смогут только получать данные.
-
Если агентство предоставило рекламодателю полномочие на редактирование кампаний, то представители рекламодателя смогут управлять своими кампаниями как в веб-интерфейсе, так и через API.
У рекламодателя — клиента агентства могут быть представители со следующими ролями:
| Главный представитель | Имеет доступ на управление кампаниями рекламодателя — в пределах полномочий, предоставленных рекламодателю агентством. | Имеет полный доступ на управление представителями рекламодателя: добавление, удаление, восстановление, редактирование настроек, смену главного представителя — если агентство предоставило рекламодателю доступ в веб-интерфейс. |
| Представитель | Имеет доступ на управление кампаниями рекламодателя — в пределах полномочий, предоставленных рекламодателю агентством, аналогично главному представителю. | Имеет доступ на редактирование собственных настроек — если агентство предоставило рекламодателю доступ в веб-интерфейс. |
| Главный представитель | Имеет доступ на управление кампаниями рекламодателя — в пределах полномочий, предоставленных рекламодателю агентством. | Имеет полный доступ на управление представителями рекламодателя: добавление, удаление, восстановление, редактирование настроек, смену главного представителя — если агентство предоставило рекламодателю доступ в веб-интерфейс. |
| Представитель | Имеет доступ на управление кампаниями рекламодателя — в пределах полномочий, предоставленных рекламодателю агентством, аналогично главному представителю. | Имеет доступ на редактирование собственных настроек — если агентство предоставило рекламодателю доступ в веб-интерфейс. |
Таким образом, управлять кампаниями рекламодателя — клиента агентства могут как представители агентства, так и представители самого рекламодателя, если агентство предоставило соответствующий доступ.
tech.yandex.ru
| Параметр | Тип | Описание | Обяза-тельный |
| SelectionCriteria | SelectionCriteria | Да | |
| Goals | array of string | Идентификаторы целей Яндекс.Метрики, по которым требуется получить статистику (см. раздел Что такое цели. Типы целей помощи Яндекс.Метрики). Не более 10 элементов в массиве. Если параметр указан, то в отчете вместо полей ConversionRate, Conversions, CostPerConversion, GoalsRoi и Revenue с агрегированными данными по всем целям будут выведены аналогичные поля с именами вида <поле>_<id_цели>_<модель_атрибуции> и данными по каждой цели в отдельности. См. также Пример: данные Яндекс.Метрики. | Нет |
| AttributionModels | array of AttributionModelEnum | Модели атрибуции, используемые при расчете данных по целям Яндекс.Метрики (см. раздел Модели атрибуции помощи Директa).
Параметр AttributionModels можно указать, только если указан параметр Goals. Если параметр Goals указан, а параметр AttributionModels — нет, по умолчанию используется значение LSC. Если указано несколько моделей атрибуции, данные будут выведены по каждой модели в отдельности. Внимание.При использовании моделей атрибуции LSC и FC датой визита считается не дата фактического посещения сайта, а дата клика, который является источником визита. Таким образом, визит и его данные (глубина просмотра, достижение цели, доход и т. д.) будут отражены в отчете, если дата клика попадает в период отчета. При повторном получении отчета за тот же период с теми же параметрами данные Метрики в отчете могут измениться, если с момента предыдущего получения отчета произошли визиты, источником которых являются клики, совершенные в период отчета. | Нет |
| FieldNames | Имена полей (столбцов), которые будут присутствовать в отчете. Какие поля можно указывать, см. в разделах Допустимые поля, Несовместимые поля и зависимости. Для типа отчета REACH_AND_FREQUENCY_PERFORMANCE_REPORT поле CampaignId обязательно. | Да | |
| Page | Page | Ограничение на количество строк в отчете. Если не задано, используется ограничение 1 000 000. | Нет |
| OrderBy | array of OrderBy | Имена полей (столбцов), по которым требуется отсортировать строки в отчете. | Нет |
| ReportName | Название отчета. Выводится в первой строке отчета. В режиме офлайн название отчета должно быть уникальным для рекламодателя. Если отчет с таким названием, но с отличающимися параметрами уже сформирован или находится в очереди, выдается ошибка. | Да | |
| ReportType | ReportTypeEnum | Тип отчета. См. раздел Тип отчета выше. | Да |
| DateRangeType | DateRangeTypeEnum | Период, за который формируется отчет. См. раздел Период отчета выше. | Да |
| Format | FormatEnum | Формат отчета. В настоящее время поддерживается только значение TSV. | Да |
| IncludeVAT | YesNoEnum | Включать ли НДС в денежные суммы в отчете. Если рекламодатель работает в у. е. Директа, допускается только значение YES. | Да |
| IncludeDiscount | YesNoEnum | Учитывать ли скидку для денежных сумм в отчете. Если рекламодатель работает в у. е. Директа, допускается только значение NO. | Да |
| DateFrom | string | Начальная дата отчетного периода, YYYY-MM-DD. | При значении CUSTOM_DATE параметра DateRangeType |
| DateTo | string | Конечная дата отчетного периода, YYYY-MM-DD. Примечание. Параметры DateFrom и DateTo обязательны при значении CUSTOM_DATE параметра DateRangeType и недопустимы при других значениях. | |
| Filter | array of FilterItem | Фильтры. См. раздел Фильтрация данных выше. | Нет |
| Field | FieldEnum | Имя поля, которое используется для фильтрации данных. Каждое поле можно использовать только в одном фильтре: несколько фильтров с одним и тем же полем не допускается. Какие поля можно указывать, см. в разделах Допустимые поля, Несовместимые поля и зависимости. | Да |
| Operator | FilterOperatorEnum | Оператор, используемый для фильтрации данных:
Операторы EQUALS, NOT_EQUALS, IN, NOT_IN для полей Keyword и Query не учитывают регистр, для остальных полей — учитывают регистр. Операторы STARTS_WITH_IGNORE_CASE, DOES_NOT_START_WITH_IGNORE_CASE, STARTS_WITH_ANY_IGNORE_CASE, DOES_NOT_START_WITH_ALL_IGNORE_CASE не учитывают регистр. | Да |
| Values | array of string | Значения, используемые для фильтрации данных. Не более 10 000 элементов в массиве. Все денежные значения следует указывать в виде целых чисел: сумм в валюте, умноженных на 1 000 000 (независимо от наличия заголовка returnMoneyInMicros: false). | Да |
| Limit | int | Максимальное количество строк в отчете. | Да |
| Field | FieldEnum | Имя поля, которое используется для сортировки. Какие поля можно указывать, см. в разделах Допустимые поля, Несовместимые поля и зависимости. | Да |
| SortOrder | OrderBySortOrderEnum | Направление сортировки: Если не задано, выполняется сортировка по возрастанию. | Нет |
tech.yandex.ru
