--- metadata: - name: generator content: Diplodoc Platform v5.50.2 alternate: - https://yandex.com/dev/direct/doc/dg-v4/en/live/GetCampaignsList.md - https://yandex.com/dev/direct/doc/dg-v4/ru/live/GetCampaignsList.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/direct/doc/dg-v4/ru/llms.txt # GetCampaignsList (Live) Возвращает список кампаний с краткими сведениями о них. ## Ограничения {% 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 %} ## Новое в версии Live 4 Добавлены результирующие параметры StrategyName и ContextStrategyName. Добавлены результирующие параметры CampaignCurrency и SourceCampaignID. Добавлен результирующий параметр DayBudgetEnabled. Добавлен результирующий параметр EnableRelatedKeywords. Добавлен результирующий параметр ExtendedAdTitleEnabled. ## Входные данные {#input} Ниже показана структура входных данных в формате JSON. ```javascript { "method": "GetCampaignsList", "param": [ (string) ... ] } ``` Параметр `param` используется только при выполнении запроса от лица рекламного агентства. В параметре задают массив логинов (не более 100), для которых требуется получить список кампаний. В остальных случаях `param` задавать не нужно, а метод возвращает список кампаний пользователя, от лица которого сделан запрос. ## Результирующие данные {#output} Ниже показана структура результирующих данных в формате JSON. ```javascript { "data": [ { /* ShortCampaignInfo */ "CampaignID": (int), "Login": (string), "Name": (string), "StartDate": (date), "StrategyName": (string), "ContextStrategyName": (string), "Sum": (float), "Rest": (float), "SumAvailableForTransfer": (float), "Shows": (int), "Clicks": (int), "Status": (string), "StatusShow": (string), "StatusArchive": (string), "StatusActivating": (string), "StatusModerate": (string), "IsActive": (string), "ManagerName": (string), "AgencyName": (string), "CampaignCurrency": (string), "SourceCampaignID": (int), "DayBudgetEnabled": (string), "EnableRelatedKeywords": (string), "ExtendedAdTitleEnabled": (string) } ... ] } ``` Ниже приведено описание параметров. #| || **Параметр** | **Описание** || || **Объект ShortCampaignInfo** || || `CampaignID` | Идентификатор кампании. Для создания кампании задают 0, для изменения параметров существующей кампании указывают ее идентификатор. || || `Login` | Логин владельца кампании (логин пользователя Яндекса, в пользу которого ведется рекламная кампания). При создании кампании прямые рекламодатели указывают собственный логин в Яндексе, рекламные агентства — логин своего клиента. При получении параметров кампании возвращается логин главного представителя рекламодателя. || || `Name` | Название кампании. || || `StrategyName` | [Стратегия](https://yandex.com/dev/direct/doc/dg-v4/ru/concepts/strategy.md) на поиске. Ниже перечислены возможные значения. - ShowsDisabled — выключить показ объявлений на поиске. Это необходимо для использования автоматической стратегии в Рекламной сети Яндекса. Показ на поиске невозможно выключить, если для Рекламной сети применяется стратегия Default. Стратегии с ручным управлением ставками на поиске: - HighestPosition — стратегия “Наивысшая доступная позиция”“Highest available position”; - LowestCost — стратегия “Показ в блоке по минимальной цене”“Cheapest position in ad block”; - LowestCostPremium — стратегия “Показ в блоке по минимальной цене”“Cheapest position in ad block”, но объявления показываются только в спецразмещении; - LowestCostGuarantee — стратегия “Показ под результатами поиска”“Impressions below search results” (в нижнем блоке по наименьшей цене); - RightBlockHighest — стратегия “Показ под результатами поиска”“Impressions below search results” (в нижнем блоке на наивысшей позиции, доступной при указанной ставке). Автоматические стратегии на поиске: - WeeklyBudget — стратегия “Недельный бюджет: максимум кликов”“Weekly budget: maximum clicks” (обязательный параметр `WeeklySumLimit`, дополнительный `MaxPrice`); - CPAOptimizer — стратегия “Недельный бюджет: максимальная конверсия”“Weekly budget: maximum conversion rate” (обязательные параметры `WeeklySumLimit` и `GoalID`, дополнительный `MaxPrice`); см. [условия подключения стратегии](https://yandex.ru/support/direct/strategies/weekly-budget.xml)[условия подключения стратегии](https://yandex.com/support/direct/strategies/weekly-budget.xml) в помощи Директа; - AverageClickPrice — стратегия “Средняя цена клика”“Average CPC” (обязательный параметр `AveragePrice`, дополнительный `WeeklySumLimit`); - WeeklyPacketOfClicks — стратегия “Недельный пакет кликов”“Weekly click package” (обязательный параметр `ClicksPerWeek`, дополнительные `MaxPrice` или `AveragePrice`); - AverageCPAOptimization — стратегия “Средняя цена конверсии”“Average CPA” (обязательные параметры `AverageCPA` и `GoalID`, дополнительные `WeeklySumLimit` и `MaxPrice`); см. [условия подключения стратегии](https://yandex.ru/support/direct/strategies/average-cpa.xml)[условия подключения стратегии](https://yandex.com/support/direct/strategies/average-cpa.xml) в помощи Директа; - ROIOptimization — стратегия “Средняя рентабельность инвестиций”“Average ROI” (обязательные параметры `ReserveReturn`, `ROICoef`, `GoalID`, дополнительные `Profitability`, `WeeklySumLimit` и `MaxPrice`); см. [условия подключения стратегии](https://yandex.ru/support/direct/strategies/average-roi.xml)[условия подключения стратегии](https://yandex.com/support/direct/strategies/average-roi.xml) в помощи Директа. || || `ContextStrategyName` | [Стратегия](https://yandex.com/dev/direct/doc/dg-v4/ru/concepts/strategy.md) в Рекламной сети Яндекса. Ниже перечислены возможные значения. - ShowsDisabled — выключить показ объявлений в Рекламной сети Яндекса. Это возможно, только если показ не выключен на поиске. Стратегии с ручным управлением ставками в Рекламной сети Яндекса: - Default — стратегия “Процент от цены на поиске”. Процент задают в параметре `ContextPricePercent`. Дополнительные параметры — `ContextLimit` и `ContextLimitSum`. Данная стратегия применяется для кампаний, которым стратегия не назначена явно. - MaximumCoverage — стратегия “Максимальный доступный охват”“Maximum audience coverage”. Ставки задают с помощью одного из методов: [CreateOrUpdateBanners](https://yandex.com/dev/direct/doc/dg-v4/ru/reference/CreateOrUpdateBanners.md), [SetAutoPrice (Live)](https://yandex.com/dev/direct/doc/dg-v4/ru/live/SetAutoPrice.md), [UpdatePrices](https://yandex.com/dev/direct/doc/dg-v4/ru/reference/UpdatePrices.md). {% note warning %} Стратегия MaximumCoverage не доступна, если на поиске выбрана любая автоматическая стратегия. {% endnote %} Автоматические стратегии в Рекламной сети Яндекса: {% note warning %} Автоматические стратегии в Рекламной сети доступны, только если на поиске выключен показ объявлений (стратегия ShowsDisabled). {% endnote %} - WeeklyBudget — стратегия “Недельный бюджет: максимум кликов”“Weekly budget: maximum clicks” (обязательный параметр `WeeklySumLimit`, дополнительный `MaxPrice`); - CPAOptimizer — стратегия “Недельный бюджет: максимальная конверсия”“Weekly budget: maximum conversion rate” (обязательные параметры `WeeklySumLimit` и `GoalID`, дополнительный `MaxPrice`); см. [условия подключения стратегии](https://yandex.ru/support/direct/strategies/weekly-budget.xml)[условия подключения стратегии](https://yandex.com/support/direct/strategies/weekly-budget.xml) в помощи Директа; - AverageClickPrice — стратегия “Средняя цена клика”“Average CPC” (обязательный параметр `AveragePrice`, дополнительный `WeeklySumLimit`); - WeeklyPacketOfClicks — стратегия “Недельный пакет кликов”“Weekly click package” (обязательный параметр `ClicksPerWeek`, дополнительные `MaxPrice` или `AveragePrice`); - AverageCPAOptimization — стратегия “Средняя цена конверсии”“Average CPA” (обязательные параметры `AverageCPA` и `GoalID`, дополнительные `WeeklySumLimit` и `MaxPrice`); см. [условия подключения стратегии](https://yandex.ru/support/direct/strategies/average-cpa.xml)[условия подключения стратегии](https://yandex.com/support/direct/strategies/average-cpa.xml) в помощи Директа; - ROIOptimization — стратегия “Средняя рентабельность инвестиций”“Average ROI” (обязательные параметры `ReserveReturn`, `ROICoef`, `GoalID`, дополнительные `Profitability`, `WeeklySumLimit` и `MaxPrice`); см. [условия подключения стратегии](https://yandex.ru/support/direct/strategies/average-roi.xml)[условия подключения стратегии](https://yandex.com/support/direct/strategies/average-roi.xml) в помощи Директа. || || `StartDate` | Начало показа объявлений, `YYYY-MM-DD`. Если не задана, используется дата создания кампании. Дата может находиться в будущем. В этом случае показ объявлений начинается при наступлении указанной даты, если модератор одобрил объявления и внесены средства на баланс кампании. || || `Sum` | Если у клиента подключен общий счет — сумма израсходованных средств за все время существования кампании. Если общий счет не подключен — сумма средств, зачисленных на баланс кампании за время ее существования. Значение выражено в у. е. Если кампания ведется в реальной валюте, возвращаемое значение конвертируется из валюты кампании в у. е. и округляется по математическим правилам с точностью до второго знака после запятой. || || `Rest` | Текущий баланс общего счета + сумма возврата на кампанию (если у рекламодателя подключен общий счет) или текущий баланс кампании (если общий счет не подключен). {% note info %} Сумма возврата средств за клики, признанные системой недобросовестными или ошибочными, может быть израсходована только в рамках этой же кампании. {% endnote %} Значение выражено в у. е. Если кампания ведется в реальной валюте, возвращаемое значение конвертируется из валюты кампании в у. е. и округляется по математическим правилам с точностью до второго знака после запятой. || || `SumAvailableForTransfer` | Сумма, доступная для перевода с помощью метода [TransferMoney](https://yandex.com/dev/direct/doc/dg-v4/ru/reference/TransferMoney.md). Возвращается только в случае, если общий счет не подключен. Может быть меньше баланса кампании. Значение выражено в у. е. Если кампания ведется в реальной валюте, возвращаемое значение конвертируется из валюты кампании в у. е. и округляется по математическим правилам с точностью до второго знака после запятой. || || `Shows` | Количество показов за время существования кампании. || || `Clicks` | Количество кликов за время существования кампании. || || `Status` | Статус кампании, например: “Идут показы”, “Ожидает оплаты”, “На модерации”, “Остановлена”, “Идут показы. Идет активизация”, “Кампания заархивирована” и другие. || || `StatusShow` | Показ объявлений кампании включен — Yes/No. Включение и выключение выполняется методами [StopCampaign](https://yandex.com/dev/direct/doc/dg-v4/ru/reference/StopCampaign.md) и [ResumeCampaign](https://yandex.com/dev/direct/doc/dg-v4/ru/reference/ResumeCampaign.md). Разрешение показа на уровне кампании не означает, что объявления фактически показываются. Для этого необходимо выполнение и других условий: достаточный баланс средств, кампания и объявления проверены модератором, разрешен показ на уровне объявлений (метод [ResumeBanners](https://yandex.com/dev/direct/doc/dg-v4/ru/reference/ResumeBanners.md)). Фактическому показу соответствует значение Yes в параметре `IsActive`. || || `StatusArchive` | Состояние архивации кампании: - Yes — кампания помещена в архив; - No — кампания не в архиве; - Pending — происходит перенос кампании в архив либо возврат из архива; - CurrencyConverted — кампания автоматически заархивирована при переходе клиента на работу в валюте и не может быть разархивирована. Перенос в архив выполняют с помощью метода [ArchiveCampaign](https://yandex.com/dev/direct/doc/dg-v4/ru/reference/ArchiveCampaign.md). Для возврата из архива служит метод [UnArchiveCampaign](https://yandex.com/dev/direct/doc/dg-v4/ru/reference/UnArchiveCampaign.md). || || `StatusActivating` | Состояние активизации кампании: - Yes — активизирована; - Pending — ожидается активизация. || || `StatusModerate` | Результат проверки модератором: - Yes — модератор одобрил хотя бы одно объявление; - No — модератор отклонил все объявления; - New — объявления не отправлялись на проверку (статус кампании “Черновик”); - Pending — проводится проверка. Для отправки на проверку служит метод [ModerateBanners](https://yandex.com/dev/direct/doc/dg-v4/ru/reference/ModerateBanners.md). || || `IsActive` | Кампания активна, объявления показываются — Yes/No. Под активностью понимается состояние кампании, при котором показ объявлений включается и выключается автоматически — в соответствии с настройками временного таргетинга или в зависимости от баланса кампании. Неактивность кампании означает, что показ объявлений заблокирован и не может быть включен автоматически. || || `ManagerName` | Имя персонального менеджера в Яндексе. Заполняется автоматически для кампаний, обслуживаемых персональным менеджером. || || `AgencyName` | Название рекламного агентства. Заполняется автоматически, если создателем кампании является агентство. || || `CampaignCurrency` | Валюта, в которой ведется кампания. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Если параметр отсутствует или равен NULL, это означает, что кампания ведется в у. е. || || `SourceCampaignID` | Идентификатор исходной кампании в у. е., если текущая кампания была создана автоматически при переходе клиента на работу в валюту. Отсутствует или равен NULL — в противном случае. || || `DayBudgetEnabled` | Доступно ли управление дневным бюджетом кампании — Yes/No. || || `EnableRelatedKeywords` | [Авторасширение фраз](https://yandex.ru/support/direct-tooltips/related-keywords.xml)[Авторасширение фраз](https://yandex.com/support/direct-tooltips/related-keywords.xml) включено — Yes/No. || || `ExtendedAdTitleEnabled` | Подстановка части текста объявления в заголовок включена — Yes/No. || |# ## Примеры входных данных {#example} ## Python ```python ['login1', 'login2'] ``` ## PHP ```php array('login1', 'login2') ``` ## Perl ```perl ['login1', 'login2'] ```