Campaign Management Data Objects

 

The Campaign Management service defines the following data objects.

Data ObjectDescription
AccountMigrationStatusesInfoAccountMigrationStatusesInfoDefines an object that contains migration status for an account.
AccountPropertyMaps an account level property name to a string value.
AdDefines the base class of an ad.
AddressDefines a postal address.
AdExtensionDefines an object that determines whether text ads in the specified campaign will contain decorative elements, for example the customer's location or phone number.
AdExtensionAssociationDefines the relationship and editorial status of an ad extension with an account, campaign, or ad group.
AdExtensionAssociationCollectionDefines an array of objects that associate an ad extension and its editorial status to an account, campaign, or ad group.
AdExtensionEditorialReasonDefines an object that you can use to determine the component of an ad extension that failed editorial review, and the reason for the failure.
AdExtensionEditorialReasonCollectionDefines a collection of ad extensions that failed editorial review.
AdExtensionIdentityDefines an object that identifies an ad extension.
AdExtensionIdToEntityIdAssociationDefines an object that associates an ad extension to an account, campaign, or ad group.
AdGroupDefines an ad group.
AdGroupCriterionDefines a criterion that you want applied to the specified ad group.
AdGroupCriterionActionDefines the action to apply to a BiddableAdGroupCriterion or NegativeAdGroupCriterion, specifically one that contains a ProductPartition. You can send a group of AdGroupCriterionAction objects, also known as a product group, to the ApplyProductPartitionActions service operation.
AdGroupNegativeSitesDefines an object that contains the negative site URLs of an ad group.
AdRotationDefines an object that specifies an ad rotation type.
AgeCriterionDefines a criterion that can be used to show ads to users in a specific age range.
AppAdExtensionDefines an app ad extension that can be included in a text ad.
AppInstallAdDefines an app install ad.
AppInstallGoalDefines an app install conversion goal. Use this type of goal to track every time someone installs your app as a conversion.
AppUrlDefines the operating system platform and URL of the app store download webpage.

Reserved for future use.
AudienceDefines the base class of an audience.
AudienceCriterionDefines a criterion that can be used to show ads to a specific audience.
BidDefines a bid.
BiddableAdGroupCriterionDefines a criterion that helps determine whether ads in the campaign can be served. If the condition is met, the specified bid is used in the auction.
BiddableCampaignCriterionDefines a criterion that helps determine whether ads in the ad group can be served. If the condition is met, the specified bid is used in the auction.
BiddingSchemeDefines the base object of a bidding scheme for how you want to manage your bids. A bidding scheme is known as a bid strategy type in the Bing Ads web application.
BidMultiplierDefines the multiplier by which to adjust your base bid for the corresponding criterion.
BMCStoreDefines a Bing Merchant Center store.
BudgetRepresents a budget that can be shared by any campaigns in an account.
CallAdExtensionDefines a call ad extension that can be included in a text ad.
CalloutAdExtensionDefines a callout ad extension that can be included in a text ad.
CampaignDefines a campaign.
CampaignCriterionDefines a criterion that you want applied to the specified campaign.
CampaignNegativeSitesDefines an object that contains the negative site URLs of a campaign.
ConversionGoalefines the base object of a conversion goal.
ConversionGoalRevenueDefines properties for revenue that can be tracked by a conversion goal.
CriterionDefines the base object of a criterion.
CriterionBidDefines a base class for criterion bids.
CustomAudienceDefines a custom audience.
CustomEventsRuleDefines a custom events remarketing rule.
CustomParameterDefines a key and value custom parameter for URL tracking. Used for campaign, ad group, ad, keyword, sitelink, and ad group criterion URL custom parameters.
CustomParametersDefines a collection of key and value custom parameters for URL tracking. Used for campaign, ad group, ad, keyword, sitelink, and ad group criterion URL custom parameters.
DayTimeDefines a day of the week and time range for ad extension scheduling.
DayTimeCriterionDefines a criterion that can be used to show ads during a specific day and time range.
DeviceCriterionDefines a criterion that can be used to show ads on specific devices.
DurationGoalDefines a duration conversion goal. Use this type of goal to count every time someone stays on a website for longer than a certain amount of time as a conversion.
DynamicSearchAdDefines an dynamic search ad that is generated automatically based on the website domain and language that you want to target.
DynamicSearchAdsSettingDefines the campaign level settings for a Dynamic Search Ads campaign.
EditorialReasonDefines an object that you can use to determine the component of an ad or keyword that failed editorial review, and the reason for the failure.
EditorialReasonCollectionDefines a collection of ads or keywords that failed editorial review, and the reason for the failure.
EnhancedCpcBiddingSchemeDefines an object that represents the enhanced CPC bid strategy type.
EntityIdToParentIdAssociationDefines an object that contains the unique system identifier of an entity such as ad or keyword, and the identifier of its parent. An ad group is the parent of an ad or keyword.
EntityNegativeKeywordDefines an object that contains a set of negative keywords and the associated entity such as a campaign.
EventGoalDefines a custom event conversion goal. Use this type of goal to count every time someone completes a specific action such as, subscribing to newsletter or downloading white paper, as a conversion.
ExpandedTextAdDefines an expanded text ad.
FixedBidDefines the fixed bid to use in the auction.
GenderCriterionDefines a criterion that can be used to show ads to users of a specific gender.
GeoPointDefines an object that contains the longitude and latitude coordinates of a geographical location.
IdCollectionDefines an object that contains a list of entity identifiers.
ImageDefines an image object that can be added to an account’s media library.
ImageAdExtensionDefines an ad extension that specifies an image with alternative text to include in a text ad.
ImageMediaRepresentationDefines an image media representation with height and width.
InheritFromParentBiddingSchemeDefines an object that represents the inherit from parent bid strategy type.
InMarketAudienceDefines an in-market audience.
InStoreTransactionGoalDefines an in-store transaction goal.
KeywordDefines a keyword.
LabelLabels let you organize campaigns, ad groups, ads, and keywords into groups based on whatever is important to you. You can then filter and run reports on your labels to get the data that is most meaningful to you.
LabelAssociationDefines the relationship between a label and campaign, ad group, ad, or keyword entity.
LocationAdExtensionDefines an ad extension that specifies a business’ address and phone number to include in a text ad.
LocationCriterionDefines a criterion that can be used to show ads to users in a specific location.
LocationIntentCriterionDefines a criterion that determines the intent option for all location and radius criterions of the campaign or ad group.
ManualCpcBiddingSchemeDefines an object that represents the manual CPC bid strategy type.
MaxClicksBiddingSchemeDefines an object that represents the maximum clicks bid strategy type.
MaxConversionsBiddingSchemeDefines an object that represents the maximum conversions bid strategy type.
MediaDefines the base object of media.
MediaAssociationDefines an object that represents the identified media and an associated entity, for example media associated with an ad group.
MediaMetaDataDefines a media meta data object. The meta data includes download Urls for one or more media representations.
MediaRepresentationDefines a media representation base class that includes a media download Url.
MigrationStatusInfoDefines an object that contains the migration type and status for an account.
NegativeAdGroupCriterionDefines a criterion that you want to exclude from the specified ad group.
NegativeCampaignCriterionDefines a criterion that you want to exclude from the specified campaign.
NegativeKeywordDefines a negative keyword with match type.
NegativeKeywordListDefines a negative keyword list.
OfflineConversionDefines an offline conversion that you send to Bing Ads.
OfflineConversionGoalDefines an offline conversion goal. Use this type of goal if you have lead generation as an objective. Lead generation is when potential customers fill out a form or quote of interest, and then the sale is completed offline in person or over the phone (for example, car purchases, insurance quotes, mortgages, etc.).
PagesViewedPerVisitGoalDefines a pages viewed per visit conversion goal. Use this type of goal to count every time someone visits more than a specified number of pages on your website as a conversion.
PageVisitorsRuleDefines a page visitors remarketing rule.
PageVisitorsWhoDidNotVisitAnotherPageRuleDefines a page visitors who did not visit another page remarketing rule.
PageVisitorsWhoVisitedAnotherPageRuleDefines a page visitors who visited another page remarketing rule.
PagingDefines a paging object that you can use to request labels and label associations in batches.
PriceAdExtensionDefines an ad extension that includes between 3 and 8 price table rows.
PriceTableRowDefines pricing information by currency and unit that you can use with price ad extensions.
ProductAdDefines a product ad.
ProductConditionDefines a condition that determines whether the product is selected.
ProductPartitionDefines an ad group level product partition with one condition that helps determine whether a product from the Bing Merchant Center store gets served as a product ad.
ProductScopeDefines a campaign level product scope with list of conditions that help determine whether a product from the Bing Merchant Center store gets served as a product ad.
RadiusCriterionDefines a criterion that can be used to show ads to users within the radius of a specific geographical location.
RemarketingListDefines a remarketing list.
RemarketingRuleDefines the base object of a remarketing rule.
ReviewAdExtensionDefines a review ad extension that can be included in a text ad.
RuleItemDefines the base class of a remarketing list rule item.
RuleItemGroupDefines an object that contains a list of remarketing list rule items that apply to the same visited page.
ScheduleDefines the start and end date ranges for ad extension scheduling.
SettingDefines the base class of a setting.
SharedEntityDefines the base class of a shared entity.
SharedEntityAssociationDefines an object that contains association information for a campaign and shared entity such as a negative keyword list.
SharedListDefines the base class of a shared list.
SharedListItemDefines the base class of a shared list item.
ShoppingSettingDefines a shopping setting for a Bing Shopping campaign.
SiteLinkDefines a site link to include in an ad.
SiteLinksAdExtensionDefines an object with multiple sitelinks per ad extension.
Sitelink2AdExtensionDefines an object with one sitelink per ad extension.
StringRuleItemDefines a rule expression that depends on the string values of the Url or Referrer Url.
TargetCpaBiddingSchemeDefines an object that represents the target CPA bid strategy type.
TextAdDefines a text ad.
UetTagDefines a Universal Event Tracking (UET) tag that you can add to your website to allow Bing Ads to collect actions people take on your website.
UrlGoalDefines a URL conversion goal. Use this type of goal to count every time someone visits a web page as a conversion.
WebpageDefines a webpage parameter that contains a list of webpage conditions or criteria that help determine whether you want to show dynamic search ads.
WebpageConditionDefines a condition or criterion that helps determine whether you want to show dynamic search ads.
WebpageParameterDefines the conditions or criteria that determine whether you want to show dynamic search ads.
Show: