get: параметры MobileAppCampaign
Структура ответа в формате JSON:
{
"result": {
"Campaigns": [{ /* CampaignGetItem */
...
"MobileAppCampaign": { /* MobileAppCampaignGetItem */
"BiddingStrategy": { /* MobileAppCampaignStrategy */
"Search": { /* MobileAppCampaignSearchStrategy */
"BiddingStrategyType": ( "AVERAGE_CPC" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
"WbMaximumClicks": { /* StrategyMaximumClicks */
"WeeklySpendLimit": (long),
"BidCeiling": (long) /* nillable */
},
"WbMaximumAppInstalls": { /* StrategyMaximumAppInstalls */
"WeeklySpendLimit": (long),
"BidCeiling": (long) /* nillable */
},
"AverageCpc": { /* StrategyAverageCpc */
"AverageCpc": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
},
"AverageCpi": { /* StrategyAverageCpi */
"AverageCpi": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
"BidCeiling": (long) /* nillable */
},
"WeeklyClickPackage": { /* StrategyWeeklyClickPackage */
"ClicksPerWeek": (long),
"AverageCpc": (long), /* nillable */
"BidCeiling": (long) /* nillable */
},
"PayForInstall" : { /* StrategyPayForInstall */
"AverageCpi" : (long),
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
}
},
"Network": { /* MobileAppCampaignNetworkStrategy */
"BiddingStrategyType": ( "AVERAGE_CPC" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
"NetworkDefault": { /* StrategyNetworkDefault */
"LimitPercent": (int)
},
"WbMaximumClicks": { /* StrategyMaximumClicks */
"WeeklySpendLimit": (long),
"BidCeiling": (long) /* nillable */
},
"WbMaximumAppInstalls": { /* StrategyMaximumAppInstalls */
"WeeklySpendLimit": (long),
"BidCeiling": (long) /* nillable */
},
"AverageCpc": { /* StrategyAverageCpc */
"AverageCpc": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
},
"AverageCpi": { /* StrategyAverageCpi */
"AverageCpi": (long),
"WeeklySpendLimit": (long), /* nillable */
"BidCeiling": (long) /* nillable */
},
"WeeklyClickPackage": { /* StrategyWeeklyClickPackage */
"ClicksPerWeek": (long),
"AverageCpc": (long), /* nillable */
"BidCeiling": (long) /* nillable */
},
"PayForInstall" : { /* StrategyPayForInstall */
"AverageCpi" : (long),
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
}
},
"Settings": [{ /* MobileAppCampaignSettingGet */
"Option": ( "ADD_TO_FAVORITES" | ... | "SHARED_ACCOUNT_ENABLED" ), /* required */
"Value": ( "YES" | "NO" ) /* required */
}, ... ],
"PackageBiddingStrategy" : { /* nillable */
"StrategyId" : (long), /* required */
},
"CanBeUsedAsPackageBiddingStrategySource" : ( "YES" | "NO" ),
"NegativeKeywordSharedSetIds" : { /* nillable */
"Items" : [ (long) ] /* required */
},
}
}
}, ... ],
"LimitedBy": (long)
}
}
Параметр | Тип | Описание |
Структура MobileAppCampaignGetItem | ||
---|---|---|
Settings | array of MobileAppCampaignSettingGet | Массив настроек, допускающих только значения YES или NO. |
BiddingStrategy | MobileAppCampaignStrategy | Стратегия показа. |
PackageBiddingStrategy | MobileAppCampaignPackageBiddingStrategyGet, nillable, deprecated | Информация о пакетной стратегии. Null (nil) – кампания не находится в составе пакетной стратегии. |
CanBeUsedAsPackageBiddingStrategySource | string, deprecated | Показывает, может ли стратегия этой кампании быть пакетной. |
NegativeKeywordSharedSetIds | ArrayOfLong, nillable | Идентификаторы наборов минус-фраз. Не более 3 элементов в массиве. |
Структура MobileAppCampaignSettingGet | ||
Option | MobileAppCampaignSettingsEnum | Имя настройки:
|
Value | YesNoEnum | Значение настройки. |
Структура MobileAppCampaignPackageBiddingStrategyGet | ||
StrategyId | long | Идентификатор пакетной стратегии. |
Структура MobileAppCampaignStrategy | ||
Search | MobileAppCampaignSearchStrategy | Стратегия показа на поиске. |
Network | MobileAppCampaignNetworkStrategy | Стратегия показа в сетях. |
Структура MobileAppCampaignSearchStrategy | ||
BiddingStrategyType | MobileAppCampaignSearchStrategyTypeEnum | Тип стратегии показа на поиске:
|
WbMaximumClicks | StrategyMaximumClicks | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. |
WbMaximumAppInstalls | StrategyMaximumAppInstalls | Параметры стратегии Оптимизация количества установок приложения, без указания средней цены установки. |
AverageCpc | StrategyAverageCpc | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. |
WeeklyClickPackage | StrategyWeeklyClickPackage | Параметры стратегии Оптимизация кликов, ограничивать по пакету кликов. Ограничение. Параметр устарел и больше не поддерживается. |
AverageCpi | StrategyAverageCpi | Параметры стратегии Оптимизация количества установок приложения, удерживать среднюю цену установки. |
PayForInstall | StrategyPayForInstall | Параметры стратегии Оптимизация конверсий, оплата за установки. |
Структура MobileAppCampaignNetworkStrategy | ||
BiddingStrategyType | MobileAppCampaignNetworkStrategyTypeEnum | Тип стратегии показа в сетях:
|
NetworkDefault Ограничение. Параметр NETWORK_DEFAULT не поддерживается для ручной стратегии HIGHEST_POSITION. | StrategyNetworkDefault | Настройки показов в сетях в зависимости от настроек на поиске. Если выбрана стратегия на поиске, отличная от HIGHEST_POSITION, структура не возвращается. |
WbMaximumClicks | StrategyMaximumClicks | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. |
WbMaximumAppInstalls | StrategyMaximumAppInstalls | Параметры стратегии Оптимизация количества установок приложения, без указания средней цены установки. |
AverageCpc | StrategyAverageCpc | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. |
WeeklyClickPackage | StrategyWeeklyClickPackage | Параметры стратегии Оптимизация кликов, ограничивать по пакету кликов. Ограничение. Параметр устарел и больше не поддерживается. |
AverageCpi | StrategyAverageCpi | Параметры стратегии Оптимизация количества установок приложения, удерживать среднюю цену установки. |
PayForInstall | StrategyPayForInstall | Параметры стратегии Оптимизация конверсий, оплата за установки. |
Структура StrategyMaximumClicks | ||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Структура StrategyMaximumAppInstalls | ||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Структура StrategyAverageCpc | ||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
Структура StrategyAverageCpi | ||
AverageCpi | long | Средняя цена установки приложения в валюте рекламодателя, умноженная на 1 000 000. Минимальное допустимое значение представлено в разделе Валютные параметры и ограничения. |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Структура StrategyWeeklyClickPackage | ||
ClicksPerWeek | long | Требуемое количество кликов в неделю. |
AverageCpc | long, nillable | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Параметры AverageCpc и BidCeiling являются взаимоисключающими: нельзя указывать оба. |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Параметры AverageCpc и BidCeiling являются взаимоисключающими: нельзя указывать оба. |
Структура StrategyPayForInstall | ||
AverageCpi | long | Цена за установку приложения в валюте рекламодателя, умноженная на 1 000 000. Минимальные и максимальные допустимые значения представлены в разделе Валютные параметры и ограничения. |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
Структура StrategyNetworkDefault | ||
LimitPercent | int | Максимальный процент бюджета, расходуемый на показы в сетях. Значение кратно десяти: 10, 20, ..., 100. |
Структура CustomPeriodBudget | ||
SpendLimit | long | Значение бюджета на период. |
StartDate | string | Начало бюджетного периода. |
EndDate | string | Окончание бюджетного периода. |
AutoContinue | YesNoEnum | Признак автопродления бюджета. |
Параметр | Тип | Описание |
Структура MobileAppCampaignGetItem | ||
---|---|---|
Settings | array of MobileAppCampaignSettingGet | Массив настроек, допускающих только значения YES или NO. |
BiddingStrategy | MobileAppCampaignStrategy | Стратегия показа. |
PackageBiddingStrategy | MobileAppCampaignPackageBiddingStrategyGet, nillable, deprecated | Информация о пакетной стратегии. Null (nil) – кампания не находится в составе пакетной стратегии. |
CanBeUsedAsPackageBiddingStrategySource | string, deprecated | Показывает, может ли стратегия этой кампании быть пакетной. |
NegativeKeywordSharedSetIds | ArrayOfLong, nillable | Идентификаторы наборов минус-фраз. Не более 3 элементов в массиве. |
Структура MobileAppCampaignSettingGet | ||
Option | MobileAppCampaignSettingsEnum | Имя настройки:
|
Value | YesNoEnum | Значение настройки. |
Структура MobileAppCampaignPackageBiddingStrategyGet | ||
StrategyId | long | Идентификатор пакетной стратегии. |
Структура MobileAppCampaignStrategy | ||
Search | MobileAppCampaignSearchStrategy | Стратегия показа на поиске. |
Network | MobileAppCampaignNetworkStrategy | Стратегия показа в сетях. |
Структура MobileAppCampaignSearchStrategy | ||
BiddingStrategyType | MobileAppCampaignSearchStrategyTypeEnum | Тип стратегии показа на поиске:
|
WbMaximumClicks | StrategyMaximumClicks | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. |
WbMaximumAppInstalls | StrategyMaximumAppInstalls | Параметры стратегии Оптимизация количества установок приложения, без указания средней цены установки. |
AverageCpc | StrategyAverageCpc | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. |
WeeklyClickPackage | StrategyWeeklyClickPackage | Параметры стратегии Оптимизация кликов, ограничивать по пакету кликов. Ограничение. Параметр устарел и больше не поддерживается. |
AverageCpi | StrategyAverageCpi | Параметры стратегии Оптимизация количества установок приложения, удерживать среднюю цену установки. |
PayForInstall | StrategyPayForInstall | Параметры стратегии Оптимизация конверсий, оплата за установки. |
Структура MobileAppCampaignNetworkStrategy | ||
BiddingStrategyType | MobileAppCampaignNetworkStrategyTypeEnum | Тип стратегии показа в сетях:
|
NetworkDefault Ограничение. Параметр NETWORK_DEFAULT не поддерживается для ручной стратегии HIGHEST_POSITION. | StrategyNetworkDefault | Настройки показов в сетях в зависимости от настроек на поиске. Если выбрана стратегия на поиске, отличная от HIGHEST_POSITION, структура не возвращается. |
WbMaximumClicks | StrategyMaximumClicks | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. |
WbMaximumAppInstalls | StrategyMaximumAppInstalls | Параметры стратегии Оптимизация количества установок приложения, без указания средней цены установки. |
AverageCpc | StrategyAverageCpc | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. |
WeeklyClickPackage | StrategyWeeklyClickPackage | Параметры стратегии Оптимизация кликов, ограничивать по пакету кликов. Ограничение. Параметр устарел и больше не поддерживается. |
AverageCpi | StrategyAverageCpi | Параметры стратегии Оптимизация количества установок приложения, удерживать среднюю цену установки. |
PayForInstall | StrategyPayForInstall | Параметры стратегии Оптимизация конверсий, оплата за установки. |
Структура StrategyMaximumClicks | ||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Структура StrategyMaximumAppInstalls | ||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Структура StrategyAverageCpc | ||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
Структура StrategyAverageCpi | ||
AverageCpi | long | Средняя цена установки приложения в валюте рекламодателя, умноженная на 1 000 000. Минимальное допустимое значение представлено в разделе Валютные параметры и ограничения. |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Структура StrategyWeeklyClickPackage | ||
ClicksPerWeek | long | Требуемое количество кликов в неделю. |
AverageCpc | long, nillable | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Параметры AverageCpc и BidCeiling являются взаимоисключающими: нельзя указывать оба. |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Параметры AverageCpc и BidCeiling являются взаимоисключающими: нельзя указывать оба. |
Структура StrategyPayForInstall | ||
AverageCpi | long | Цена за установку приложения в валюте рекламодателя, умноженная на 1 000 000. Минимальные и максимальные допустимые значения представлены в разделе Валютные параметры и ограничения. |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
Структура StrategyNetworkDefault | ||
LimitPercent | int | Максимальный процент бюджета, расходуемый на показы в сетях. Значение кратно десяти: 10, 20, ..., 100. |
Структура CustomPeriodBudget | ||
SpendLimit | long | Значение бюджета на период. |
StartDate | string | Начало бюджетного периода. |
EndDate | string | Окончание бюджетного периода. |
AutoContinue | YesNoEnum | Признак автопродления бюджета. |