Кампания (Campaign)
Объект Кампания (Campaign) содержит настройки рекламной кампании и суммарную статистику.
Сервис
Ограничения
Ограничение на количество кампаний для рекламодателя можно получить с помощью метода Clients.get или AgencyClients.get (элементы CAMPAIGNS_TOTAL_PER_CLIENT и CAMPAIGNS_UNARCHIVED_PER_CLIENT массива Restrictions).
Тип кампании
Тип кампании задается при создании кампании и недоступен для изменения.
Тип кампании определяет тип дочерних групп объявлений: в кампанию можно добавить только группы соответствующего типа.
Часть параметров кампании являются общими для всех типов кампаний, а часть — зависящими от типа кампании. Параметры, зависящие от типа кампании, передаются в дочерней структуре с соответствующим именем.
В настоящее время существуют следующие типы кампаний:
TEXT_CAMPAIGN — кампания с типом «Текстово-графические объявления».
Чтобы создать или отредактировать кампанию данного типа, необходимо передать параметры кампании в структуре TextCampaign методов add, update. Описание параметров приведено в разделах add: параметры TextCampaign, update: параметры TextCampaign.
При получении параметров кампании необходимо перечислить имена параметров, общих для всех типов кампаний, во входном параметре FieldNames, а имена параметров, специфичных для данного типа кампании, — во входном параметре TextCampaignFieldNames метода get. Описание возвращаемых параметров для данного типа кампании приведено в разделе get: параметры TextCampaign.
UNIFIED_CAMPAIGN — единая перфоманс кампания.
Чтобы создать или отредактировать кампанию данного типа, необходимо передать параметры кампании в структуре UnifiedCampaign методов add, update. Описание параметров приведено в разделах add: параметры UnifiedCampaign, update: параметры UnifiedCampaign.
При получении параметров кампании необходимо перечислить имена параметров, общих для всех типов кампаний, во входном параметре FieldNames, а имена параметров, специфичных для данного типа кампании, — во входном параметре UnifiedCampaignFieldNames метода get. Описание возвращаемых параметров для данного типа кампании приведено в разделе get: параметры UnifiedCampaign.
SMART_CAMPAIGN — кампания с типом «Смарт-баннеры». Подробнее о смарт-баннерах см. в разделе Смарт-баннеры помощи Директа.
Чтобы создать или отредактировать кампанию данного типа, необходимо передать параметры кампании в структуре SmartCampaign методов add, update. Описание параметров приведено в разделах add: параметры SmartCampaign, update: параметры SmartCampaign.
При получении параметров кампании необходимо перечислить имена параметров, общих для всех типов кампаний, во входном параметре FieldNames, а имена параметров, специфичных для данного типа кампании, — во входном параметре SmartCampaignFieldNames метода get. Описание возвращаемых параметров для данного типа кампании приведено в разделе get: параметры SmartCampaign.
DYNAMIC_TEXT_CAMPAIGN — кампания с типом «Динамические объявления». Подробнее о динамических объявлениях см. в разделе Динамические объявления помощи Директа.
Чтобы создать или отредактировать кампанию данного типа, необходимо передать параметры кампании в структуре DynamicTextCampaign методов add, update. Описание параметров приведено в разделах add: параметры DynamicTextCampaign, update: параметры DynamicTextCampaign.
При получении параметров кампании необходимо перечислить имена параметров, общих для всех типов кампаний, во входном параметре FieldNames, а имена параметров, специфичных для данного типа кампании, — во входном параметре DynamicTextCampaignFieldNames метода get. Описание возвращаемых параметров для данного типа кампании приведено в разделе get: параметры DynamicTextCampaign.
MOBILE_APP_CAMPAIGN — кампания с типом «Реклама мобильных приложений». Подробнее о рекламе мобильных приложений см. в разделе Реклама мобильных приложений помощи Директа.
Чтобы создать или отредактировать кампанию данного типа, необходимо передать параметры кампании в структуре MobileAppCampaign методов add, update. Описание параметров приведено в разделах add: параметры MobileAppCampaign, update: параметры MobileAppCampaign.
При получении параметров кампании необходимо перечислить имена параметров, общих для всех типов кампаний, во входном параметре FieldNames, а имена параметров, специфичных для данного типа кампании, — во входном параметре MobileAppCampaignFieldNames метода get. Описание возвращаемых параметров для данного типа кампании приведено в разделе get: параметры MobileAppCampaign.
MCBANNER_CAMPAIGN — кампания с типом «Баннер на поиске». Подробнее о баннере на поиске см. в разделе Баннер на поиске помощи Директа.
В API Яндекс Директа для кампаний данного типа доступно только получение статистики.
CPM_BANNER_CAMPAIGN — кампания с типом «Медийная кампания». Подробнее о медийных кампаниях см. в разделе Медийные баннеры помощи Директа.
Чтобы создать или отредактировать кампанию данного типа, необходимо передать параметры кампании в структуре CpmBannerCampaign методов add, update. Описание параметров приведено в разделах add: параметры CpmBannerCampaign, update: параметры CpmBannerCampaign.
При получении параметров кампании необходимо перечислить имена параметров, общих для всех типов кампаний, во входном параметре FieldNames, а имена параметров, специфичных для данного типа кампании, — во входном параметре CpmBannerCampaignFieldNames метода get. Описание возвращаемых параметров для данного типа кампании приведено в разделе get: параметры CpmBannerCampaign.
- CPM_DEALS_CAMPAIGN — кампания с типом «Медийная кампания со сделками». Подробнее о сделках см. в разделе Сделки помощи Директа.
В API Яндекс Директа для кампаний данного типа доступно только получение статистики.
- CPM_FRONTPAGE_CAMPAIGN — кампания с типом «Медийная кампания на Главной». Подробнее о данном типе кампаний см. в разделе Медийный баннер на Главной странице Яндекса помощи Директа.
В API Яндекс Директа для кампаний данного типа доступно только получение статистики.
CPM_PRICE — кампания с типом «Кампания с фиксированным СРМ». Подробнее о данном типе кампаний см. в разделе Кампании с фиксированным CPM помощи Директа.
В API Яндекс Директа для кампаний данного типа доступно только получение статистики.
Стратегии показа
См. раздел Стратегии показа.
Денежные параметры
Ограничения на денежные параметры для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
Статус и состояние кампании
Параметр State отражает текущее состояние показов в кампании.
| Состояние | Описание |
|---|---|
| CONVERTED | Кампания велась в у. е. до перехода рекламодателя на работу в реальной валюте, в настоящее время перемещена в специальный архив и доступна только для чтения. Примечание. Метод get возвращает кампанию в состоянии CONVERTED, только если в параметре States указано значение CONVERTED или в параметре Ids указан идентификатор этой кампании. Если параметры Ids и States оба не заданы, метод не возвращает кампании в состоянии CONVERTED. |
| ARCHIVED | Кампания помещена в архив с помощью метода archive, пользователем в веб-интерфейсе или автоматически (если на счете нет средств и показов не было более 30 дней). |
| SUSPENDED | Кампания остановлена владельцем с помощью метода suspend или в веб-интерфейсе. |
| ENDED | Кампания закончилась (прошла дата окончания). |
| ON | Кампания активна, объявления могут быть показаны. |
| OFF | Кампания неактивна (черновик, ожидает модерации, отклонена, отсутствуют средства на кампании или на общем счете, нет активных объявлений). |
| UNKNOWN | Используется для обеспечения обратной совместимости и отображения состояний, не поддерживаемых в данной версии API. |
| Состояние | Описание |
|---|---|
| CONVERTED | Кампания велась в у. е. до перехода рекламодателя на работу в реальной валюте, в настоящее время перемещена в специальный архив и доступна только для чтения. Примечание. Метод get возвращает кампанию в состоянии CONVERTED, только если в параметре States указано значение CONVERTED или в параметре Ids указан идентификатор этой кампании. Если параметры Ids и States оба не заданы, метод не возвращает кампании в состоянии CONVERTED. |
| ARCHIVED | Кампания помещена в архив с помощью метода archive, пользователем в веб-интерфейсе или автоматически (если на счете нет средств и показов не было более 30 дней). |
| SUSPENDED | Кампания остановлена владельцем с помощью метода suspend или в веб-интерфейсе. |
| ENDED | Кампания закончилась (прошла дата окончания). |
| ON | Кампания активна, объявления могут быть показаны. |
| OFF | Кампания неактивна (черновик, ожидает модерации, отклонена, отсутствуют средства на кампании или на общем счете, нет активных объявлений). |
| UNKNOWN | Используется для обеспечения обратной совместимости и отображения состояний, не поддерживаемых в данной версии API. |
Параметр Status отражает обобщенный результат модерации объектов кампании.
| Статус | Описание |
|---|---|
| DRAFT | Кампания создана и еще не отправлена на модерацию. |
| MODERATION | Кампания находится на модерации. |
| ACCEPTED | Хотя бы одно объявление в кампании принято модерацией. |
| REJECTED | Все объявления в кампании отклонены модерацией. |
| UNKNOWN | Используется для обеспечения обратной совместимости и отображения статусов, не поддерживаемых в данной версии API. |
| Статус | Описание |
|---|---|
| DRAFT | Кампания создана и еще не отправлена на модерацию. |
| MODERATION | Кампания находится на модерации. |
| ACCEPTED | Хотя бы одно объявление в кампании принято модерацией. |
| REJECTED | Все объявления в кампании отклонены модерацией. |
| UNKNOWN | Используется для обеспечения обратной совместимости и отображения статусов, не поддерживаемых в данной версии API. |
Параметр StatusPayment отражает готовность кампании к оплате.
| Статус оплаты | Описание |
|---|---|
| DISALLOWED | Оплата невозможна (либо доступна только оплата до прохождения модерации). |
| ALLOWED | Кампания принята модерацией или подключен общий счет. |
| Статус оплаты | Описание |
|---|---|
| DISALLOWED | Оплата невозможна (либо доступна только оплата до прохождения модерации). |
| ALLOWED | Кампания принята модерацией или подключен общий счет. |