--- metadata: - name: generator content: Diplodoc Platform v5.50.2 alternate: - https://yandex.com/dev/direct/doc/dg-v4/en/reference/GetCampaignsParams.md - https://yandex.com/dev/direct/doc/dg-v4/ru/reference/GetCampaignsParams.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/direct/doc/dg-v4/ru/llms.txt # GetCampaignsParams Возвращает параметры кампаний. Для метода существует версия [GetCampaignsParams (Live)](https://yandex.ru/dev/direct/doc/dg-v4/live/GetCampaignsParams.html). ## Ограничения {% note alert %} Метод возвращает только кампании с типом “Текстово-графические объявления”“Text & Image Ads”. Для работы с кампаниями всех типов используйте сервис [Campaigns](https://yandex.ru/dev/direct/doc/ru/campaigns/campaigns) API версии 5. [Подробнее о типах кампаний...](https://yandex.ru/dev/direct/doc/dg/objects/campaign.md) {% endnote %} ## Входные данные {#input} Ниже показана структура входных данных в формате JSON. ```javascript { "method": "GetCampaignsParams", "param": { /* CampaignIDSInfo */ "CampaignIDS": [ (int) ... ] } } ``` Ниже приведено описание параметров. #| || **Параметр** | **Описание** | **Требуется** || || **Объект CampaignIDSInfo** || || `CampaignIDS` | Массив идентификаторов кампаний, параметры которых требуется получить (не более 100 идентификаторов). | Да || |# ## Результирующие данные {#output} Метод возвращает массив объектов `CampaignInfo`. Каждый объект содержит параметры одной кампании. Ниже показана структура результирующих данных в формате JSON. ```javascript { "data": [ { /* CampaignInfo */ "Login": (string), "CampaignID": (int), "Name": (string), "FIO": (string), "StartDate": (date), "Sum": (float), "Rest": (float), "Shows": (int), "Clicks": (int), "Strategy": { /* CampaignStrategy */ "StrategyName": (string), "MaxPrice": (float), "AveragePrice": (float), "WeeklySumLimit": (float), "ClicksPerWeek": (int) }, "SmsNotification": { /* SmsNotificationInfo */ "MetricaSms": (string), "ModerateResultSms": (string), "MoneyInSms": (string), "MoneyOutSms": (string), "SmsTimeFrom": (string), "SmsTimeTo": (string) }, "EmailNotification": { /* EmailNotificationInfo */ "Email": (string), "SendWarn": (string), "WarnPlaceInterval": (int), "MoneyWarningValue": (int), "SendAccNews": (string) }, "StatusBehavior": (string), "Status": (string), "TimeTarget": { /* TimeTargetInfo */ "ShowOnHolidays": (string), "HolidayShowFrom": (int), "HolidayShowTo": (int), "DaysHours": [ { /* TimeTargetItem */ "Hours": [ (int) ... ], "Days": [ (int) ... ] } ... ], "TimeZone": (string) }, "StatusContextStop": (string), "ContextLimit": (string), "ContextLimitSum": (int), "ContextPricePercent": (int), "AutoOptimization": (string), "StatusMetricaControl": (string), "DisabledDomains": (string), "DisabledIps": (string), "StatusOpenStat": (string), "ConsiderTimeTarget": (string), "ManagerName": (string), "AgencyName": (string), "StatusShow": (string), "StatusArchive": (string), "StatusActivating": (string), "StatusModerate": (string), "IsActive": (string), "MinusKeywords": [ (string) ... ], "AddRelevantPhrases": (string), "RelevantPhrasesBudgetLimit": (int), "SumAvailableForTransfer": (float) } ... ] } ``` Ниже приведено описание параметров. #| || **Параметр** | **Описание** || || **Объект CampaignInfo** || || `Login` | Логин владельца кампании (логин пользователя Яндекса, в пользу которого ведется рекламная кампания). При создании кампании прямые рекламодатели указывают собственный логин в Яндексе, рекламные агентства — логин своего клиента. При получении параметров кампании возвращается логин главного представителя рекламодателя. || || `CampaignID` | Идентификатор кампании. Для создания кампании задают 0, для изменения параметров существующей кампании указывают ее идентификатор. || || `Name` | Название кампании. || || `FIO` | Имя и фамилия владельца кампании. || || `StartDate` | Начало показа объявлений, `YYYY-MM-DD`. Если не задана, используется дата создания кампании. Дата может находиться в будущем. В этом случае показ объявлений начинается при наступлении указанной даты, если модератор одобрил объявления и внесены средства на баланс кампании. || || `ManagerName` | Имя персонального менеджера в Яндексе. Заполняется автоматически для кампаний, обслуживаемых персональным менеджером. || || `AgencyName` | Название рекламного агентства. Заполняется автоматически, если создателем кампании является агентство. || || `Strategy` | Определяет стратегию показов на поиске. Содержит объект `CampaignStrategy` с параметрами стратегии. || || `SmsNotification` | Объект `SmsNotificationInfo` с параметрами отправки SMS-уведомлений. Чтобы получать уведомления, необходимо подписаться на них (см. раздел справки [Подпишитесь на SMS-уведомления](https://yandex.ru/support/direct/efficiency/sms-alerts.xml)[Subscribe to SMS notifications](https://yandex.com/support/direct/efficiency/sms-alerts.xml)). Телефонный номер для отправки берется из персональных данных пользователя (см. раздел справки [Номера телефонов](https://yandex.ru/support/passport/authorization/phone.xml)[Mobile numbers](https://yandex.com/support/passport/authorization/phone.xml)). || || `EmailNotification` | Объект `EmailNotificationInfo` с параметрами отправки уведомлений по электронной почте. || || `TimeTarget` | Объект `TimeTargetInfo` с параметрами временного таргетинга. || || `AutoOptimization` | Включить [автоматическое уточнение](https://yandex.ru/support/direct/impressions/autofocus.xml)[автоматическое уточнение](https://yandex.com/support/direct/impressions/autofocus.xml) фраз — Yes/No. Предустановленное значение — No. || || `DisabledIps` | Список IP-адресов, которым не нужно показывать объявления. Адреса указывают через запятую, например `127.0.0.1,127.0.0.2` || || `ConsiderTimeTarget` | Рассчитывать цены позиций показа без учета ставок в остановленных объявлениях конкурентов (остановлены в соответствии с расписанием), — Yes/No. Предустановленное значение — No (учитываются все объявления). || || `MinusKeywords` | Массив минус-фраз, общих для всех ключевых фраз кампании. Минус-фразу следует указывать без минуса перед первым словом. Не более 7 слов в минус-фразе. Длина каждого слова — не более 35 символов. Суммарная длина минус-фраз в массиве — 20000 символов. Оператор “!” или “+” перед словом не учитывается в суммарной длине. || || `AddRelevantPhrases` | Добавлять [дополнительные релевантные фразы](https://yandex.ru/support/direct/features/relevant-keywords.xml)[дополнительные релевантные фразы](https://yandex.com/support/direct/features/relevant-keywords.xml) к объявлениям — Yes/No. || || `RelevantPhrasesBudgetLimit` | Максимальный процент бюджета, расходуемый на клики по [дополнительным релевантным фразам](https://yandex.ru/support/direct/features/relevant-keywords.xml)[дополнительным релевантным фразам](https://yandex.com/support/direct/features/relevant-keywords.xml). Значение кратно десяти: 10, 20, ..., 100. Предустановленное значение — 100. || || `StatusBehavior` | Включить [поведенческий таргетинг](https://yandex.ru/support/direct/impressions/behavioral-targeting.xml)[поведенческий таргетинг](https://yandex.com/support/direct/impressions/behavioral-targeting.xml) — Yes/No. Предустановленное значение — Yes. || || `StatusMetricaControl` | Останавливать показы при недоступности сайта рекламодателя — Yes/No. Недоступность выявляется по результатам мониторинга, проводимого Директом. || || `StatusContextStop` | Не использовать в Рекламной сети Яндекса фразы, отключенные на поиске за низкий CTR, — Yes/No. Предустановленное значение — No (при отключении на поиске фраза продолжает использоваться в Рекламной сети Яндекса). {% note alert %} Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR. {% endnote %} || || `StatusOpenStat` | При переходе на сайт рекламодателя добавлять к URL метку в формате [OpenStat](https://yandex.ru/support/direct/statistics/url-tags.xml#openstat-title) — Yes/No. Предустановленное значение — No. || || `SumAvailableForTransfer` | Сумма, доступная для перевода с помощью метода [TransferMoney](https://yandex.ru/dev/direct/doc/dg-v4/reference/TransferMoney.html). Может быть меньше баланса кампании. Возвращается только в случае, если общий счет у рекламодателя не подключен. || || **Рекламная сеть Яндекса** || || `ContextPricePercent` | Максимальная ставка в Рекламной сети Яндекса в процентах от ставки на поиске. Значение кратно десяти: 10, 20... 100. Предустановленное значение — 100. || || `ContextLimit` | Ограничение бюджета на показ объявлений в Рекламной сети Яндекса: - Default — бюджет не ограничен (предустановленное значение); - Limited — бюджет ограничен значением параметра `ContextLimitSum`. || || `ContextLimitSum` | Максимальный процент бюджета на показ объявлений в Рекламной сети Яндекса. Значение должно быть кратно десяти или равняться нулю: 0, 10, 20... 100. При значении 0 показы в Рекламной сети выключаются. Предустановленное значение NULL не накладывает ограничение на бюджет, что равнозначно Default в параметре `ContextLimit`. || || `DisabledDomains` | Список мест показа, где не нужно показывать объявления: - доменные имена сайтов; - идентификаторы мобильных приложений (bundle ID для iOS, package name для Android); - имена внешних сетей (SSP). Не более 1000 мест показа. Значения указывают через запятую, например `site.ru,ru.example.app`. || || **Состояние кампании** || || `IsActive` | Кампания активна, объявления показываются — Yes/No. Под активностью понимается состояние кампании, при котором показ объявлений включается и выключается автоматически — в соответствии с настройками временного таргетинга или в зависимости от баланса кампании. Неактивность кампании означает, что показ объявлений заблокирован и не может быть включен автоматически. || || `Status` | Статус кампании, например: “Идут показы”, “Ожидает оплаты”, “На модерации”, “Остановлена”, “Идут показы. Идет активизация”, “Кампания заархивирована” и другие. || || `StatusShow` | Показ объявлений кампании включен — Yes/No. Включение и выключение выполняется методами [StopCampaign](https://yandex.ru/dev/direct/doc/dg-v4/reference/StopCampaign.html) и [ResumeCampaign](https://yandex.ru/dev/direct/doc/dg-v4/reference/ResumeCampaign.html). Разрешение показа на уровне кампании не означает, что объявления фактически показываются. Для этого необходимо выполнение и других условий: достаточный баланс средств, кампания и объявления проверены модератором, разрешен показ на уровне объявлений (метод [ResumeBanners](https://yandex.ru/dev/direct/doc/dg-v4/reference/ResumeBanners.html)). Фактическому показу соответствует значение Yes в параметре `IsActive`. || || `StatusArchive` | Состояние архивации кампании: - Yes — кампания помещена в архив; - No — кампания не в архиве; - Pending — происходит перенос кампании в архив либо возврат из архива. Перенос в архив выполняют с помощью метода [ArchiveCampaign](https://yandex.ru/dev/direct/doc/dg-v4/reference/ArchiveCampaign.html). Для возврата из архива служит метод [UnArchiveCampaign](https://yandex.ru/dev/direct/doc/dg-v4/reference/UnArchiveCampaign.html). || || `StatusActivating` | Состояние активизации кампании: - Yes — активизирована; - Pending — ожидается активизация. || || `StatusModerate` | Результат проверки модератором: - Yes — модератор одобрил хотя бы одно объявление; - No — модератор отклонил все объявления; - New — объявления не отправлялись на проверку (статус кампании “Черновик”); - Pending — проводится проверка. Для отправки на проверку служит метод [ModerateBanners](https://yandex.ru/dev/direct/doc/dg-v4/reference/ModerateBanners.html). || || **Статистика** || || `Sum` | Если у рекламодателя подключен общий счет — сумма израсходованных средств за все время существования кампании. Если общий счет не подключен — сумма средств, зачисленных на баланс кампании за время ее существования. || || `Rest` | Текущий баланс общего счета + сумма возврата на кампанию (если у рекламодателя подключен общий счет) или текущий баланс кампании (если общий счет не подключен). {% note info %} Сумма возврата средств за клики, признанные системой недобросовестными или ошибочными, может быть израсходована только в рамках этой же кампании. {% endnote %} || || `Shows` | Количество показов за время существования кампании. || || `Clicks` | Количество кликов за время существования кампании. || || **Объект CampaignStrategy** || || `StrategyName` | Название [стратегии управления ставками](https://yandex.ru/support/direct/strategies/select-strategy.xml)[стратегии управления ставками](https://yandex.com/support/direct/strategies/select-strategy.xml). Стратегии с ручным управлением: - HighestPosition — стратегия “Наивысшая доступная позиция”; - LowestCost — стратегия “Показ в блоке по минимальной цене”; - LowestCostPremium — стратегия “Показ в блоке по минимальной цене”, но объявления показываются только в спецразмещении; Автоматические стратегии: - WeeklyBudget — автоматическая стратегия “Недельный бюджет” (обязательный параметр `WeeklySumLimit`, дополнительный `MaxPrice`); - WeeklyPacketOfClicks — автоматическая стратегия “Недельный пакет кликов” (обязательный параметр `ClicksPerWeek`, дополнительные `MaxPrice` или `AveragePrice`); - AverageClickPrice — автоматическая стратегия “Средняя цена клика” (обязательный параметр `AveragePrice`, дополнительный `WeeklySumLimit`). Еще две ручные стратегии могут быть указаны, но для них не доступна настройка параметров через API (только через веб-интерфейс): - NoPremiumPosition — стратегия “Показ под результатами поиска”; - IndependentControl — стратегия “Независимое управление для разных типов площадок”. Последние две стратегии настраиваются через веб-интерфейс Директа. Однако название любой из них может присутствовать в ответе метода [GetCampaignsParams](https://yandex.ru/dev/direct/doc/dg-v4/reference/GetCampaignsParams.html) и подаваться на вход метода . В этом случае API не меняет параметры стратегии, установленные через веб-интерфейс. || || `WeeklySumLimit` | Максимальный недельный бюджет для стратегии WeeklyBudget. Также может задаваться для стратегии AverageClickPrice. || || `ClicksPerWeek` | Количество кликов в неделю для стратегии WeeklyPacketOfClicks. || || `AveragePrice` | Средняя ставка для стратегии AverageClickPrice. Также может задаваться для стратегии WeeklyPacketOfClicks. || || `MaxPrice` | Максимальная ставка. Может задаваться для стратегий WeeklyBudget, CPAOptimizer и WeeklyPacketOfClicks. || || **Объект SmsNotificationInfo** || || `MetricaSms` | Сообщать результаты мониторинга сайтов по данным Яндекс Метрики — Yes/No. || || `ModerateResultSms` | Сообщать результаты модерации объявлений — Yes/No. || || `MoneyInSms` | Сообщать о зачислении средств на баланс кампании — Yes/No. Предустановленное значение — No. Если у клиента подключен общий счет, возвращается значение соответствующего параметра общего счета. || || `MoneyOutSms` | Сообщать об исчерпании средств на балансе кампании — Yes/No. Предустановленное значение — No. Если у клиента подключен общий счет, возвращается значение соответствующего параметра общего счета. || || `SmsTimeFrom` | Время, начиная с которого разрешено отправлять SMS о событиях, связанных с кампанией. Указывается в формате HH:MM, минуты задают кратно 15 (0, 15, 30, 45). Например, “19:45”. || || `SmsTimeTo` | Время, до которого разрешено отправлять SMS о событиях, связанных с кампанией. Указывается в формате HH:MM, минуты задают кратно 15 (0, 15, 30, 45). Например, “19:45”. || || **Объект EmailNotificationInfo** || || `SendWarn` | Отправлять уведомления по электронной почте — Yes/No. Предустановленное значение — No. || || `Email` | Адрес электронной почты для отправки уведомлений о событиях, связанных с кампанией. || || `WarnPlaceInterval` | Периодичность проверки позиции объявления — 15, 30 или 60 минут. Уведомление отправляется, если объявление переместилось на более низкую позицию, чем та, которую обеспечивала ставка на момент установки. || || `MoneyWarningValue` | Минимальный баланс, при уменьшении до которого отправляется уведомление. Задается в процентах от суммы последнего платежа. Предустановленное значение — 20. Если у клиента подключен общий счет, возвращается значение соответствующего параметра общего счета. || || `SendAccNews` | Сообщать о событиях, связанных с кампанией, — Yes/No. Задается для кампаний, обслуживаемых персональным менеджером в Яндексе. Предустановленное значение — No. || || **Объект TimeTargetInfo** || || `ShowOnHolidays` | Показывать объявления в праздничные нерабочие дни — Yes/No (к этим дням не относятся обычные субботы и воскресенья). Предустановленное значение — Yes. || || `HolidayShowFrom` | Час, начиная с которого объявления показываются в праздничные нерабочие дни. Если параметр отсутствует, показы идут по расписанию из параметра `DaysHours`. || || `HolidayShowTo` | Час, до которого объявления показываются в праздничные нерабочие дни. Если параметр отсутствует, показы идут по расписанию из параметра `DaysHours`. || || `DaysHours` | Массив объектов `TimeTargetItem`, определяющих расписание показов (временной таргетинг). || || `TimeZone` | Временная зона в месте нахождения владельца рекламной кампании. Список временных зон можно получить с помощью метода [GetTimeZones](https://yandex.ru/dev/direct/doc/dg-v4/reference/GetTimeZones.html). || || **Объект TimeTargetItem** || || `Hours` | Массив целых чисел от 0 до 23. Число 0 соответствует интервалу времени с 00:00 по 00:59 включительно, число 1 — с 01:00 по 01:59 включительно и так далее. Предустановленное значение — массив чисел от 0 до 23 соответствует полным суткам. || || `Days` | Массив целых чисел от 1 до 7. Число 1 соответствует понедельнику, число 7 — воскресенью. В указанные дни объявления показываются в соответствии со значением параметра `Hours`. Предустановленное значение — массив чисел от 1 до 7 соответствует полной неделе. || |# ## Примеры входных данных {#examples} ## Python ```python { 'CampaignIDS': [1327944, 1327974] } ``` ## PHP ```php array( 'CampaignIDS' => array(1327944, 1327974) ) ``` ## Perl ```perl { 'CampaignIDS' => [1327944, 1327974] } ```