Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Data Objects
Collapse the table of content
Expand the table of content

Campaign Management Data Objects

System_CLiX_note Note

Version 10 of the Campaign Management service is in preview. The service and documentation are subject to change prior to general availability.

The Campaign Management service defines the following data objects.

Data Object

Description

Ad

Defines the base class of an advertisement.

Address

Defines a postal address.

AdExtension

Defines an object that determines whether text ads in the specified campaign will contain decorative elements, for example the customer's location or phone number.

AdExtensionAssociation

Defines an object that associates an ad extension and its editorial status to a supported entity, for example ad group or campaign.

AdExtensionAssociationCollection

Defines an array of objects that associate an ad extension and its editorial status to a supported entity, for example ad group or campaign.

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.

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 the base class of an ad group criterion.

AdGroupCriterionAction

Defines 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.

AdGroupNegativeKeywords

Defines an object that contains the negative keywords of an ad group.

AdGroupNegativeSites

Defines an object that contains the negative site URLs of an ad group.

AdRotation

Defines an object that specifies an ad rotation type.

AgeTarget

Defines a list of age ranges to target with bid adjustments.

AgeTargetBid

Defines a specific age target range with bid adjustment.

AppAdExtension

Defines an app ad extension that can be included in a text ad.

AppUrl

Defines the operating system platform and URL of the app store download webpage. Used for ad, keyword, sitelink, and ad group criterion final app URLs.

Bid

Defines a bid.

BiddableAdGroupCriterion

Defines the conditions that determine whether product ads in the ad group can be served. If the condition is met, the specified bid is used in the auction.

BMCStore

Defines a Bing Merchant Center store.

CallAdExtension

Defines a call ad extension that can be included in a text ad.

Campaign

Defines a campaign.

CampaignCriterion

Defines the base class of a campaign criterion.

CampaignNegativeKeywords

Defines an object that contains the negative keywords of an ad group.

CampaignNegativeSites

Defines an object that contains the negative site URLs of a campaign.

CityTarget

Defines a list of cities to target with bid adjustments.

CityTargetBid

Defines a specific city target with bid adjustment.

CountryTarget

Defines a list of countries or regions to target with bid adjustments.

CountryTargetBid

Defines a specific country or region target with bid adjustment.

Criterion

Defines the base object of a criterion.

CriterionBid

Defines a base class for criterion bids.

CustomParameter

Defines a key and value custom parameter for URL tracking. Used for campaign, ad group, ad, keyword, sitelink, and ad group criterion URL custom parameters.

CustomParameters

Defines 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.

DayTimeTarget

Defines a list of days of the week and time range to target with bid adjustments.

DayTimeTargetBid

Defines a specific day of the week and time range to target with bid adjustment.

DeviceOSTarget

Defines a list of devices to target with bid adjustments.

DeviceOSTargetBid

Defines a specific device to target with bid adjustment.

Dimension

Defines dimension information for media on a website.

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.

EntityIdToParentIdAssociation

Defines 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.

EntityNegativeKeyword

Defines an object that contains a set of negative keywords and the associated entity such as a campaign.

FixedBid

Defines the monetary bid to use in the auction.

GenderTarget

Defines a list of genders to target with bid adjustments.

GenderTargetBid

Defines a specific gender target with bid adjustment.

GeoPoint

Defines an object that contains the longitude and latitude coordinates of a geographical location.

IdCollection

Defines an object that contains a list of identifiers, for example negative keyword 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.

ImpressionsPerDayRange

Defines the minimum and maximum impressions per day for a website.

Keyword

Defines a keyword.

LocationAdExtension

Defines an ad extension that specifies a business’ address and phone number to include in a text ad.

LocationTarget

Defines an object that can contain different types of geographical targets, for example lists of cities and state targets.

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. The meta data includes download Urls for one or more media representations.

MediaRepresentation

Defines a media representation base class that includes a media download Url.

MediaType

Defines media type information for a website.

MetroAreaTarget

Defines a list of metro area targets with bid adjustments.

MetroAreaTargetBid

Defines a specific metro area target with bid adjustment.

NegativeAdGroupCriterion

Defines a negative ad group criterion that can be used to abstain from bidding on the Bing Shopping products in this ad group. You can still bid on these products in any other ad group in the same campaign, and within ad groups of lower priority campaigns.

NegativeCampaignCriterion

This object is reserved for future use.

NegativeKeyword

Defines a negative keyword with match type.

NegativeKeywordList

Defines a negative keyword list.

NetworkTarget

Defines a list of networks to target with bid adjustments.

NetworkTargetBid

Defines a specific network to target with bid adjustment.

PlacementDetail

Defines the size and type of media that the publisher website supports for ad placements.

PostalCodeTarget

Defines a list of postal code targets with bid adjustments.

PostalCodeTargetBid

Defines a specific postal code target with bid adjustment.

ProductAd

Defines a product ad.

ProductCondition

Defines a condition that determines whether the product is selected.

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.

RadiusTarget

Defines a list of geographical radius targets with bid adjustments.

RadiusTargetBid

Defines a specific geographical radius target with bid adjustment.

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 a shopping setting for a Bing ShoppingCampaign.

SiteLink

Defines a site link to include in an ad.

SiteLinksAdExtension

Defines an ad extension that specifies one or more site links to add to a text ad.

SitePlacement

Defines website-placement bid information.

StateTarget

Defines a list of state targets with bid adjustments.

StateTargetBid

Defines a specific state target with bid adjustment.

Target

Defines demographic categories of targets with optional bid adjustments.

TargetInfo

Defines information about a target in your library.

TextAd

Defines a text ad.

Community Additions

ADD
Show:
© 2015 Microsoft