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.
AccountNegativeKeywordList	Defines a negative keyword list that is associated with an account.
AccountProperty	Maps an account level property name to a string value.
ActionAdExtension	Defines an action ad extension with a call-to-action button.
Ad	Defines the base object of an ad.
AdApiError	Defines a Campaign Management Ad API error object that contains the details that explain why the service operation failed.
AdApiFaultDetail	Defines a Campaign Management Ad API fault detail object that operations return when generic errors occur, such as an authentication error.
Address	Defines a postal address for location ad extensions.
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 in an advertising campaign.
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.
AdRecommendationImageSuggestion	Reserved.
AdRecommendationTextRefineOperation	Reserved.
AdRecommendationTextSuggestion	Reserved.
AdRecommendationVideoSuggestion	Reserved.
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.
AgeDimension	Data object that specifies users by their age.
ApiFaultDetail	Defines a Campaign Management API 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 an ad.
AppInstallAd	Defines an app install ad.
AppInstallGoal	Defines an app install conversion goal.
ApplicationFault	Defines the base object from which all Campaign Management fault detail objects derive.
AppSetting	The app setting data object.
AppUrl	Defines the operating system platform and URL of the app store download webpage.
Asset	Defines the base object of an asset with a unique Microsoft Advertising identifier that can be reused across multiple ads.
AssetGroup	Defines an asset group in an advertising campaign.
AssetGroupEditorialReason	Defines an object that you can use to determine the component of an asset group that failed editorial review, and the reason for the failure.
AssetGroupEditorialReasonCollection	Defines a collection of asset groups that failed editorial review.
AssetGroupListingGroup	A listing group that corresponds directly to the identifiers specified in the request.
AssetGroupListingGroupAction	An object that contains an Action element and a ListingGroup element.
AssetGroupSearchTheme	Defines an AssetGroupSearchTheme data object.
AssetGroupUrlTarget	Reserved.
AssetLink	Defines the relationship of an asset to an ad.
Audience	Defines the base object of an audience.
AudienceCondition	Reserved.
AudienceConditionItem	Reserved.
AudienceCriterion	Defines a criterion that can be used to show ads to a specific audience.
AudienceDimension	An object that inherits AudienceGroupDimension.
AudienceGroup	Defines an AudienceGroup data object.
AudienceGroupAssetGroupAssociation	Defines an AudienceGroupAssetGroupAssociation data object.
AudienceGroupDimension	Defines an AudienceGroupDimension data object.
AudienceInfo	An object containing and ID an type for an audience.
BatchError	Defines a Campaign Management batch 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	The highest price that you want to pay each time someone clicks your ad.
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.
BidStrategy	A portfolio bid strategy is an automated bidding feature that manages bidding across multiple campaigns that are all working toward the same goal.
BMCStore	Defines a Microsoft Merchant Center store.
BrandItem	A data object for the BrandItem.
BrandList	A data object for the BrandList.
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.
CallToActionSetting	Defines the CallToActionSetting data object.
Campaign	Defines a campaign.
CampaignAdGroupIds	Identifies a campaign and the list of its ad groups to import.
CampaignAssociation	Defines a data object for which campaigns to associate to data exclusions and seasonality adjustments.
CampaignConversionGoal	Defines the base object of a campaign conversion goal.
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.
CashbackAdjustment	Defines the CashbackAdjustment Data Object.
CombinationRule	A combination rule includes logical conditions used to determine who to add to your combined list.
CombinedList	A combined list is an audience created from a combination of multiple existing audiences.
CommissionBiddingScheme	Defines an object that represents the commission bid strategy type (commission pay per stay).
Company	Defines the profile data for a company.
ConversionGoal	Defines the base object of a conversion goal.
ConversionGoalRevenue	Defines properties for revenue that can be tracked by a conversion goal.
ConversionValueRule	Reserved.
CoOpSetting	Defines the ad group level settings for feed-based Microsoft Shopping Campaigns.
CostPerSaleBiddingScheme	Defines an object that represents the cost per sale bid strategy type.
Criterion	Defines the base object of a criterion.
CriterionBid	Defines a base class for criterion bids.
CriterionCashback	Defines the CriterionCashback data object.
CustomAudience	Defines a custom audience.
CustomerAccountShare	Defines a customer or account that can use the shared audience or UET tag.
CustomerAccountShareAssociation	Contains the association count for the corresponding usage type.
CustomerList	Defines a CustomerList data object.
CustomerListUserData	Defines a CustomerListUserData data object.
CustomerShare	Defines a shareable audience or UET tag that a customer owns.
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.
DailySummary	Defines a data object for a summary of the offline conversion reports for the day.
DataExclusion	Defines a data object for DataExclusion.
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.
DealCriterion	Defines a criterion that can be used to show ads for a specific deal.
DeviceCondition	Reserved.
DeviceCriterion	Defines a criterion that can be used to show ads on specific devices.
DisclaimerAdExtension	Defines an ad extension that specifies disclaimer text to include in an expanded text ad or responsive search ad.
DisclaimerSetting	Defines the DisclaimerSetting Data Object.
DurationGoal	Defines a duration conversion goal.
DynamicFeedSetting	Defines the DynamicFeedSetting Data Object.
DynamicSearchAd	Defines a dynamic search ad.
DynamicSearchAdsSetting	Defines the Dynamic Search Ads setting for a 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 one of potentially many reasons why an entity failed editorial review.
EditorialErrorCollection	Defines a nested list of error object that identifies one of potentially many reasons why an entity 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.
Experiment	Defines an experiment where you split a campaign's budget and traffic, and then run an A/B test during a limited date range.
FileImportJob	FileImportJob is reserved for future use.
FileImportOption	FileImportOption is reserved for future use.
FilterLinkAdExtension	Filter Link Extensions pair one header with between 3 and 10 clickable text values that tell customers more about your business.
FixedBid	Defines the fixed bid to use in the auction.
FlyerAdExtension	Flyer Extensions enable advertisers to distribute product or store catalogues (flyers) to potential customers.
Frequency	Determines whether an import job should be run once or scheduled on a recurring basis.
FrequencyCapSettings	Defines the FrequencyCapSettings object.
GenderCriterion	Defines a criterion that can be used to show ads to users of a specific gender.
GenderDimension	Defines a GenderDimension data object.
GenreCriterion	Defines a criterion that can be used to show ads from a specific genre.
GeoPoint	Defines an object that contains the longitude and latitude coordinates of a geographical location.
GoogleImportJob	Defines a Google import job that can be run once or scheduled on a recurring basis.
GoogleImportOption	Defines the Google import options that are available via API.
HotelAd	Defines a hotel ad.
HotelAdvanceBookingWindowCriterion	Criterion for the number of days the booking is made prior to the hotel stay.
HotelCheckInDateCriterion	Criterion for a check-in date range.
HotelCheckInDayCriterion	Criterion for day of the week the booking is for.
HotelDateSelectionTypeCriterion	Criterion for the date selection type.
HotelGroup	Defines an object that organizes your hotel ads.
HotelLengthOfStayCriterion	Criterion for length of hotel stay in nights.
HotelListing	Defines a hotel listing.
HotelSetting	Defines whether the ad group will target Hotel Price Ads (HPA) or Property Price Ads (PPA).
IdCollection	Defines an object that contains a list of entity identifiers.
Image	Defines an image 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 an expanded text ad.
ImageAsset	Applies crop settings to stored image media for a specific aspect ratio.
ImageMediaRepresentation	Defines an image media representation with height and width.
ImportEntityStatistics	The statistical import results for an entity type.
ImportJob	Defines the base object of an import job.
ImportOption	Defines the base object of an import option.
ImportResult	Contains the status, run time, and statistical results for an import job that has run.
ImportSearchAndReplaceForStringProperty	Defines the string search and replace Google import option.
ImpressionBasedRemarketingList	Defines a data object for ImpressionBasedRemarketingList.
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.
KeyValuePairOflonglong	The key and value pair of long and long values defined by the Campaign Management service.
KeyValuePairOfstringstring	The key and value pair of string and string values defined by the Campaign Management service.
Keyword	Defines a keyword.
Label	Defines a label object to organize campaigns, ad groups, ads, and keywords into groups.
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.
LocationCondition	Reserved.
LocationConditionItem	Reserved.
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.
LogoAdExtension	Defines an ad extension that specifies a business logo.
ManualCpaBiddingScheme	Defines an object that represents the manual CPA bid strategy type.
ManualCpcBiddingScheme	Defines an object that represents the manual CPC bid strategy type.
ManualCpmBiddingScheme	Defines an object that represents the manual CPM bid strategy type.
ManualCpvBiddingScheme	Defines an object that represents the manual CPV 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.
MaxConversionValueBiddingScheme	Defines an object that represents the maximum conversion value bid strategy type.
MaxRoasBiddingScheme	This object is not in use and will be removed from a future version of the API.
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.
NegativeSite	Defines a website URL where you do not want your ads displayed.
NumberRuleItem	Defines a rule expression that depends on the operand, operator, and value.
OfflineConversion	Defines an offline conversion that you send to Microsoft Advertising.
OfflineConversionAdjustment	Defines an object to retract or restate an offline conversion via the ApplyOfflineConversionAdjustments operation.
OfflineConversionGoal	Defines an offline conversion goal.
OnlineConversionAdjustment	Defines an object to retract or restate an online conversion.
OperationError	Defines a Campaign Management operation error 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 to request Campaign Management objects in batches.
PercentCpcBiddingScheme	Defines an object that represents the percent CPC bid strategy type (total hotel price per night, including taxes and fees).
PerformanceMaxSetting	Defines the PerformanceMaxSetting object.
PlacementCriterion	Defines a data object for PlacementCriterion.
PlacementExclusionList	Defines a website exclusion list in the manager account (customer) shared library.
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.
ProductAudience	Defines a product audience that you can use to remarket products from your Microsoft Merchant Center store.
ProductCondition	Defines a condition that determines whether a product is selected from a customer's Microsoft Merchant Center catalog file.
ProductPartition	Defines an ad group level product partition with one condition that helps determine whether a product from the Microsoft Merchant Center store gets served as a product ad.
ProductScope	Defines a campaign level product scope with list of conditions that help determine which items from your catalog to include in the campaign e.g., filter by brand or condition.
ProfileCriterion	Defines a criterion that can be used to show ads to users in a specific company, industry, or job function.
PromotionAdExtension	Promotion Extensions highlight special sales and offers in your text ads.
RadiusCriterion	Defines a criterion that can be used to show ads to users within the radius of a specific geographical location.
RateAmount	Defines an object that represents the rate amount in percentage form.
RateBid	Defines an object that represents the rate bid.
RemarketingList	Defines a remarketing list.
RemarketingRule	Defines the base object of a remarketing rule.
ResponsiveAd	A responsive ad format for audience ads and multimedia ads.
ResponsiveSearchAd	A responsive ad format for text ads in the Search network.
ResponsiveSearchAdsSetting	Defines the ResponsiveSearchAdsSetting object.
ReviewAdExtension	Defines an object that specifies third-party reviews (exact or paraphrased) about your business, products, or services to include in an expanded 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.
SeasonalityAdjustment	Defines a data object for the seasonality adjustment.
Setting	Defines the base class of a setting.
SharedEntity	Defines the base class of a shared entity.
SharedEntityAssociation	Defines an object that associates a campaign to negative keyword list, or an ad account to a website exclusion 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 to leverage your Microsoft Merchant Center store.
SimilarRemarketingList	Defines an audience that is similar to one of your remarketing lists.
SitelinkAdExtension	Defines an object with one sitelink per ad extension.
StoreCriterion	Defines a criterion to exclude one Microsoft Merchant Center store from your shopping campaign for brands.
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.
TargetImpressionShareBiddingScheme	An automated bidding strategy to get the target impression share for the ad position where you want your ads to appear.
TargetRoasBiddingScheme	Defines an object that represents the target ROAS bid strategy type.
TargetSetting	The target settings that determines whether the Age, Audience, CompanyName, Gender, Industry, and JobFunction criterion type groups use the "target and bid" option or the "bid only" target option.
TargetSettingDetail	Determines whether you want to use the "target and bid" option or the "bid only" target option for the criterion type group.
TextAd	Defines a text ad.
TextAsset	A text asset with a unique Microsoft Advertising identifier that can be reused across multiple ads.
ThirdPartyMeasurementSetting	Reserved.
UetTag	Defines a Universal Event Tracking (UET) tag that you can add to your website to allow Microsoft Advertising to collect actions people take on your website.
UrlGoal	Defines a URL conversion goal.
VanityPharmaSetting	Defines a data object for VanityPharmaSetting.
VerifiedTrackingSetting	Defines the VerifiedTrackingSetting Data Object.
Video	Defines the Video Data Object.
VideoAdExtension	Defines an ad extension with a video and call-to-action button.
VideoAsset	Defines the VideoAsset Data Object.
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.