get
Returns the parameters of campaigns that match the specified criteria.
Restrictions
The method returns a maximum of 10,000 objects.
Request
Request structure in JSON format:
{
"method": "get",
"params": { /* params */
"SelectionCriteria": { /* CampaignsSelectionCriteria */
"Ids": [(long), ... ],
"Types": [( "TEXT_CAMPAIGN" | "MOBILE_APP_CAMPAIGN" | "DYNAMIC_TEXT_CAMPAIGN" | "CPM_BANNER_CAMPAIGN" | "SMART_CAMPAIGN" | "UNIFIED_CAMPAIGN" ), ... ],
"States": [( "ARCHIVED" | "CONVERTED" | "ENDED" | "OFF" | "ON" | "SUSPENDED" ), ... ],
"Statuses": [( "ACCEPTED" | "DRAFT" | "MODERATION" | "REJECTED" ), ... ],
"StatusesPayment": [( "DISALLOWED" | "ALLOWED" ), ... ]
}, /* required */
"FieldNames": [( "BlockedIps" | ... | "Type" ), ... ], /* required */
"TextCampaignFieldNames": [( "CounterIds" | "RelevantKeywords" | "Settings" | "BiddingStrategy" | "PriorityGoals" | "AttributionModel" | "PackageBiddingStrategy" | "CanBeUsedAsPackageBiddingStrategySource" | "NegativeKeywordSharedSetIds" ), ... ],
"TextCampaignSearchStrategyPlacementTypesFieldNames" : [ ( "SearchResults" | "ProductGallery") ],
"MobileAppCampaignFieldNames": [( "Settings" | "BiddingStrategy" | "PackageBiddingStrategy" | "CanBeUsedAsPackageBiddingStrategySource" | "NegativeKeywordSharedSetIds" ), ... ],
"DynamicTextCampaignFieldNames": [( "CounterIds" | "Settings" | "PlacementTypes" | "BiddingStrategy" | "PriorityGoals" | "AttributionModel" "PackageBiddingStrategy" | "CanBeUsedAsPackageBiddingStrategySource" | "NegativeKeywordSharedSetIds" ), ... ],
"CpmBannerCampaignFieldNames": [( "CounterIds" | "FrequencyCap" | "VideoTarget" | "Settings" | "BiddingStrategy" ), ... ],
"SmartCampaignFieldNames": [( "CounterId" | "Settings" | "BiddingStrategy" | "PriorityGoals" | "AttributionModel" "PackageBiddingStrategy" | "CanBeUsedAsPackageBiddingStrategySource" ), ... ],
"UnifiedCampaignFieldNames" : [ ("CounterIds"|"Settings"|"BiddingStrategy"|"PriorityGoals"|"TrackingParams"|"AttributionModel"|"PackageBiddingStrategy"|"CanBeUsedAsPackageBiddingStrategySource") ],
"UnifiedCampaignSearchStrategyPlacementTypesFieldNames" : [ ("SearchResults"|"ProductGallery") ]
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Parameter | Type | Description | Required |
Params structure (for JSON) / GetRequest (for SOAP) | |||
---|---|---|---|
SelectionCriteria | CampaignsSelectionCriteria | Campaign selection criteria. To get all of an advertiser's campaigns, leave SelectionCriteria empty. | No |
FieldNames | array of CampaignFieldEnum | Names of parameters to get that are common to all types of campaigns. | Yes |
TextCampaignFieldNames | array of TextCampaignFieldEnum | Names of requested parameters of a “Text & Image ads” campaign. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from TextCampaignFieldNames are not returned. | No |
TextCampaignSearchStrategyPlacementTypesFieldNames | array of TextCampaignSearchStrategyPlacementTypesFieldNames | Placements for search strategies to get. | No |
MobileAppCampaignFieldNames | array of MobileAppCampaignFieldEnum | Names of parameters to get for an “Ads for mobile apps” campaign. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from MobileAppCampaignFieldNames are not returned. | No |
DynamicTextCampaignFieldNames | array of DynamicTextCampaignFieldEnum | The names of parameters to get for a campaign with the “Dynamic ads” type. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from DynamicTextCampaignFieldNames are not returned. | No |
CpmBannerCampaignFieldNames | array of CpmBannerCampaignFieldEnum | Names of parameters to get for a “Display campaign”. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from CpmBannerCampaignFieldNames are not returned. | No |
SmartCampaignFieldNames | SmartCampaignFieldEnum | Names of parameters to get for a “Smart banners” campaign. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from SmartCampaignFieldNames are not returned. | No |
UnifiedCampaignFieldNames | array of UnifiedCampaignFieldEnum | Names of requested parameters of a campaign with the “Unified performance campaign” type. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from UnifiedCampaignFieldNames are not returned. | No |
UnifiedCampaignSearchStrategyPlacementTypesFieldNames | array of UnifiedCampaignSearchStrategyPlacementTypesFieldNames | Placements for search strategies to get. | No |
Page | LimitOffset | Structure that defines the page for paginated selection of data. | No |
CampaignsSelectionCriteria structure | |||
Ids | array of long | Selects campaigns with the specified IDs. Maximum of 1000 items in the array. | No |
Types | array of CampaignTypeEnum | Selects campaigns of the specified types. See Campaign type. | No |
States | array of CampaignStateEnum | Selects campaigns with the specified states. For state descriptions, see Campaign status and state. Note. The get method returns a campaign in the CONVERTED state only if the States parameter is set to CONVERTED or the ID of this campaign is specified in the Ids parameter. If both the Ids and States parameters are omitted, the method doesn't return a campaign in the CONVERTED state. | No |
Statuses | array of CampaignStatusSelectionEnum | Selects campaigns with the specified statuses. For status descriptions, see Campaign status and state. | No |
StatusesPayment | array of CampaignStatusPaymentEnum | Selects campaigns with the specified payment statuses. For status descriptions, see Campaign status and state. | No |
Parameter | Type | Description | Required |
Params structure (for JSON) / GetRequest (for SOAP) | |||
---|---|---|---|
SelectionCriteria | CampaignsSelectionCriteria | Campaign selection criteria. To get all of an advertiser's campaigns, leave SelectionCriteria empty. | No |
FieldNames | array of CampaignFieldEnum | Names of parameters to get that are common to all types of campaigns. | Yes |
TextCampaignFieldNames | array of TextCampaignFieldEnum | Names of requested parameters of a “Text & Image ads” campaign. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from TextCampaignFieldNames are not returned. | No |
TextCampaignSearchStrategyPlacementTypesFieldNames | array of TextCampaignSearchStrategyPlacementTypesFieldNames | Placements for search strategies to get. | No |
MobileAppCampaignFieldNames | array of MobileAppCampaignFieldEnum | Names of parameters to get for an “Ads for mobile apps” campaign. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from MobileAppCampaignFieldNames are not returned. | No |
DynamicTextCampaignFieldNames | array of DynamicTextCampaignFieldEnum | The names of parameters to get for a campaign with the “Dynamic ads” type. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from DynamicTextCampaignFieldNames are not returned. | No |
CpmBannerCampaignFieldNames | array of CpmBannerCampaignFieldEnum | Names of parameters to get for a “Display campaign”. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from CpmBannerCampaignFieldNames are not returned. | No |
SmartCampaignFieldNames | SmartCampaignFieldEnum | Names of parameters to get for a “Smart banners” campaign. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from SmartCampaignFieldNames are not returned. | No |
UnifiedCampaignFieldNames | array of UnifiedCampaignFieldEnum | Names of requested parameters of a campaign with the “Unified performance campaign” type. See Campaign type. Note. If a different type of campaign is selected according to SelectionCriteria, parameters from UnifiedCampaignFieldNames are not returned. | No |
UnifiedCampaignSearchStrategyPlacementTypesFieldNames | array of UnifiedCampaignSearchStrategyPlacementTypesFieldNames | Placements for search strategies to get. | No |
Page | LimitOffset | Structure that defines the page for paginated selection of data. | No |
CampaignsSelectionCriteria structure | |||
Ids | array of long | Selects campaigns with the specified IDs. Maximum of 1000 items in the array. | No |
Types | array of CampaignTypeEnum | Selects campaigns of the specified types. See Campaign type. | No |
States | array of CampaignStateEnum | Selects campaigns with the specified states. For state descriptions, see Campaign status and state. Note. The get method returns a campaign in the CONVERTED state only if the States parameter is set to CONVERTED or the ID of this campaign is specified in the Ids parameter. If both the Ids and States parameters are omitted, the method doesn't return a campaign in the CONVERTED state. | No |
Statuses | array of CampaignStatusSelectionEnum | Selects campaigns with the specified statuses. For status descriptions, see Campaign status and state. | No |
StatusesPayment | array of CampaignStatusPaymentEnum | Selects campaigns with the specified payment statuses. For status descriptions, see Campaign status and state. | No |
Response
Response structure in JSON format:
{
"result": { /* result */
"Campaigns": [{ /* CampaignGetItem */
"Id": (long),
"Name": (string),
"StartDate": (string),
"Type": ( "TEXT_CAMPAIGN" | "MOBILE_APP_CAMPAIGN" | "DYNAMIC_TEXT_CAMPAIGN" | "SMART_CAMPAIGN" | "UNIFIED_CAMPAIGN" | "UNKNOWN" ),
"Status": ( "ACCEPTED" | "DRAFT" | "MODERATION" | "REJECTED" | "UNKNOWN" ),
"State": ( "ARCHIVED" | "CONVERTED" | "ENDED" | "OFF" | "ON" | "SUSPENDED" | "UNKNOWN" ),
"StatusPayment": ( "DISALLOWED" | "ALLOWED" ),
"StatusClarification": (string),
"SourceId": (long), /* nillable */
"Statistics": { /* Statistics */
"Clicks": (long), /* required */
"Impressions": (long) /* required */
},
"Currency": ( "RUB" | ... | "USD" ),
"Funds": { /* FundsParam */
"Mode": ( "CAMPAIGN_FUNDS" | "SHARED_ACCOUNT_FUNDS" ), /* required */
"CampaignFunds": { /* CampaignFundsParam */
"Sum": (long), /* required */
"Balance": (long), /* required */
"BalanceBonus": (long), /* required */
"SumAvailableForTransfer": (long)
},
"SharedAccountFunds": { /* SharedAccountFundsParam */
"Refund": (long),
"Spend": (long)
}
},
"RepresentedBy": { /* CampaignAssistant */
"Manager": (string), /* nillable */
"Agency": (string) /* nillable */
},
"DailyBudget": { /* DailyBudget */
"Amount": (long), /* required */
"Mode": ( "STANDARD" | "DISTRIBUTED" ) /* required */
}, /* nillable */
"EndDate": (string), /* nillable */
"NegativeKeywords": { /* ArrayOfString */
"Items": [(string), ... ] /* required */
}, /* nillable */
"BlockedIps": { /* ArrayOfString */
"Items": [(string), ... ] /* required */
}, /* nillable */
"ExcludedSites": { /* ArrayOfString */
"Items": [(string), ... ] /* required */
}, /* nillable */
"TextCampaign": { /* TextCampaignGetItem */
... text campaign params ...
},
"MobileAppCampaign": { /* MobileAppCampaignGetItem */
... mobile app campaign params ...
},
"DynamicTextCampaign": { /* DynamicTextCampaignGetItem */
... dynamic text campaign params ...
},
"CpmBannerCampaign": { /* CpmBannerCampaignGetItem */
... cpm banner campaign params ...
},
"SmartCampaign": { /* SmartCampaignGetItem */
... smart campaign params ...
},
"UnifiedCampaign": { /* SmartCampaignGetItem */
... unified campaign params ...
},
"ClientInfo": (string), /* nillable */
"Notification": { /* Notification */ /* nillable */
"SmsSettings": { /* SmsSettings */
"Events": [( "MONITORING" | ... | "FINISHED" ), ... ],
"TimeFrom": (string),
"TimeTo": (string)
},
"EmailSettings": { /* EmailSettings */
"Email": (string),
"CheckPositionInterval": (int),
"WarningBalance": (int),
"SendAccountNews": ( "YES" | "NO" ),
"SendWarnings": ( "YES" | "NO" )
}
},
"TimeTargeting": { /* TimeTargeting */
"Schedule": { /* ArrayOfString */
"Items": [(string), ... ] /* required */
},
"ConsiderWorkingWeekends": ( "YES" | "NO" ), /* required */
"HolidaysSchedule": { /* TimeTargetingOnPublicHolidays */
"SuspendOnHolidays": ( "YES" | "NO" ), /* required */
"BidPercent": (int),
"StartHour": (int),
"EndHour": (int)
} /* nillable */
},
"TimeZone": (string)
}, ... ],
"LimitedBy": (long)
}
}
Parameter | Type | Description |
Result structure (for JSON) / GetResponse (for SOAP) | ||
---|---|---|
Campaigns | array of CampaignGetItem | Campaigns. |
LimitedBy | long | Sequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See Paginated selection. |
CampaignGetItem structure | ||
Id | long | The campaign ID. |
Name | string | Campaign name (maximum of 255 characters). |
ClientInfo | string, nillable | Client name (maximum of 255 characters). The default value is the name from the advertiser's settings. |
StartDate | string | Start date for displaying ads, in the format YYYY-MM-DD. Can't be earlier than the current date. Ad displays begin at 00:00 Moscow time (regardless of the TimeZone parameter). The start time for displays is affected by the time targeting settings (the TimeTargeting parameter). Ad displays are possible only if at least one ad has passed review and funds have been credited to the campaign or shared account. |
EndDate | string, nillable | End date for displaying ads, in the format YYYY-MM-DD. Ad impressions end at 24:00 Moscow time (regardless of the TimeZone parameter). |
TimeTargeting | TimeTargeting | Settings for time targeting and hourly bid adjustments. Specified for the time zone set in the TimeZone parameter. |
TimeZone | string | Time zone of the advertiser's location. Use the Dictionaries.get method to get a reference list of time zones. The default value is Europe/Moscow. |
NegativeKeywords | ArrayOfString, nillable | Array of negative keywords that are shared by all the keywords of a campaign. Restriction. This parameter is not supported for campaigns with the “Display campaign” type. A keyword should be specified without the minus sign before the first word. Maximum of 7 words per keyword. The maximum length of each word is 35 characters. The maximum combined length of negative keywords in the array is 20,000 characters. Spaces, dashes, and operators are not counted as part of the total length. |
BlockedIps | ArrayOfString, nillable | Array of IP addresses that campaign ads should not be shown to. Maximum of 25 items in the array. |
ExcludedSites | ArrayOfString, nillable | Array of display places where the ad shouldn't be displayed:
Maximum of 1000 items in the array. Maximum of 255 characters per array item. |
DailyBudget | DailyBudget, nillable | Settings for the daily budget of a campaign. Daily budget management is available if a manual display strategy is selected in the campaign. Otherwise, an attempt to set the daily budget results in an error. |
Notification | Notification, nillable | Settings for SMS and email notifications. |
Type | CampaignTypeGetEnum | Type of campaign. See Campaign type. |
Status | StatusEnum | Status of the campaign. See Campaign status and state. |
State | CampaignStateGetEnum | Campaign state. See Campaign status and state. |
StatusPayment | CampaignStatusPaymentEnum | Campaign payment status. For payment status descriptions, see Campaign status and state. |
StatusClarification | string | Text explanation of the status. |
SourceId | long, nillable | ID of the source campaign in Yandex units if the current campaign was created automatically when switching the advertiser to a real currency. |
Statistics | Statistics | Statistics for displays and clicks since the campaign was launched. |
Currency | CurrencyEnum | Campaign currency. It's the same as the advertiser's currency for all campaigns except those run in Yandex units that were copied when the advertiser switched to a real currency. To get the list of currencies, use the Dictionaries.get method. |
Funds | FundsParam | Financial indicators of the campaign. |
RepresentedBy | CampaignAssistant | The Yandex personal manager or agency handling the campaign. |
TextCampaign | TextCampaignGetItem | Settings for campaigns with the “Text & Image ads” type. For a data structure description, see get: TextCampaign parameters. |
MobileAppCampaign | MobileAppCampaignGetItem | Settings for “Ads for mobile apps” campaigns. For a data structure description, see get: MobileAppCampaign parameters. |
DynamicTextCampaign | DynamicTextCampaignGetItem | Settings for campaigns with the “Dynamic ads” type. For a data structure description, see get: DynamicTextCampaign parameters. |
CpmBannerCampaign | CpmBannerCampaignGetItem | Settings for the “Display campaign” type. For a data structure description, see get: CpmBannerCampaign parameters. |
SmartCampaign | SmartCampaignGetItem | Settings for “Smart banners” campaigns. For a data structure description, see get: SmartCampaign parameters. |
UnifiedCampaign | UnifiedCampaignGetItem | Settings for campaigns with the “Unified performance campaign” type. For a data structure description, see get: UnifiedCampaign parameters. |
TimeTargeting structure | ||
Schedule | ArrayOfString | Settings for time targeting and hourly bid adjustments. Maximum of 7 items in the array. Each array item contains 25 comma-separated numbers. The first number is the number of the day of the week: from 1 (Monday) to 7 (Sunday). The next 24 numbers are a sequence of bid coefficients for displaying ads in the corresponding hours. Coefficients are specified as percentages from 0 to 200. The value must be a multiple of 10: If the coefficient is 0, no ads are served during this hour. Example of an array element: 1, 0, 0, 50, 50, 100, 100, 150, 200, 200, 150, 100, 100, 80, 70, 100, 100, 100, 50, 50, 40, 30, 0, 0, 0 Note.
|
ConsiderWorkingWeekends | YesNoEnum | Whether to change the display schedule when a work day is moved to Saturday or Sunday because of a public holiday. For example, if a work day is moved from Monday to Saturday and the value is YES, on the Saturday work day, ads are displayed according to the Monday schedule, and on the Monday holiday, they are displayed according to the Saturday schedule. |
HolidaysSchedule | TimeTargetingOnPublicHolidays, nillable | Display settings on public holidays. If the time zone specified in the TimeZone parameter belongs to Russia, Ukraine, Belarus, Kazakhstan, or Turkey, we use the holiday calendar for the appropriate country. In all other cases, we use the Russian calendar. |
TimeTargetingOnPublicHolidays structure | ||
SuspendOnHolidays | YesNoEnum | Whether to suspend ads on public holidays: YES — suspend; NO — don't suspend. Note. The BidPercent, StartHour and EndHour parameters can only be set when SuspendOnHolidays has the value NO. |
BidPercent | int | The bid coefficient for displays on public holidays. Specified as a percentage from 0 to 200. The value must be a multiple of 10. |
StartHour | int | The time (in hours) to start displays on public holidays. From 0 to 23. |
EndHour | int | The time (in hours) to end displays on public holidays. From 0 to 24. |
DailyBudget structure | ||
Amount | long | The daily campaign budget in the advertiser currency, multiplied by 1,000,000. The minimum daily budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method. |
Mode | DailyBudgetModeEnum | Mode for displaying ads:
See the Average daily budget section under “Manual bid management” in the Help for Yandex Direct. |
Notification structure | ||
SmsSettings | SmsSettings | Settings for sending SMS notifications. The phone number to send notifications to is taken from the advertiser's Yandex profile (see My numbers in the Yandex Passport Help). |
EmailSettings | EmailSettings | Settings for sending email notifications. |
SmsSettings structure | ||
Events | array of SmsEventsEnum | Events to notify of by SMS:
|
TimeFrom | string | The allowed starting time for sending SMS notifications of campaign events. Specified in the format HH:MM; minutes are set in multiples of 15 (0, 15, 30, 45). For example, 19:45. The default value is 9:00. |
TimeTo | string | The ending time for sending SMS notifications of campaign events. Specified in the format HH:MM; minutes are set in multiples of 15 (0, 15, 30, 45). For example, 19:45. The default value is 21:00. |
EmailSettings structure | ||
Email | string | The email address for sending notifications of campaign events. The default value is the advertiser's address. |
CheckPositionInterval | int | The frequency of checking the traffic forecast: 15, 30 or 60 minutes. The default value is 60. A notification is sent if the traffic forecast is lower than the one that the bid covered at the time of configuration. |
WarningBalance | int | The minimal balance; notification is sent when the account balance is reduced to this amount. Set as a percentage of the amount of the last payment, from 1 to 50. The default value is 20. If the client has the shared account enabled, this parameter is not used. |
SendAccountNews | YesNoEnum | Whether to send notifications of events related to the campaign. It is set for campaigns that have a personal Yandex manager. For campaigns that are not handled by a personal manager, the passed value is ignored. The default value is NO. |
SendWarnings | YesNoEnum | Whether to send email notifications. The default value is NO. |
Statistics structure | ||
Impressions | long | The number of impressions since the campaign was launched. |
Clicks | long | The number of clicks since the campaign was launched. |
FundsParam structure | ||
Mode | CampaignFundsEnum | Type of financial indicators for the campaign:
|
CampaignFunds | CampaignFundsParam | The campaign's financial indicators, if the shared account is not enabled. |
SharedAccountFunds | SharedAccountFundsParam | The campaign's financial indicators, if the shared account is enabled. |
CampaignFundsParam structure | ||
Sum | long | The amount of funds credited to the campaign balance since the campaign was launched, in the advertiser's currency with VAT included. |
Balance | long | The current balance of the campaign, in the advertiser's currency without VAT. |
BalanceBonus | long | Discount bonus. This parameter is no longer relevant. |
SumAvailableForTransfer | long | The amount available for transferring to another campaign, in the advertiser's currency without VAT. |
SharedAccountFundsParam structure | ||
Refund | long | This parameter is obsolete. Always returns 0. |
Spend | long | The amount of funds spent on this campaign since its launch, in the advertiser's currency with VAT included. |
CampaignAssistant structure | ||
Manager | string, nillable | The name of the Yandex personal manager (for campaigns that are handled by a personal manager). |
Agency | string, nillable | The name of the advertising agency (for campaigns that are handled by an agency). |
Parameter | Type | Description |
Result structure (for JSON) / GetResponse (for SOAP) | ||
---|---|---|
Campaigns | array of CampaignGetItem | Campaigns. |
LimitedBy | long | Sequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See Paginated selection. |
CampaignGetItem structure | ||
Id | long | The campaign ID. |
Name | string | Campaign name (maximum of 255 characters). |
ClientInfo | string, nillable | Client name (maximum of 255 characters). The default value is the name from the advertiser's settings. |
StartDate | string | Start date for displaying ads, in the format YYYY-MM-DD. Can't be earlier than the current date. Ad displays begin at 00:00 Moscow time (regardless of the TimeZone parameter). The start time for displays is affected by the time targeting settings (the TimeTargeting parameter). Ad displays are possible only if at least one ad has passed review and funds have been credited to the campaign or shared account. |
EndDate | string, nillable | End date for displaying ads, in the format YYYY-MM-DD. Ad impressions end at 24:00 Moscow time (regardless of the TimeZone parameter). |
TimeTargeting | TimeTargeting | Settings for time targeting and hourly bid adjustments. Specified for the time zone set in the TimeZone parameter. |
TimeZone | string | Time zone of the advertiser's location. Use the Dictionaries.get method to get a reference list of time zones. The default value is Europe/Moscow. |
NegativeKeywords | ArrayOfString, nillable | Array of negative keywords that are shared by all the keywords of a campaign. Restriction. This parameter is not supported for campaigns with the “Display campaign” type. A keyword should be specified without the minus sign before the first word. Maximum of 7 words per keyword. The maximum length of each word is 35 characters. The maximum combined length of negative keywords in the array is 20,000 characters. Spaces, dashes, and operators are not counted as part of the total length. |
BlockedIps | ArrayOfString, nillable | Array of IP addresses that campaign ads should not be shown to. Maximum of 25 items in the array. |
ExcludedSites | ArrayOfString, nillable | Array of display places where the ad shouldn't be displayed:
Maximum of 1000 items in the array. Maximum of 255 characters per array item. |
DailyBudget | DailyBudget, nillable | Settings for the daily budget of a campaign. Daily budget management is available if a manual display strategy is selected in the campaign. Otherwise, an attempt to set the daily budget results in an error. |
Notification | Notification, nillable | Settings for SMS and email notifications. |
Type | CampaignTypeGetEnum | Type of campaign. See Campaign type. |
Status | StatusEnum | Status of the campaign. See Campaign status and state. |
State | CampaignStateGetEnum | Campaign state. See Campaign status and state. |
StatusPayment | CampaignStatusPaymentEnum | Campaign payment status. For payment status descriptions, see Campaign status and state. |
StatusClarification | string | Text explanation of the status. |
SourceId | long, nillable | ID of the source campaign in Yandex units if the current campaign was created automatically when switching the advertiser to a real currency. |
Statistics | Statistics | Statistics for displays and clicks since the campaign was launched. |
Currency | CurrencyEnum | Campaign currency. It's the same as the advertiser's currency for all campaigns except those run in Yandex units that were copied when the advertiser switched to a real currency. To get the list of currencies, use the Dictionaries.get method. |
Funds | FundsParam | Financial indicators of the campaign. |
RepresentedBy | CampaignAssistant | The Yandex personal manager or agency handling the campaign. |
TextCampaign | TextCampaignGetItem | Settings for campaigns with the “Text & Image ads” type. For a data structure description, see get: TextCampaign parameters. |
MobileAppCampaign | MobileAppCampaignGetItem | Settings for “Ads for mobile apps” campaigns. For a data structure description, see get: MobileAppCampaign parameters. |
DynamicTextCampaign | DynamicTextCampaignGetItem | Settings for campaigns with the “Dynamic ads” type. For a data structure description, see get: DynamicTextCampaign parameters. |
CpmBannerCampaign | CpmBannerCampaignGetItem | Settings for the “Display campaign” type. For a data structure description, see get: CpmBannerCampaign parameters. |
SmartCampaign | SmartCampaignGetItem | Settings for “Smart banners” campaigns. For a data structure description, see get: SmartCampaign parameters. |
UnifiedCampaign | UnifiedCampaignGetItem | Settings for campaigns with the “Unified performance campaign” type. For a data structure description, see get: UnifiedCampaign parameters. |
TimeTargeting structure | ||
Schedule | ArrayOfString | Settings for time targeting and hourly bid adjustments. Maximum of 7 items in the array. Each array item contains 25 comma-separated numbers. The first number is the number of the day of the week: from 1 (Monday) to 7 (Sunday). The next 24 numbers are a sequence of bid coefficients for displaying ads in the corresponding hours. Coefficients are specified as percentages from 0 to 200. The value must be a multiple of 10: If the coefficient is 0, no ads are served during this hour. Example of an array element: 1, 0, 0, 50, 50, 100, 100, 150, 200, 200, 150, 100, 100, 80, 70, 100, 100, 100, 50, 50, 40, 30, 0, 0, 0 Note.
|
ConsiderWorkingWeekends | YesNoEnum | Whether to change the display schedule when a work day is moved to Saturday or Sunday because of a public holiday. For example, if a work day is moved from Monday to Saturday and the value is YES, on the Saturday work day, ads are displayed according to the Monday schedule, and on the Monday holiday, they are displayed according to the Saturday schedule. |
HolidaysSchedule | TimeTargetingOnPublicHolidays, nillable | Display settings on public holidays. If the time zone specified in the TimeZone parameter belongs to Russia, Ukraine, Belarus, Kazakhstan, or Turkey, we use the holiday calendar for the appropriate country. In all other cases, we use the Russian calendar. |
TimeTargetingOnPublicHolidays structure | ||
SuspendOnHolidays | YesNoEnum | Whether to suspend ads on public holidays: YES — suspend; NO — don't suspend. Note. The BidPercent, StartHour and EndHour parameters can only be set when SuspendOnHolidays has the value NO. |
BidPercent | int | The bid coefficient for displays on public holidays. Specified as a percentage from 0 to 200. The value must be a multiple of 10. |
StartHour | int | The time (in hours) to start displays on public holidays. From 0 to 23. |
EndHour | int | The time (in hours) to end displays on public holidays. From 0 to 24. |
DailyBudget structure | ||
Amount | long | The daily campaign budget in the advertiser currency, multiplied by 1,000,000. The minimum daily budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method. |
Mode | DailyBudgetModeEnum | Mode for displaying ads:
See the Average daily budget section under “Manual bid management” in the Help for Yandex Direct. |
Notification structure | ||
SmsSettings | SmsSettings | Settings for sending SMS notifications. The phone number to send notifications to is taken from the advertiser's Yandex profile (see My numbers in the Yandex Passport Help). |
EmailSettings | EmailSettings | Settings for sending email notifications. |
SmsSettings structure | ||
Events | array of SmsEventsEnum | Events to notify of by SMS:
|
TimeFrom | string | The allowed starting time for sending SMS notifications of campaign events. Specified in the format HH:MM; minutes are set in multiples of 15 (0, 15, 30, 45). For example, 19:45. The default value is 9:00. |
TimeTo | string | The ending time for sending SMS notifications of campaign events. Specified in the format HH:MM; minutes are set in multiples of 15 (0, 15, 30, 45). For example, 19:45. The default value is 21:00. |
EmailSettings structure | ||
Email | string | The email address for sending notifications of campaign events. The default value is the advertiser's address. |
CheckPositionInterval | int | The frequency of checking the traffic forecast: 15, 30 or 60 minutes. The default value is 60. A notification is sent if the traffic forecast is lower than the one that the bid covered at the time of configuration. |
WarningBalance | int | The minimal balance; notification is sent when the account balance is reduced to this amount. Set as a percentage of the amount of the last payment, from 1 to 50. The default value is 20. If the client has the shared account enabled, this parameter is not used. |
SendAccountNews | YesNoEnum | Whether to send notifications of events related to the campaign. It is set for campaigns that have a personal Yandex manager. For campaigns that are not handled by a personal manager, the passed value is ignored. The default value is NO. |
SendWarnings | YesNoEnum | Whether to send email notifications. The default value is NO. |
Statistics structure | ||
Impressions | long | The number of impressions since the campaign was launched. |
Clicks | long | The number of clicks since the campaign was launched. |
FundsParam structure | ||
Mode | CampaignFundsEnum | Type of financial indicators for the campaign:
|
CampaignFunds | CampaignFundsParam | The campaign's financial indicators, if the shared account is not enabled. |
SharedAccountFunds | SharedAccountFundsParam | The campaign's financial indicators, if the shared account is enabled. |
CampaignFundsParam structure | ||
Sum | long | The amount of funds credited to the campaign balance since the campaign was launched, in the advertiser's currency with VAT included. |
Balance | long | The current balance of the campaign, in the advertiser's currency without VAT. |
BalanceBonus | long | Discount bonus. This parameter is no longer relevant. |
SumAvailableForTransfer | long | The amount available for transferring to another campaign, in the advertiser's currency without VAT. |
SharedAccountFundsParam structure | ||
Refund | long | This parameter is obsolete. Always returns 0. |
Spend | long | The amount of funds spent on this campaign since its launch, in the advertiser's currency with VAT included. |
CampaignAssistant structure | ||
Manager | string, nillable | The name of the Yandex personal manager (for campaigns that are handled by a personal manager). |
Agency | string, nillable | The name of the advertising agency (for campaigns that are handled by an agency). |