GetStatGoals (Live)
Возвращает сведения о целях Яндекс Метрики, которые доступны для кампании.
Сведения о целях используются в двух случаях:
при формировании статистического отчета методом CreateNewReport (Live) можно указать идентификатор цели в параметре StatGoals;
в методе CreateOrUpdateCampaign (Live) для автоматической стратегии CPAOptimizer или AverageCPAOptimization можно указать идентификатор цели в параметре GoalID.
Новое в версии Live 4
За один вызов можно получить данные о целях нескольких кампаний. Идентификаторы кампаний указывают в параметре CampaignIDS. Также метод поддерживает формат стабильной версии 4 (см. GetStatGoals).
Добавлен результирующий параметр AvailableForStrategy.
Добавлен результирующий параметр AvailableForContextStrategy.
Добавлены результирующие параметры GoalsReached и ContextGoalsReached.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "GetStatGoals",
"param": {
/* CampaignIDInfo */
"CampaignIDS": [
(int)
...
]
}
}
Ниже приведено описание параметров.
Параметр | Описание | Требуется |
Объект CampaignIDInfo | ||
---|---|---|
CampaignIDS | Массив идентификаторов кампаний (не более 100). | Да |
Параметр | Описание | Требуется |
Объект CampaignIDInfo | ||
---|---|---|
CampaignIDS | Массив идентификаторов кампаний (не более 100). | Да |
Результирующие данные
Метод возвращает массив объектов, каждый из которых содержит информацию об одной цели, доступной для кампании. Ниже показана структура результирующих данных в формате JSON.
{
"data": [
{ /* StatGoalInfo */
"CampaignID": (int),
"GoalID": (int),
"Name": (string),
"AvailableForStrategy": (string),
"AvailableForContextStrategy": (string),
"GoalsReached": (int),
"ContextGoalsReached": (int)
}
...
]
}
Ниже приведено описание параметров.
Параметр | Описание |
Объект StatGoalInfo | |
---|---|
CampaignID | Идентификатор кампании, для которой доступна цель. |
GoalID | Идентификатор цели. |
Name | Название цели. |
AvailableForStrategy | Цель подходит для автоматических стратегий CPAOptimizer, AverageCPAOptimization или ROIOptimization — Yes/No на поиске. |
AvailableForContextStrategy | Смысл, как у предыдущего параметра, но относится к стратегиям в Рекламной сети Яндекса, а не к стратегиям на поиске. |
GoalsReached | Сколько раз достигнута цель при переходе с поиска за время сбора статистики. |
ContextGoalsReached | Сколько раз достигнута цель при переходе из Рекламной сети Яндекса за время сбора статистики. |
Параметр | Описание |
Объект StatGoalInfo | |
---|---|
CampaignID | Идентификатор кампании, для которой доступна цель. |
GoalID | Идентификатор цели. |
Name | Название цели. |
AvailableForStrategy | Цель подходит для автоматических стратегий CPAOptimizer, AverageCPAOptimization или ROIOptimization — Yes/No на поиске. |
AvailableForContextStrategy | Смысл, как у предыдущего параметра, но относится к стратегиям в Рекламной сети Яндекса, а не к стратегиям на поиске. |
GoalsReached | Сколько раз достигнута цель при переходе с поиска за время сбора статистики. |
ContextGoalsReached | Сколько раз достигнута цель при переходе из Рекламной сети Яндекса за время сбора статистики. |
Примеры входных данных
Python
{
'CampaignIDS': [1327944, 1342794]
}
PHP
array(
'CampaignIDS' => array(1327944, 1342794)
)
Perl
{
'CampaignIDS' => [1327944, 1342794]
}