Campaign Management Data Objects

The Campaign Management service defines the following data objects.

Data Object Description
AccountMigrationStatusesInfo Defines an object that contains migration status for an account.
AccountProperty Maps an account level property name to a string value.
Ad Defines the base object of an ad.
AdApiError Defines an error object that contains the details that explain why the service operation failed.
AdApiFaultDetail Defines a fault object that operations return when generic errors occur, such as an authentication error.
Address Defines a postal address.
AdExtension Defines the base object of an ad extension.
AdExtensionAssociation Defines the relationship and editorial status of an ad extension with an account, campaign, or ad group.
AdExtensionAssociationCollection Defines an array of objects that associate an ad extension and its editorial status to an account, campaign, or ad group.
AdExtensionEditorialReason Defines an object that you can use to determine the component of an ad extension that failed editorial review, and the reason for the failure.
AdExtensionEditorialReasonCollection Defines a collection of ad extensions that failed editorial review.
AdExtensionIdentity Defines an object that identifies an ad extension revision.
AdExtensionIdToEntityIdAssociation Defines an object that associates an ad extension to a supported entity, for example ad group or campaign.
AdGroup Defines an ad group.
AdGroupCriterion Defines a criterion that you want applied to the specified ad group.
AdGroupCriterionAction Defines the action to apply to a BiddableAdGroupCriterion or NegativeAdGroupCriterion, specifically one that contains a ProductPartition.
AdGroupNegativeSites Defines an object that contains the negative site URLs of an ad group.
AdRotation Defines an object that specifies the type of ad rotation to apply to the ad group.
AgeCriterion Defines a criterion that can be used to show ads to users in a specific age range.
ApiFaultDetail Defines a fault object that operations return when web service-specific errors occur, such as when the request message contains incomplete or invalid data.
AppAdExtension Defines an app ad extension that can be included in a text ad.
AppInstallAd Defines an app install ad.
AppInstallGoal Defines an app install conversion goal.
ApplicationFault Defines the base object from which all fault detail objects derive.
AppUrl Defines the operating system platform and URL of the app store download webpage.
Audience Defines the base object of an audience.
AudienceCriterion Defines a criterion that can be used to show ads to a specific audience.
BatchError Defines an error object that identifies the item within the batch of items in the request message that caused the operation to fail, and describes the reason for the failure.
BatchErrorCollection Defines an error object that contains batch error details for the top level list index and a list of batch errors corresponding to the nested list index.
Bid Defines a bid.
BiddableAdGroupCriterion Defines a biddable criterion that you want applied to the specified ad group.
BiddableCampaignCriterion Defines a biddable criterion that you want applied to the specified campaign.
BiddingScheme Defines the base object of a bidding scheme for how you want to manage your bids.
BidMultiplier Defines the multiplier by which to adjust your base bid for the corresponding criterion.
BMCStore Defines a Bing Merchant Center store.
Budget Represents a budget that can be shared by any campaigns in an account.
CallAdExtension Defines an object that specifies a click-to-call phone number to include in a text ad.
CalloutAdExtension Defines an object that specifies additional text about your business, products, or services to include in a text ad.
Campaign Defines a campaign.
CampaignCriterion Defines a criterion that you want applied to the specified campaign.
CampaignNegativeSites Defines an object that contains the negative site URLs of a campaign.
ConversionGoal Defines the base object of a conversion goal.
ConversionGoalRevenue Defines properties for revenue that can be tracked by a conversion goal.
Criterion Defines the base object of a criterion.
CriterionBid Defines a base class for criterion bids.
CustomAudience Defines a custom audience.
CustomEventsRule Defines a custom events remarketing rule.
CustomParameter Defines a key and value custom parameter for URL tracking.
CustomParameters Defines a collection of key and value custom parameters for URL tracking.
Date Represents a date.
DayTime Defines a day of the week and time range for ad extension scheduling.
DayTimeCriterion Defines a criterion that can be used to show ads to users during a specific day and time range.
DeviceCriterion Defines a criterion that can be used to show ads on specific devices.
DurationGoal Defines a duration conversion goal.
DynamicSearchAd Defines a dynamic search ad.
DynamicSearchAdsSetting Defines the campaign level settings for a Dynamic Search Ads campaign.
EditorialApiFaultDetail Defines a fault object that operations such as AddAdGroupCriterions, UpdateAdGroupCriterions, SetAdExtensionsAssociations, and UpdateAdExtensions return when one or more criterion or ad extensions in your request message fail editorial review.
EditorialError Defines an error object that identifies the entity with the batch of entities that failed editorial review.
EditorialReason Defines 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.
EditorialReasonCollection Defines a collection of ads or keywords that failed editorial review, and the reason for the failure.
EnhancedCpcBiddingScheme Defines an object that represents the enhanced CPC bid strategy type.
EntityIdToParentIdAssociation Defines an object that contains the unique system identifier of an entity such as ad or keyword, and the identifier of its parent.
EntityNegativeKeyword Defines an object that contains a set of negative keywords that are only associated with the corresponding entity such as a campaign or ad group.
EventGoal Defines a custom event conversion goal.
ExpandedTextAd Defines an expanded text ad.
FixedBid Defines the fixed bid to use in the auction.
GenderCriterion Defines a criterion that can be used to show ads to users of a specific gender.
GeoPoint Defines an object that contains the longitude and latitude coordinates of a geographical location.
IdCollection Defines an object that contains a list of entity identifiers.
Image Defines an image object that can be added to an account's media library.
ImageAdExtension Defines an ad extension that specifies an image with alternative text to include in a text ad.
ImageMediaRepresentation Defines an image media representation with height and width.
InheritFromParentBiddingScheme Defines an object that represents the inherit from parent bid strategy type.
InMarketAudience Defines an in-market audience.
InStoreTransactionGoal Defines an in-store transaction goal.
KeyValuePairOfstringstring The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version.
Keyword Defines a keyword.
Label Labels let you organize campaigns, ad groups, ads, and keywords into groups based on whatever is important to you.
LabelAssociation Defines the relationship between a label and campaign, ad group, ad, or keyword entity.
LocationAdExtension Defines an ad extension that specifies a business address and phone number to include in a text ad.
LocationCriterion Defines a criterion that can be used to show ads to users in a specific location.
LocationIntentCriterion Defines a criterion that determines the intent option for all location and radius criterions of the campaign or ad group.
ManualCpcBiddingScheme Defines an object that represents the manual CPC bid strategy type.
MaxClicksBiddingScheme Defines an object that represents the maximum clicks bid strategy type.
MaxConversionsBiddingScheme Defines an object that represents the maximum conversions bid strategy type.
Media Defines the base object of media.
MediaAssociation Defines an object that represents the identified media and an associated entity, for example media associated with an ad group.
MediaMetaData Defines a media meta data object.
MediaRepresentation Defines a media representation base class that includes a media download Url.
MigrationStatusInfo Defines an object that contains the migration type and status for an account.
NegativeAdGroupCriterion Defines a criterion that you want to exclude from the specified ad group.
NegativeCampaignCriterion Defines a criterion that you want to exclude from the specified campaign.
NegativeKeyword Defines a negative keyword with match type.
NegativeKeywordList Defines a negative keyword list.
OfflineConversion Defines an offline conversion that you send to Bing Ads.
OfflineConversionGoal Defines an offline conversion goal.
OperationError Defines an error object that contains the details that explain why the service operation failed.
PagesViewedPerVisitGoal Defines a pages viewed per visit conversion goal.
PageVisitorsRule Defines a page visitors remarketing rule.
PageVisitorsWhoDidNotVisitAnotherPageRule Defines a page visitors who did not visit another page remarketing rule.
PageVisitorsWhoVisitedAnotherPageRule Defines a page visitors who visited another page remarketing rule.
Paging Defines a paging object that you can use to request labels and label associations in batches.
PriceAdExtension Defines an ad extension that includes between 3 and 8 price table rows.
PriceTableRow Defines pricing information by currency and unit that you can use with price ad extensions.
ProductAd Defines a product ad.
ProductCondition Defines a condition that determines whether a product is selected from a customer's Bing Merchant Center catalog file.
ProductPartition Defines 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.
ProductScope Defines 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.
RadiusCriterion Defines a criterion that can be used to show ads to users within the radius of a specific geographical location.
RemarketingList Defines a remarketing list.
RemarketingRule Defines the base object of a remarketing rule.
ReviewAdExtension Defines an object that specifies third-party reviews (exact or paraphrased) about your business, products, or services to include in a text ad.
RuleItem Defines the base class of a remarketing list rule item.
RuleItemGroup Defines an object that contains a list of remarketing list rule items that apply to the same visited page.
Schedule Defines the start and end date ranges for ad extension scheduling.
Setting Defines the base class of a setting.
SharedEntity Defines the base class of a shared entity.
SharedEntityAssociation Defines an object that contains association information for a campaign and shared entity such as a negative keyword list.
SharedList Defines the base class of a shared list.
SharedListItem Defines the base class of a shared list item.
ShoppingSetting Defines the campaign level settings for a Bing Shopping Campaign.
SiteLink Defines a site link to include in an ad.
Sitelink2AdExtension Defines an object with one sitelink per ad extension.
SiteLinksAdExtension Defines an object with multiple sitelinks per ad extension.
StringRuleItem Defines a rule expression that depends on the string values of the Url or Referrer Url.
StructuredSnippetAdExtension Defines an object that pairs one header with between 3 and 10 snippet values that tell customers more about your business.
TargetCpaBiddingScheme Defines an object that represents the target CPA bid strategy type.
TextAd Defines a text ad.
UetTag Defines 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.
UrlGoal Defines a URL conversion goal.
Webpage Defines a webpage parameter that contains a list of webpage conditions or criteria that help determine whether you want to show dynamic search ads.
WebpageCondition Defines a condition or criterion that helps determine whether you want to show dynamic search ads.
WebpageParameter Defines the conditions or criteria that determine whether you want to show dynamic search ads.