shapes
type: ShapeGeneration
shape reference chain limit: 5
omitted shape reference count: 1
omitted shape reference:
  reference from: CampaignManagementGetAdExtensionsAssociationsResponseShape
  reference to: CampaignManagementAdExtensionAssociationCollectionShape
  omitted because: over-long

AdInsightAdGroupBidLandscapeShape
type: NodeShape
target class: AdInsightAdGroupBidLandscape
property:
  path: adGroupId
  name: ad group id
  description: The ad group identifier.
  datatype: long
  max count: 1
property:
  path: adGroupBidLandscapeType
  name: ad group bid landscape type
  description: Indicates whether all or a subset of an ad group's existing keywords were used to determine the bid landscape.
  datatype: string
  max count: 1
  in: Uniform
  in: DefaultBidOnly
property:
  path: startDate
  name: start date
  description: The first date used to calculate the bid landscape. The start date is usually seven days prior to the end date. The difference between the start and end dates could be less than seven if performance data is not available, for example with a new ad group.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: The most recent date used to calculate the bid landscape. The end date should be approximately 2 days prior to today's date when the service is called.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: bidLandscapePoints
  name: bid landscape points
  description: The list of the total estimated clicks, cost, and impressions from StartDate to EndDate given the suggested bid.
  node: AdInsightBidLandscapePointShape
  class: AdInsightBidLandscapePoint
  node kind: BlankNodeOrIRI

AdInsightDayMonthAndYearShape
type: NodeShape
target class: AdInsightDayMonthAndYear
property:
  path: day
  name: day
  description: The day of the month.
  datatype: int
  max count: 1
property:
  path: month
  name: month
  description: The month specified as an integer value in the range of 1 through 12, where 1 is January and 12 is December.
  datatype: int
  max count: 1
property:
  path: year
  name: year
  description: The year specified as a four-digit integer value.
  datatype: int
  max count: 1

AdInsightBidLandscapePointShape
type: NodeShape
target class: AdInsightBidLandscapePoint
property:
  path: bid
  name: bid
  description: The suggested bid value.
  datatype: double
  max count: 1
property:
  path: clicks
  name: clicks
  description: The estimated number of clicks. This element will be nil if there is no estimate available.
  datatype: double
  max count: 1
property:
  path: impressions
  name: impressions
  description: The estimated number of impressions.
  datatype: long
  max count: 1
property:
  path: topImpressions
  name: top impressions
  description: The estimated number of impressions in the top or mainline ad results. This element will be nil if there is no estimate available.
  datatype: long
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: The ISO code for the monetary unit of the suggested bid value and estimated performance statistics.
  datatype: string
  max count: 1
  in: AED
  in: ALL
  in: AMD
  in: ARS
  in: AUD
  in: AZM
  in: BGL
  in: BHD
  in: BND
  in: BOB
  in: BRL
  in: BYB
  in: BZD
  in: CAD
  in: CHF
  in: CLP
  in: CNY
  in: COP
  in: CRC
  in: CZK
  in: DOP
  in: DKK
  in: DZD
  in: EEK
  in: EGP
  in: EUR
  in: GBP
  in: GEL
  in: GTQ
  in: HKD
  in: HNL
  in: HRK
  in: HUF
  in: IDR
  in: ILS
  in: INR
  in: IQD
  in: IRR
  in: ISK
  in: JMD
  in: JOD
  in: JPY
  in: KES
  in: KGS
  in: KRW
  in: KWD
  in: KZT
  in: LBP
  in: LTL
  in: LVL
  in: LYD
  in: MAD
  in: MKD
  in: MOP
  in: MNT
  in: MVR
  in: MXN
  in: MYR
  in: NIO
  in: NOK
  in: NZD
  in: OMR
  in: PAB
  in: PEN
  in: PHP
  in: PKR
  in: PLN
  in: PYG
  in: QAR
  in: ROL
  in: RUR
  in: SAR
  in: SEK
  in: SGD
  in: SIT
property:
  path: cost
  name: cost
  description: The estimated cost. This element will be nil if there is no estimate available.
  datatype: double
  max count: 1
property:
  path: marginalCPC
  name: marginal cpc
  description: Reserved for future use.
  datatype: double
  max count: 1

AdInsightAdGroupBidLandscapeInputShape
type: NodeShape
target class: AdInsightAdGroupBidLandscapeInput
property:
  path: adGroupId
  name: ad group id
  description: The ad group identifier.
  datatype: long
  max count: 1
property:
  path: adGroupBidLandscapeType
  name: ad group bid landscape type
  description: Determines whether all or a subset of an ad group's existing keywords should be used to determine the bid landscape. If not specified in a request, the default value is Uniform.
  datatype: string
  max count: 1
  in: Uniform
  in: DefaultBidOnly

AdInsightAdGroupEstimateShape
type: NodeShape
target class: AdInsightAdGroupEstimate
property:
  path: adGroupId
  name: ad group id
  description: The ad group identifier.
  datatype: long
  max count: 1
property:
  path: keywordEstimates
  name: keyword estimates
  description: The list of suggested keywords with minimum and maximum traffic estimates. Traffic estimates include average CPC, average position, clicks, CTR, impressions, and total cost.
  node: AdInsightKeywordEstimateShape
  class: AdInsightKeywordEstimate
  node kind: BlankNodeOrIRI

AdInsightKeywordEstimateShape
type: NodeShape
target class: AdInsightKeywordEstimate
property:
  path: keyword
  name: keyword
  description: The suggested keyword.
  node: AdInsightKeywordShape
  class: AdInsightKeyword
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: minimum
  name: minimum
  description: The minimum traffic estimate. Traffic estimates include average CPC, average position, clicks, CTR, impressions, and total cost.
  node: AdInsightTrafficEstimateShape
  class: AdInsightTrafficEstimate
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: maximum
  name: maximum
  description: The maximum traffic estimate. Traffic estimates include average CPC, average position, clicks, CTR, impressions, and total cost.
  node: AdInsightTrafficEstimateShape
  class: AdInsightTrafficEstimate
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightKeywordShape
type: NodeShape
target class: AdInsightKeyword
property:
  path: id
  name: id
  description: The Microsoft Advertising identifier of the keyword.
  datatype: long
  max count: 1
property:
  path: text
  name: text
  description: The keyword text.
  datatype: string
  max count: 1
property:
  path: matchType
  name: match type
  description: The match type of the keyword.
  datatype: string
  max count: 1
  in: Exact
  in: Phrase
  in: Broad
  in: Aggregate

AdInsightTrafficEstimateShape
type: NodeShape
target class: AdInsightTrafficEstimate
property:
  path: impressions
  name: impressions
  description: The estimated number of impressions per week.
  datatype: double
  max count: 1
property:
  path: clicks
  name: clicks
  description: The estimated number of clicks per week.
  datatype: double
  max count: 1
property:
  path: totalCost
  name: total cost
  description: The estimated total cost per week.
  datatype: double
  max count: 1
property:
  path: ctr
  name: ctr
  description: The estimated CTR. The formula used to calculate the CTR is (clicks / impressions) * 100.
  datatype: double
  max count: 1
property:
  path: averageCpc
  name: average cpc
  description: The estimated average CPC. The formula used to calculate the average CPC is (total cost / clicks).
  datatype: double
  max count: 1
property:
  path: averagePosition
  name: average position
  description: The estimated average position on the web page for ads that were delivered. Average position is deprecated and from March 31st, 2021 onwards this value is "0" (zero).
  datatype: double
  max count: 1

AdInsightAdGroupEstimatorShape
type: NodeShape
target class: AdInsightAdGroupEstimator
property:
  path: adGroupId
  name: ad group id
  description: The ad group identifier. This element is reserved for future use. The returned estimates are not based on any specific ad group.
  datatype: long
  max count: 1
property:
  path: maxCpc
  name: max cpc
  description: The maximum cost per click filter criteria for all keyword estimates in the ad group. You can override this setting for specific keywords with the corresponding keyword estimators.
  datatype: double
  max count: 1
property:
  path: keywordEstimators
  name: keyword estimators
  description: The list of keyword estimators with your keyword level filter criteria for traffic estimates.
  node: AdInsightKeywordEstimatorShape
  class: AdInsightKeywordEstimator
  node kind: BlankNodeOrIRI

AdInsightKeywordEstimatorShape
type: NodeShape
target class: AdInsightKeywordEstimator
property:
  path: keyword
  name: keyword
  description: The keyword used for traffic estimates. You can request estimates for Phrase and Broad match types.
  node: AdInsightKeywordShape
  class: AdInsightKeyword
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: maxCpc
  name: max cpc
  description: The maximum cost per click filter criteria for the keyword. You can set the default maximum CPC for all of the ad group's keywords using the MaxCpc element of the AdGroupEstimator object. Use the keyword estimator if you want to override the max CPC for a specific keyword.
  datatype: double
  max count: 1

AdInsightApiFaultDetailShape
type: NodeShape
target class: AdInsightApiFaultDetail
property:
  path: trackingId
  name: tracking id
  description: The identifier of the log entry that contains the details of the API call.
  datatype: string
  max count: 1
property:
  path: operationErrors
  name: operation errors
  description: An array of operation errors that contains the reasons that explain why the service operation failed when the error is not related to a specific item in the batch of items.
  node: AdInsightOperationErrorShape
  class: AdInsightOperationError
  node kind: BlankNodeOrIRI
property:
  path: batchErrors
  name: batch errors
  description: An array of batch errors that identifies the items in the batch of items in the request message that caused the operation to fail. Each object contains the details that explain why the item caused the failure.
  node: AdInsightBatchErrorShape
  class: AdInsightBatchError
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightOperationErrorShape
type: NodeShape
target class: AdInsightOperationError
property:
  path: code
  name: code
  description: A numeric error code that identifies the error.
  datatype: int
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error. For example, UserIsNotAuthorized.
  datatype: string
  max count: 1
property:
  path: details
  name: details
  description: A message that provides additional details about the error. This string can be empty.
  datatype: string
  max count: 1
property:
  path: message
  name: message
  description: A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.
  datatype: string
  max count: 1

AdInsightBatchErrorShape
type: NodeShape
target class: AdInsightBatchError
property:
  path: code
  name: code
  description: A numeric error code that identifies the error.
  datatype: int
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error. For example, UserIsNotAuthorized.
  datatype: string
  max count: 1
property:
  path: details
  name: details
  description: A message that provides additional details about the batch error. This string can be empty.
  datatype: string
  max count: 1
property:
  path: index
  name: index
  description: The zero-based index of the item in the batch of items in the request message that failed.
  datatype: int
  max count: 1
property:
  path: message
  name: message
  description: A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.
  datatype: string
  max count: 1

AdInsightApplicationFaultShape
type: NodeShape
target class: AdInsightApplicationFault
property:
  path: trackingId
  name: tracking id
  description: The identifier of the log entry that contains the details of the API call.
  datatype: string
  max count: 1
property:
  path: operationErrors
  name: operation errors
  node: AdInsightOperationErrorShape
  class: AdInsightOperationError
  node kind: BlankNodeOrIRI
property:
  path: batchErrors
  name: batch errors
  node: AdInsightBatchErrorShape
  class: AdInsightBatchError
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightApplicationFaultBaseShape
type: NodeShape
target class: AdInsightApplicationFaultBase
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1

AdInsightApplyRecommendationEntityShape
type: NodeShape
target class: AdInsightApplyRecommendationEntity
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation. Required.
  datatype: string
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation: ADD_BROAD_MATCH_KEYWORD, CAMPAIGN_BUDGET, KEYWORD, REMOVE_CONFLICTING_NEGATIVE_KEYWORD, RESPONSIVE_SEARCH_AD, or RESPONSIVE_SEARCH_AD_ASSET. Required.
  datatype: string
  max count: 1

AdInsightApplyRecommendationsRequestShape
type: NodeShape
target class: AdInsightApplyRecommendationsRequest
property:
  path: entities
  name: entities
  description: The list of operations to apply recommendations. There is a limit of 100 operations per request. Required.
  node: AdInsightApplyRecommendationEntityShape
  class: AdInsightApplyRecommendationEntity
  node kind: BlankNodeOrIRI

AdInsightApplyRecommendationsResponseShape
type: NodeShape
target class: AdInsightApplyRecommendationsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  node: AdInsightBatchErrorShape
  class: AdInsightBatchError
  node kind: BlankNodeOrIRI

AdInsightAuctionInsightEntryShape
type: NodeShape
target class: AdInsightAuctionInsightEntry
property:
  path: displayDomain
  name: display domain
  description: The display URL of another advertiser who participates in the same auctions as you. The competing websites listed in your auction insights data are those who enter the same auctions as you, and are eligible for the same impressions that you are. Competitors aren't necessarily determined on how similar their keywords, match types, or other targeting settings are to your own, and auction insights doesn't provide a full report on these metrics for other advertisers.
  datatype: string
  max count: 1
property:
  path: aggregatedKpi
  name: aggregated kpi
  description: The auction insight key performance indicators across all segments for the display domain. The aggregated data is available whether or not you also requested SegmentedKpis.
  node: AdInsightAuctionInsightKpiShape
  class: AdInsightAuctionInsightKpi
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: segmentedKpis
  name: segmented kpis
  description: The list of auction insight key performance indicators for each unique combination of the requested segments. The segmented data is only available when you include an AuctionSegmentSearchParameter object in the GetAuctionInsightData request.
  node: AdInsightAuctionInsightKpiShape
  class: AdInsightAuctionInsightKpi
  node kind: BlankNodeOrIRI

AdInsightAuctionInsightKpiShape
type: NodeShape
target class: AdInsightAuctionInsightKpi
property:
  path: segments
  name: segments
  description: The list of strings identifies a distinct combination of requested segments. The list of segment values is in the same order as the AuctionSegment value set i.e., Day, Week, Month, Quarter, DayOfWeek, and then Device. For example if you requested the Day, Device, and Quarter segments for May 1, 2018, this element will contain a list of three strings in the following order: 5/1/2018 (Day), 4/1/2018 (Quarter), and PC (Device). This element is only applicable for the SegmentedKpis of an AuctionInsightEntry. This element is nil and not applicable for the AggregatedKpi of an AuctionInsightEntry.
  datatype: string
property:
  path: impressionShare
  name: impression share
  description: The number of times an ad is shown on the Microsoft Advertising Network divided by the total available impressions. Use this to compare your share of impressions to the impression share of advertisers competing against you.
  datatype: double
  max count: 1
property:
  path: overlapRate
  name: overlap rate
  description: The percentage of time competitors' ads showed up on the search results page when your ad was shown. If the rate is high then this advertiser is a competitor since their ads shows up on the same search results page as yours.
  datatype: double
  max count: 1
property:
  path: averagePosition
  name: average position
  description: The average position on the web page for ads that were delivered. Although it varies, positions 1-4 appear at the top of the search results page and positions 5-10 appear in other locations (for example, the bottom or the sidebar). Use this to compare your ad position with the average rank of all ads in the auction. Average position is deprecated and from March 31st, 2021 onwards this value is "0" (zero).
  datatype: double
  max count: 1
property:
  path: aboveRate
  name: above rate
  description: The percentage of time competitors' ads showed up higher than your ads on the search results page. If the rate is high then the other advertiser is getting more desirable ad positions than you. A high rate is likely due to a poor quality score or a low bid.
  datatype: double
  max count: 1
property:
  path: topOfPageRate
  name: top of page rate
  description: The percentage of time your ad showed up in the mainline, the premium ad position above the organic search results. Ads at the top of the page tend to receive more clicks.
  datatype: double
  max count: 1
property:
  path: outrankingShare
  name: outranking share
  description: The percentage of time your ad showed up higher on the search results pages than your competitors or your ad showed when theirs did not. If the rate is high, you are getting a more desirable ad position than other advertisers.
  datatype: double
  max count: 1
property:
  path: absoluteTopOfPageRate
  name: absolute top of page rate
  description: The number of times an ad is shown as the very first ad above the organic search results, divided by the total number of impressions it actually received. Ads at the absolute top of the page tend to receive more clicks. This element is not returned by default. To get this element, include the AbsoluteTopOfPageRate value in the ReturnAdditionalFields element when you call the GetAuctionInsightData service operation.
  datatype: double
  max count: 1

AdInsightAuctionInsightResultShape
type: NodeShape
target class: AdInsightAuctionInsightResult
property:
  path: segments
  name: segments
  description: The segments if any were specified via one or more AuctionSegmentSearchParameter in the GetAuctionInsightData request. The list of auction segments is in the same order as the AuctionSegment value set i.e., Day, Week, Month, Quarter, DayOfWeek, and then Device. For example if you requested the Day, Device, and Quarter segments for May 1, 2018, this element will contain a list of three auction segments in the following order: Day, Quarter, and Device.
  datatype: string
  in: Day
  in: Week
  in: Month
  in: Quarter
  in: DayOfWeek
  in: Device
property:
  path: entries
  name: entries
  description: One or more auction insight entries i.e., one result per domain that you competed with in the auction.
  node: AdInsightAuctionInsightEntryShape
  class: AdInsightAuctionInsightEntry
  node kind: BlankNodeOrIRI
property:
  path: usedImpressions
  name: used impressions
  description: The percent of impressions that were used to generate the auction insight entries. The value can range from 0 to 1.0, for example 0.8 indicates that 80 percent of impressions were used.
  datatype: double
  max count: 1
property:
  path: usedKeywords
  name: used keywords
  description: The number of keywords that were used to generate the auction insight entries.
  datatype: double
  max count: 1

AdInsightAuctionSegmentSearchParameterShape
type: NodeShape
target class: AdInsightAuctionSegmentSearchParameter
property:
  path: segment
  name: segment
  description: Determines how you want the SegmentedKpis data segmented in the result from the GetAuctionInsightData operation. You can request auction insight data segmented by Day, DayOfWeek, Device, Month, Quarter, and Week.
  datatype: string
  max count: 1
  in: Day
  in: Week
  in: Month
  in: Quarter
  in: DayOfWeek
  in: Device
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightAutoApplyRecommendationsInfoShape
type: NodeShape
target class: AdInsightAutoApplyRecommendationsInfo
property:
  path: recommendationType
  name: recommendation type
  description: Supported recommendation types in auto-apply mode. We will keep the list updated once new recommendations support auto-apply.Add responsive search ads Add multimedia ads Remove conflicting negative keywords Fix conversion goal setting issue Create conversion goalTo set the auto-apply opt-in status to the supported recommendation types above, please use the following keys as below: ResponsiveSearchAdsOpportunity MultiMediaAdsOpportunity RemoveConflictingNegativeKeywordOpportunity FixConversionGoalSettingsOpportunity CreateConversionGoalOpportunity .
  datatype: string
  max count: 1
property:
  path: aAROptInStatus
  name: a aropt in status
  description: True for opt-in, False for opt-out.
  datatype: boolean
  max count: 1

AdInsightBidOpportunityShape
type: NodeShape
target class: AdInsightBidOpportunity
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign for the ad group that owns the keyword.
  datatype: long
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group that owns the keyword.
  datatype: long
  max count: 1
property:
  path: keywordId
  name: keyword id
  description: The identifier of the keyword to which the bid opportunity applies.
  datatype: long
  max count: 1
property:
  path: currentBid
  name: current bid
  description: The current keyword bid amount specified for the match type in the MatchType element.
  datatype: double
  max count: 1
property:
  path: matchType
  name: match type
  description: The match type to which the suggested bid value applies. The possible values are BroadMatch, ExactMatch, and PhraseMatch.
  datatype: string
  max count: 1
property:
  path: suggestedBid
  name: suggested bid
  description: The suggested bid based on the last 7 days of performance history for the corresponding ad group.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested bid.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: The estimated clicks opportunities corresponding to the suggested bid.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: The estimated increase in spend corresponding to the suggested bid.
  datatype: double
  max count: 1
property:
  path: opportunityKey
  name: opportunity key
  description: An identifier that uniquely identifies the opportunity.
  datatype: string
  max count: 1

AdInsightBreakdownShape
type: NodeShape
target class: AdInsightBreakdown
property:
  path: keys
  name: keys
  description: The audience breakdown keys.
  datatype: string
property:
  path: values
  name: values
  description: The audience breakdown values.
  datatype: int
property:
  path: globalValues
  name: global values
  description: The audiance breakdown global values.
  datatype: int

AdInsightBreakdownsShape
type: NodeShape
target class: AdInsightBreakdowns
property:
  path: age
  name: age
  description: The audience breakdown category is Age.
  node: AdInsightBreakdownShape
  class: AdInsightBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: device
  name: device
  description: The audience breakdown category is Device.
  node: AdInsightBreakdownShape
  class: AdInsightBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: gender
  name: gender
  description: The audience breakdown category is Gender.
  node: AdInsightBreakdownShape
  class: AdInsightBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: inMarket
  name: in market
  description: The audience breakdown category is InMarket.
  node: AdInsightBreakdownShape
  class: AdInsightBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: industry
  name: industry
  description: The audience breakdown category is Industry.
  node: AdInsightBreakdownShape
  class: AdInsightBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: jobFunction
  name: job function
  description: The audience breakdown category is JobFunction.
  node: AdInsightBreakdownShape
  class: AdInsightBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: locationCountry
  name: location country
  description: The audience breakdown category is LocationCountry.
  node: AdInsightLocationBreakdownShape
  class: AdInsightLocationBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: location
  name: location
  description: The audience breakdown category is Location.
  node: AdInsightLocationBreakdownShape
  class: AdInsightLocationBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: locationSubGeography
  name: location sub geography
  description: The audience breakdown category is LocationSubGeography.
  node: AdInsightLocationBreakdownShape
  class: AdInsightLocationBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: locationMetroArea
  name: location metro area
  description: The audience breakdown category is LocationMetroArea.
  node: AdInsightLocationBreakdownShape
  class: AdInsightLocationBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: locationCity
  name: location city
  description: The audience breakdown category is LocationCity.
  node: AdInsightLocationBreakdownShape
  class: AdInsightLocationBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: locationPostalCode
  name: location postal code
  description: The audience breakdown category is LocationPostalCode.
  node: AdInsightLocationBreakdownShape
  class: AdInsightLocationBreakdown
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: locationCounty
  name: location county
  description: The audience breakdown category is LocationCounty.
  node: AdInsightLocationBreakdownShape
  class: AdInsightLocationBreakdown
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightLocationBreakdownShape
type: NodeShape
target class: AdInsightLocationBreakdown
property:
  path: info
  name: info
  description: The location information about a location breakdown.
  node: AdInsightLocationInfoShape
  class: AdInsightLocationInfo
  node kind: BlankNodeOrIRI
property:
  path: keys
  name: keys
  description: A list of location breakdown keys.
  datatype: string
property:
  path: values
  name: values
  description: A list of location breakdown values.
  datatype: int
property:
  path: globalValues
  name: global values
  description: A list of location breakdown global values.
  datatype: int

AdInsightLocationInfoShape
type: NodeShape
target class: AdInsightLocationInfo
property:
  path: name
  name: name
  description: The name of the location breakdown.
  datatype: string
  max count: 1

AdInsightBroadMatchKeywordOpportunityShape
type: NodeShape
target class: AdInsightBroadMatchKeywordOpportunity
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group to apply the suggested keyword to.
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign that owns the ad group.
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  description: The name of the ad group to apply the suggested keyword to.
  datatype: string
  max count: 1
property:
  path: campaignName
  name: campaign name
  description: The name of the campaign that owns the ad group.
  datatype: string
  max count: 1
property:
  path: matchType
  name: match type
  description: The match type that the suggested bid applies to. The following are the possible match-type values: 1 - Exact match 2 - Phrase match 3 - Broad match
  datatype: int
  max count: 1
property:
  path: suggestedKeyword
  name: suggested keyword
  description: The suggested keyword.
  datatype: string
  max count: 1
property:
  path: suggestedBid
  name: suggested bid
  description: The suggested bid that may result in your ads serving on the first page of the search query results.
  datatype: double
  max count: 1
property:
  path: monthlySearches
  name: monthly searches
  description: The estimated monthly volume of user search queries that may match the suggested keyword for the corresponding MatchType element.
  datatype: long
  max count: 1
property:
  path: competition
  name: competition
  description: An indicator of competitive bids for this keyword relative to all search keywords. The competition score ranges from 0 to 1.00, where 0 indicates low competition and 1.00 indicates that there is a high number of advertisers competing for this keyword.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: Estimated increase in clicks if the opportunity is applied.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: Estimated increase in cost if the opportunity is applied.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: Estimated increase in impressions if the opportunity is applied.
  datatype: long
  max count: 1
property:
  path: opportunityKey
  name: opportunity key
  description: An identifier that uniquely identifies the opportunity.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: clickShare
  name: click share
  description: Broad match click share in the marketplace.
  datatype: double
  max count: 1
property:
  path: averageCTR
  name: average ctr
  description: Broad match average CTR in the marketplace.
  datatype: double
  max count: 1
property:
  path: averageCPC
  name: average cpc
  description: Broad match average CPC in the marketplace.
  datatype: double
  max count: 1
property:
  path: referenceKeywordId
  name: reference keyword id
  description: The identifier of an existing reference keyword used by the service to offer the keyword opportunity.
  datatype: long
  max count: 1
property:
  path: referenceKeywordBid
  name: reference keyword bid
  description: The bid of an existing reference keyword used by the service to offer the keyword opportunity.
  datatype: double
  max count: 1
property:
  path: referenceKeywordMatchType
  name: reference keyword match type
  description: The match type of an existing reference keyword used by the service to offer the keyword opportunity. The following are the possible match-type values: 1 - Exact match 2 - Phrase match
  datatype: int
  max count: 1
property:
  path: impressionShare
  name: impression share
  description: Broad match impression share in the marketplace.
  datatype: double
  max count: 1
property:
  path: searchQueryKPIs
  name: search query kpis
  description: A list of up to three broad match search query KPI objects. Each item contains search query statistics of including broad match type keyword bids
  node: AdInsightBroadMatchSearchQueryKPIShape
  class: AdInsightBroadMatchSearchQueryKPI
  node kind: BlankNodeOrIRI

AdInsightBroadMatchSearchQueryKPIShape
type: NodeShape
target class: AdInsightBroadMatchSearchQueryKPI
property:
  path: searchQuery
  name: search query
  description: The search query corresponding to the keyword.
  datatype: string
  max count: 1
property:
  path: impressions
  name: impressions
  description: The impressions for the search query.
  datatype: long
  max count: 1
property:
  path: clicks
  name: clicks
  description: The clicks for the search query.
  datatype: double
  max count: 1
property:
  path: sRPV
  name: s rpv
  description: The SRPV for the search query.
  datatype: long
  max count: 1
property:
  path: averageCTR
  name: average ctr
  description: The average CTR for the search query.
  datatype: double
  max count: 1

AdInsightBudgetOpportunityShape
type: NodeShape
target class: AdInsightBudgetOpportunity
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign to which the suggested budget applies.
  datatype: long
  max count: 1
property:
  path: currentBudget
  name: current budget
  description: The campaign's current budget.
  datatype: double
  max count: 1
property:
  path: recommendedBudget
  name: recommended budget
  description: The suggested budget based on the last 15 days of performance history for the corresponding campaign.
  datatype: double
  max count: 1
property:
  path: budgetType
  name: budget type
  description: The type of budget that the campaign uses.
  datatype: string
  max count: 1
  in: DailyBudgetStandard
  in: DailyBudgetAccelerated
property:
  path: increaseInImpressions
  name: increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested budget.
  datatype: long
  max count: 1
property:
  path: percentageIncreaseInImpressions
  name: percentage increase in impressions
  description: The estimated percentage increase in impressions corresponding to the suggested budget.
  datatype: int
  max count: 1
property:
  path: increaseInClicks
  name: increase in clicks
  description: The estimated clicks opportunities corresponding to the suggested budget.
  datatype: double
  max count: 1
property:
  path: percentageIncreaseInClicks
  name: percentage increase in clicks
  description: The estimated percentage increase in clicks corresponding to the suggested budget.
  datatype: int
  max count: 1
property:
  path: budgetPoints
  name: budget points
  description: The list of budget points with weekly impressions, clicks and cost estimates for the given budget amount.
  node: AdInsightBudgetPointShape
  class: AdInsightBudgetPoint
  node kind: BlankNodeOrIRI
property:
  path: opportunityKey
  name: opportunity key
  description: An identifier that uniquely identifies the opportunity.
  datatype: string
  max count: 1

AdInsightBudgetPointShape
type: NodeShape
target class: AdInsightBudgetPoint
property:
  path: budgetAmount
  name: budget amount
  description: A potential new budget. This budget amount is your current campaign budget if the BudgetPointType value is Current.
  datatype: double
  max count: 1
property:
  path: budgetPointType
  name: budget point type
  description: The type of budget relative to a list of budget points. For example, if the budget point type is Current then this object's BudgetAmount element would be equal to the corresponding campaign's daily budget.
  datatype: string
  max count: 1
  in: Current
  in: Suggested
  in: Maximum
  in: Other
property:
  path: estimatedWeeklyClicks
  name: estimated weekly clicks
  description: The estimated weekly clicks for the given budget amount.
  datatype: double
  max count: 1
property:
  path: estimatedWeeklyCost
  name: estimated weekly cost
  description: The estimated weekly cost for the given budget amount.
  datatype: double
  max count: 1
property:
  path: estimatedWeeklyImpressions
  name: estimated weekly impressions
  description: The estimated weekly impressions for the given budget amount.
  datatype: double
  max count: 1

AdInsightCampaignBidLandscapeShape
type: NodeShape
target class: AdInsightCampaignBidLandscape
property:
  path: campaignId
  name: campaign id
  description: The campaign identifier.
  datatype: long
  max count: 1
property:
  path: campaignBidLandscapeType
  name: campaign bid landscape type
  description: Indicates the campaign bid strategy and landscape type.
  datatype: string
  max count: 1
  in: Ecpc_CampaignWideBid
  in: Ecpc_BidScaling
  in: TargetCpa
  in: TargetRoas
property:
  path: startDate
  name: start date
  description: The first date used to calculate the bid landscape. The start date is usually seven days prior to the end date. The difference between the start and end dates might be less than seven if performance data is not available, e.g., the campaign is new.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: The most recent date used to calculate the bid landscape. The end date should be set to approximately two days before the current date when CampaignBidLandscape is called.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: campaignBidLandscapePoints
  name: campaign bid landscape points
  description: A list of CampaignBidLandscapePoint objects with the total estimated performance from StartDate to EndDate by the bid or target.
  node: AdInsightCampaignBidLandscapePointShape
  class: AdInsightCampaignBidLandscapePoint
  node kind: BlankNodeOrIRI

AdInsightCampaignBidLandscapePointShape
type: NodeShape
target class: AdInsightCampaignBidLandscapePoint
property:
  path: bid
  name: bid
  description: The suggested bid value.
  datatype: double
  max count: 1
property:
  path: targetCpa
  name: target cpa
  description: The CampaignBidLandscapeType is TargetCpa. This element will be nil if the CampaignBidLandscapeType isn't TargetCpa.
  datatype: double
  max count: 1
property:
  path: targetRoas
  name: target roas
  description: The CampaignBidLandscapeType is TargetRoas. This element will be nil if the CampaignBidLandscapeType isn't TargetRoas.
  datatype: double
  max count: 1
property:
  path: clicks
  name: clicks
  description: The estimated number of clicks. This element will be nil if there is no estimate available.
  datatype: double
  max count: 1
property:
  path: impressions
  name: impressions
  description: The estimated number of impressions.
  datatype: long
  max count: 1
property:
  path: topImpressions
  name: top impressions
  description: The estimated number of impressions in the top or mainline ad results. This element will be nil if there is no estimate available.
  datatype: long
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: The ISO code for the monetary unit of the suggested bid value and estimated performance statistics.
  datatype: string
  max count: 1
  in: AED
  in: ALL
  in: AMD
  in: ARS
  in: AUD
  in: AZM
  in: BGL
  in: BHD
  in: BND
  in: BOB
  in: BRL
  in: BYB
  in: BZD
  in: CAD
  in: CHF
  in: CLP
  in: CNY
  in: COP
  in: CRC
  in: CZK
  in: DOP
  in: DKK
  in: DZD
  in: EEK
  in: EGP
  in: EUR
  in: GBP
  in: GEL
  in: GTQ
  in: HKD
  in: HNL
  in: HRK
  in: HUF
  in: IDR
  in: ILS
  in: INR
  in: IQD
  in: IRR
  in: ISK
  in: JMD
  in: JOD
  in: JPY
  in: KES
  in: KGS
  in: KRW
  in: KWD
  in: KZT
  in: LBP
  in: LTL
  in: LVL
  in: LYD
  in: MAD
  in: MKD
  in: MOP
  in: MNT
  in: MVR
  in: MXN
  in: MYR
  in: NIO
  in: NOK
  in: NZD
  in: OMR
  in: PAB
  in: PEN
  in: PHP
  in: PKR
  in: PLN
  in: PYG
  in: QAR
  in: ROL
  in: RUR
  in: SAR
  in: SEK
  in: SGD
  in: SIT
property:
  path: cost
  name: cost
  description: The estimated cost. This element will be nil if there is no estimate available.
  datatype: double
  max count: 1
property:
  path: conversions
  name: conversions
  description: The estimated number of conversions. This element will be nil if there is no estimate available.
  datatype: double
  max count: 1
property:
  path: conversionValues
  name: conversion values
  description: The estimated conversion values. This element will be nil if there is no estimate available.
  datatype: double
  max count: 1
property:
  path: marginalCPC
  name: marginal cpc
  description: The CampaignBidLandscapeType is MarginalCpc. This element will be nil if the CampaignBidLandscapeType isn't MarginalCpc.
  datatype: double
  max count: 1

AdInsightCampaignBudgetRecommendationShape
type: NodeShape
target class: AdInsightCampaignBudgetRecommendation
property:
  path: accountId
  name: account id
  description: The identifier of the account. Output only.
  datatype: long
  max count: 1
property:
  path: accountName
  name: account name
  description: The name of the account. Output only.
  datatype: string
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The campaign ID targeted by this recommendation. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD
  datatype: long
  max count: 1
property:
  path: campaignName
  name: campaign name
  description: The name of the campaign. Output only.
  datatype: string
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The ad group ID targeted by this recommendation. This will be set only when the recommendation affects a single ad group. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD.
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  description: The name of the ad group. Output only.
  datatype: string
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation. Note: We currently support CAMPAIGN_BUDGET, KEYWORD, and RESPONSIVE_SEARCH_AD. RecommendationType is output only.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The RecommendationType value set has the following values: CampaignBudgetRecommendation, KeywordRecommendation, ResponsiveSearchAdRecommendation.
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation.
  datatype: string
  max count: 1
property:
  path: currentClicks
  name: current clicks
  description: Actual clicks of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: The estimated click opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentCost
  name: current cost
  description: Actual spending of the ad group in the past 7 days, in the currency of this account.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: The estimated increase in spend corresponding to the suggested ad.
  datatype: double
  max count: 1
property:
  path: currentImpressions
  name: current impressions
  description: Actual impressions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentConversions
  name: current conversions
  description: Actual conversions of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInConversions
  name: estimated increase in conversions
  description: The estimated impression opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: dismissed
  name: dismissed
  description: Whether the recommendation is dismissed or not. Output only.
  datatype: boolean
  max count: 1
property:
  path: recommendedBudget
  name: recommended budget
  description: The recommended budget amount based on the last 15 days of performance history for the corresponding campaign. Output only.
  datatype: double
  max count: 1
property:
  path: currentBudget
  name: current budget
  description: The current budget amount. Output only.
  datatype: double
  max count: 1
property:
  path: budgetPoints
  name: budget points
  description: The list of budget points with weekly impressions, clicks and cost estimates for the given budget amount. Output only.
  node: AdInsightBudgetPointShape
  class: AdInsightBudgetPoint
  node kind: BlankNodeOrIRI
property:
  path: budgetType
  name: budget type
  description: The type of budget that the campaign uses. Output only.
  datatype: string
  max count: 1
  in: DailyBudgetStandard
  in: DailyBudgetAccelerated

AdInsightCampaignEstimateShape
type: NodeShape
target class: AdInsightCampaignEstimate
property:
  path: campaignId
  name: campaign id
  description: The ad group identifier.
  datatype: long
  max count: 1
property:
  path: adGroupEstimates
  name: ad group estimates
  description: The nested list of suggested keywords for the campaign's ad groups with minimum and maximum traffic estimates. Traffic estimates include average CPC, average position, clicks, CTR, impressions, and total cost.
  node: AdInsightAdGroupEstimateShape
  class: AdInsightAdGroupEstimate
  node kind: BlankNodeOrIRI

AdInsightCampaignEstimatorShape
type: NodeShape
target class: AdInsightCampaignEstimator
property:
  path: campaignId
  name: campaign id
  description: The campaign identifier. This element is reserved for future use. The returned estimates are not based on any specific campaign.
  datatype: long
  max count: 1
property:
  path: dailyBudget
  name: daily budget
  description: The daily budget filter criteria for all keyword traffic estimates in the campaign.
  datatype: double
  max count: 1
property:
  path: criteria
  name: criteria
  description: The list of campaign level criteria for traffic estimates. Do not try to instantiate a Criterion. You can include one or more the following objects that derive from it: DeviceCriterion, LanguageCriterion, LocationCriterion, and NetworkCriterion. The location, language, and network criterions are required for traffic estimates.
  or:
    node: AdInsightCriterionShape
    class: AdInsightCriterion
  or:
    node: AdInsightDeviceCriterionShape
    class: AdInsightDeviceCriterion
  or:
    node: AdInsightLanguageCriterionShape
    class: AdInsightLanguageCriterion
  or:
    node: AdInsightLocationCriterionShape
    class: AdInsightLocationCriterion
  or:
    node: AdInsightNetworkCriterionShape
    class: AdInsightNetworkCriterion
  node kind: BlankNodeOrIRI
property:
  path: adGroupEstimators
  name: ad group estimators
  description: The list of ad group estimators with your ad group and keyword level filter criteria for traffic estimates.
  node: AdInsightAdGroupEstimatorShape
  class: AdInsightAdGroupEstimator
  node kind: BlankNodeOrIRI
property:
  path: negativeKeywords
  name: negative keywords
  description: The list of negative keyword filter criteria for all keyword traffic estimates in the campaign.
  node: AdInsightNegativeKeywordShape
  class: AdInsightNegativeKeyword
  node kind: BlankNodeOrIRI

AdInsightCriterionShape
type: NodeShape
target class: AdInsightCriterion
property:
  path: locationId
  name: location id
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: language
  name: language
  datatype: string
  max count: 1
property:
  path: network
  name: network
  datatype: string
  max count: 1
  in: OwnedAndOperatedAndSyndicatedSearch
  in: OwnedAndOperatedOnly
  in: SyndicatedSearchOnly
property:
  path: deviceName
  name: device name
  datatype: string
  max count: 1

AdInsightNegativeKeywordShape
type: NodeShape
target class: AdInsightNegativeKeyword
property:
  path: id
  name: id
  description: The Microsoft Advertising identifier of the negative keyword.
  datatype: long
  max count: 1
property:
  path: text
  name: text
  description: The negative keyword text.
  datatype: string
  max count: 1
property:
  path: matchType
  name: match type
  description: The match type of the negative keyword.
  datatype: string
  max count: 1
  in: Exact
  in: Phrase
  in: Broad
  in: Aggregate

AdInsightCategorySearchParameterShape
type: NodeShape
target class: AdInsightCategorySearchParameter
property:
  path: categoryId
  name: category id
  description: The Microsoft Advertising identifier for the keyword category. To get a list of keyword category identifiers, use the GetKeywordIdeaCategories service operation.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightCompetitionSearchParameterShape
type: NodeShape
target class: AdInsightCompetitionSearchParameter
property:
  path: competitionLevels
  name: competition levels
  description: The competition levels that you want for the returned keyword ideas. Competition levels are defined by the number of advertisers bidding on this keyword, relative to all other keywords across Microsoft Advertising. Possible values are Low, Medium, and High.
  datatype: string
  in: Low
  in: Medium
  in: High
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightDateRangeSearchParameterShape
type: NodeShape
target class: AdInsightDateRangeSearchParameter
property:
  path: startDate
  name: start date
  description: The start date range of monthly search counts for the returned keyword ideas.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: The end date range of monthly search counts for the returned keyword ideas.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightDecimalRoundedResultShape
type: NodeShape
target class: AdInsightDecimalRoundedResult
property:
  path: value
  name: value
  description: The rounded value to the nearest scale unit. Output only.
  datatype: double
  max count: 1
property:
  path: unit
  name: unit
  description: The scale unit: Thousand, Million, Billion, None. Output only.
  datatype: string
  max count: 1
  in: Billion
  in: Million
  in: Thousand
  in: None

AdInsightDeviceCriterionShape
type: NodeShape
target class: AdInsightDeviceCriterion
property:
  path: deviceName
  name: device name
  description: The device that you want to target. Possible case-sensitive values are All, Computers, Smartphones, and Tablets.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightDeviceSearchParameterShape
type: NodeShape
target class: AdInsightDeviceSearchParameter
property:
  path: device
  name: device
  description: The device criterion for the returned keyword ideas.
  node: AdInsightDeviceCriterionShape
  class: AdInsightDeviceCriterion
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightDismissRecommendationEntityShape
type: NodeShape
target class: AdInsightDismissRecommendationEntity
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation. Required.
  datatype: string
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation: ADD_BROAD_MATCH_KEYWORD, CAMPAIGN_BUDGET, KEYWORD, REMOVE_CONFLICTING_NEGATIVE_KEYWORD, RESPONSIVE_SEARCH_AD, or RESPONSIVE_SEARCH_AD_ASSET. Required.
  datatype: string
  max count: 1

AdInsightDismissRecommendationsRequestShape
type: NodeShape
target class: AdInsightDismissRecommendationsRequest
property:
  path: entities
  name: entities
  description: The list of operations to dismiss recommendations. There is a limit of 100 operations per request. Required.
  node: AdInsightDismissRecommendationEntityShape
  class: AdInsightDismissRecommendationEntity
  node kind: BlankNodeOrIRI

AdInsightDismissRecommendationsResponseShape
type: NodeShape
target class: AdInsightDismissRecommendationsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  node: AdInsightBatchErrorShape
  class: AdInsightBatchError
  node kind: BlankNodeOrIRI

AdInsightDomainCategoryShape
type: NodeShape
target class: AdInsightDomainCategory
property:
  path: categoryName
  name: category name
  description: The category name. Up to three category levels can be returned, and will be separated by a forward slash ("/"). For example the returned category might be US/CA/SFO.
  datatype: string
  max count: 1
property:
  path: coverage
  name: coverage
  description: A score from 0.0 to 1.0 that indicates the percentage of pages in the requested language that belong to a particular domain out of all the pages that Bing has indexed for the same language your website's domain. In other words coverage is the percentage of webpages that match a category and language divided by the total number of webpages using the same language in the domain. For example, if the category US/CA/SFO matches 500 english webpages and US/CA matches 1,000 english webpages, then the coverage will be 0.50 (50 percent).
  datatype: double
  max count: 1
property:
  path: bid
  name: bid
  description: Reserved for future use.
  datatype: double
  max count: 1

AdInsightEntityDetailShape
type: NodeShape
target class: AdInsightEntityDetail
property:
  path: entityId
  name: entity id
  description: For account, this is AccountId. For campaign, this is CampaignId. For ad group, this is AdGroupId. For keyword, this is KeywordId. For product group, this is ProductGroupId. For search term/website, this is 0.
  datatype: long
  max count: 1
property:
  path: entityName
  name: entity name
  description: For account/campaign/ad group, this is the name information. For keyword, this is the keyword text. For search term, this is the search term text. For product group, this is the node path. For website, this is the website URL.
  datatype: string
  max count: 1

AdInsightEntityParameterShape
type: NodeShape
target class: AdInsightEntityParameter
property:
  path: type
  name: type
  description: Defines a string for the type of parameter: string, URL, or a list of demand entities.
  datatype: string
  max count: 1
  in: Text
  in: Url
  in: Entities
property:
  path: suggestedText
  name: suggested text
  description: The suggested string value to substitute for the message.
  datatype: string
  max count: 1
property:
  path: entityType
  name: entity type
  description: The entity type.
  datatype: string
  max count: 1
  in: Account
  in: Campaign
  in: AdGroup
  in: Keyword
  in: ProductGroup
  in: SearchTerm
  in: Website
property:
  path: entityCount
  name: entity count
  description: The number of entities.
  datatype: int
  max count: 1
property:
  path: entityDetails
  name: entity details
  description: The detail information for entities.
  node: AdInsightEntityDetailShape
  class: AdInsightEntityDetail
  node kind: BlankNodeOrIRI

AdInsightEstimatedBidAndTrafficShape
type: NodeShape
target class: AdInsightEstimatedBidAndTraffic
property:
  path: minClicksPerWeek
  name: min clicks per week
  description: The estimated minimum number of clicks per week.
  datatype: double
  max count: 1
property:
  path: maxClicksPerWeek
  name: max clicks per week
  description: The estimated maximum number of clicks per week.
  datatype: double
  max count: 1
property:
  path: averageCPC
  name: average cpc
  description: The estimated average CPC. The formula used to calculate the average CPC is (maximum total cost / maximum number of clicks).
  datatype: double
  max count: 1
property:
  path: minImpressionsPerWeek
  name: min impressions per week
  description: The estimated minimum number of impressions per week.
  datatype: long
  max count: 1
property:
  path: maxImpressionsPerWeek
  name: max impressions per week
  description: The estimated maximum number of impressions per week.
  datatype: long
  max count: 1
property:
  path: cTR
  name: c tr
  description: The estimated CTR. The formula used to calculate the CTR is (maximum number of clicks / maximum number of impressions) * 100.
  datatype: double
  max count: 1
property:
  path: minTotalCostPerWeek
  name: min total cost per week
  description: The estimated minimum cost per week.
  datatype: double
  max count: 1
property:
  path: maxTotalCostPerWeek
  name: max total cost per week
  description: The estimated maximum cost per week.
  datatype: double
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: The ISO code for the monetary unit of the cost estimates and suggested bid value.
  datatype: string
  max count: 1
  in: AED
  in: ALL
  in: AMD
  in: ARS
  in: AUD
  in: AZM
  in: BGL
  in: BHD
  in: BND
  in: BOB
  in: BRL
  in: BYB
  in: BZD
  in: CAD
  in: CHF
  in: CLP
  in: CNY
  in: COP
  in: CRC
  in: CZK
  in: DOP
  in: DKK
  in: DZD
  in: EEK
  in: EGP
  in: EUR
  in: GBP
  in: GEL
  in: GTQ
  in: HKD
  in: HNL
  in: HRK
  in: HUF
  in: IDR
  in: ILS
  in: INR
  in: IQD
  in: IRR
  in: ISK
  in: JMD
  in: JOD
  in: JPY
  in: KES
  in: KGS
  in: KRW
  in: KWD
  in: KZT
  in: LBP
  in: LTL
  in: LVL
  in: LYD
  in: MAD
  in: MKD
  in: MOP
  in: MNT
  in: MVR
  in: MXN
  in: MYR
  in: NIO
  in: NOK
  in: NZD
  in: OMR
  in: PAB
  in: PEN
  in: PHP
  in: PKR
  in: PLN
  in: PYG
  in: QAR
  in: ROL
  in: RUR
  in: SAR
  in: SEK
  in: SGD
  in: SIT
property:
  path: matchType
  name: match type
  description: The match type used to determine the estimates.
  datatype: string
  max count: 1
  in: Exact
  in: Phrase
  in: Broad
  in: Aggregate
property:
  path: estimatedMinBid
  name: estimated min bid
  description: The suggested bid value.
  datatype: double
  max count: 1

AdInsightEstimatedPositionAndTrafficShape
type: NodeShape
target class: AdInsightEstimatedPositionAndTraffic
property:
  path: matchType
  name: match type
  description: The keyword match type used to determine the estimates.
  datatype: string
  max count: 1
  in: Exact
  in: Phrase
  in: Broad
  in: Aggregate
property:
  path: minClicksPerWeek
  name: min clicks per week
  description: The estimated minimum number of clicks per week.
  datatype: double
  max count: 1
property:
  path: maxClicksPerWeek
  name: max clicks per week
  description: The estimated maximum number of clicks per week.
  datatype: double
  max count: 1
property:
  path: averageCPC
  name: average cpc
  description: The estimated average CPC. The formula used to calculate the average CPC is (maximum total cost / maximum number of clicks).
  datatype: double
  max count: 1
property:
  path: minImpressionsPerWeek
  name: min impressions per week
  description: The estimated minimum number of impressions per week.
  datatype: long
  max count: 1
property:
  path: maxImpressionsPerWeek
  name: max impressions per week
  description: The estimated maximum number of impressions per week.
  datatype: long
  max count: 1
property:
  path: cTR
  name: c tr
  description: The estimated CTR. The formula used to calculate the CTR is (maximum number of clicks / maximum number of impressions) * 100.
  datatype: double
  max count: 1
property:
  path: minTotalCostPerWeek
  name: min total cost per week
  description: The estimated minimum cost per week.
  datatype: double
  max count: 1
property:
  path: maxTotalCostPerWeek
  name: max total cost per week
  description: The estimated maximum cost per week.
  datatype: double
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: The ISO code for the monetary unit of the cost values such as AverageCPC.
  datatype: string
  max count: 1
  in: AED
  in: ALL
  in: AMD
  in: ARS
  in: AUD
  in: AZM
  in: BGL
  in: BHD
  in: BND
  in: BOB
  in: BRL
  in: BYB
  in: BZD
  in: CAD
  in: CHF
  in: CLP
  in: CNY
  in: COP
  in: CRC
  in: CZK
  in: DOP
  in: DKK
  in: DZD
  in: EEK
  in: EGP
  in: EUR
  in: GBP
  in: GEL
  in: GTQ
  in: HKD
  in: HNL
  in: HRK
  in: HUF
  in: IDR
  in: ILS
  in: INR
  in: IQD
  in: IRR
  in: ISK
  in: JMD
  in: JOD
  in: JPY
  in: KES
  in: KGS
  in: KRW
  in: KWD
  in: KZT
  in: LBP
  in: LTL
  in: LVL
  in: LYD
  in: MAD
  in: MKD
  in: MOP
  in: MNT
  in: MVR
  in: MXN
  in: MYR
  in: NIO
  in: NOK
  in: NZD
  in: OMR
  in: PAB
  in: PEN
  in: PHP
  in: PKR
  in: PLN
  in: PYG
  in: QAR
  in: ROL
  in: RUR
  in: SAR
  in: SEK
  in: SGD
  in: SIT
property:
  path: estimatedAdPosition
  name: estimated ad position
  description: The position in the search results given the specified bid. This element is deprecated as of March 31st, 2021 and '0' (zero) is returned going forward.
  datatype: double
  max count: 1

AdInsightExcludeAccountKeywordsSearchParameterShape
type: NodeShape
target class: AdInsightExcludeAccountKeywordsSearchParameter
property:
  path: excludeAccountKeywords
  name: exclude account keywords
  description: Determines whether or not to exclude existing account keywords from the returned keyword ideas. By default your existing account keywords will be included with the keyword idea data e.g., suggested bid. If you set the element True then the keyword ideas will not include any keywords for the same match type that already exist in your account.
  datatype: boolean
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightFeedShape
type: NodeShape
target class: AdInsightFeed
property:
  path: storeId
  name: store id
  description: Respect StoreId when CampaignSubType is set to FeedBasedAds. Add: Optional. Defaults to null. Update: Optional
  datatype: long
  max count: 1
property:
  path: feedId
  name: feed id
  description: Respect FeedId when CampaignSubType is set to DynamicFeedBasedAds. Add: Optional. Defaults to null. Update: Optional
  datatype: long
  max count: 1
property:
  path: feedType
  name: feed type
  description: The feed type.
  datatype: long
  max count: 1

AdInsightGetAuctionInsightDataRequestShape
type: NodeShape
target class: AdInsightGetAuctionInsightDataRequest
property:
  path: entityType
  name: entity type
  description: The entity level that you want to request auction insight data. The supported values are Account, Campaign, AdGroup, and Keyword. This element is required.
  datatype: string
  max count: 1
  in: Account
  in: Campaign
  in: AdGroup
  in: Keyword
property:
  path: entityIds
  name: entity ids
  description: The Microsoft Advertising identifiers for up to 200 campaigns, ad groups, or keywords. This element is required for the campaign, ad group, and keyword entity types. If the EntityType is Account, this element is optional and will override the value set in the CustomerAccountId header. Regardless of the entity type, you must set the CustomerId and CustomerAccountId header elements.
  datatype: long
property:
  path: searchParameters
  name: search parameters
  description: The search parameters define your criteria and filters for the auction insight data. You must include exactly one DateRangeSearchParameter. In addition you can optionally include up to three different AuctionSegmentSearchParameter objects e.g., for Day, DayOfWeek, and Device. Other objects that derive from SearchParameter are not valid for this operation.
  or:
    node: AdInsightAuctionSegmentSearchParameterShape
    class: AdInsightAuctionSegmentSearchParameter
  or:
    node: AdInsightCategorySearchParameterShape
    class: AdInsightCategorySearchParameter
  or:
    node: AdInsightCompetitionSearchParameterShape
    class: AdInsightCompetitionSearchParameter
  or:
    node: AdInsightDateRangeSearchParameterShape
    class: AdInsightDateRangeSearchParameter
  or:
    node: AdInsightDeviceSearchParameterShape
    class: AdInsightDeviceSearchParameter
  or:
    node: AdInsightExcludeAccountKeywordsSearchParameterShape
    class: AdInsightExcludeAccountKeywordsSearchParameter
  or:
    node: AdInsightIdeaTextSearchParameterShape
    class: AdInsightIdeaTextSearchParameter
  or:
    node: AdInsightImpressionShareSearchParameterShape
    class: AdInsightImpressionShareSearchParameter
  or:
    node: AdInsightLanguageSearchParameterShape
    class: AdInsightLanguageSearchParameter
  or:
    node: AdInsightLocationSearchParameterShape
    class: AdInsightLocationSearchParameter
  or:
    node: AdInsightNetworkSearchParameterShape
    class: AdInsightNetworkSearchParameter
  or:
    node: AdInsightQuerySearchParameterShape
    class: AdInsightQuerySearchParameter
  or:
    node: AdInsightSearchParameterShape
    class: AdInsightSearchParameter
  or:
    node: AdInsightSearchVolumeSearchParameterShape
    class: AdInsightSearchVolumeSearchParameter
  or:
    node: AdInsightSuggestedBidSearchParameterShape
    class: AdInsightSuggestedBidSearchParameter
  or:
    node: AdInsightUrlSearchParameterShape
    class: AdInsightUrlSearchParameter
  node kind: BlankNodeOrIRI
property:
  path: returnAdditionalFields
  name: return additional fields
  description: The list of additional properties that you want included within each returned auction insight KPI. The additional field values enable you to get the latest features using the current version of the Ad Insight API, and in the next version the corresponding elements will be included by default. This request element is optional.
  datatype: string
  max count: 1

AdInsightSearchParameterShape
type: NodeShape
target class: AdInsightSearchParameter
property:
  path: queries
  name: queries
  datatype: string
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: url
  name: url
  datatype: string
  max count: 1
property:
  path: categoryId
  name: category id
  datatype: long
  max count: 1
property:
  path: minimum
  name: minimum
  datatype: double
  max count: 1
property:
  path: maximum
  name: maximum
  datatype: double
  max count: 1
property:
  path: included
  name: included
  node: AdInsightKeywordShape
  class: AdInsightKeyword
  node kind: BlankNodeOrIRI
property:
  path: excluded
  name: excluded
  node: AdInsightKeywordShape
  class: AdInsightKeyword
  node kind: BlankNodeOrIRI
property:
  path: excludeAccountKeywords
  name: exclude account keywords
  datatype: boolean
  max count: 1
property:
  path: locations
  name: locations
  node: AdInsightLocationCriterionShape
  class: AdInsightLocationCriterion
  node kind: BlankNodeOrIRI
property:
  path: network
  name: network
  node: AdInsightNetworkCriterionShape
  class: AdInsightNetworkCriterion
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: device
  name: device
  node: AdInsightDeviceCriterionShape
  class: AdInsightDeviceCriterion
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: languages
  name: languages
  node: AdInsightLanguageCriterionShape
  class: AdInsightLanguageCriterion
  node kind: BlankNodeOrIRI
property:
  path: competitionLevels
  name: competition levels
  datatype: string
  in: Low
  in: Medium
  in: High
property:
  path: startDate
  name: start date
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: segment
  name: segment
  datatype: string
  max count: 1
  in: Day
  in: Week
  in: Month
  in: Quarter
  in: DayOfWeek
  in: Device

AdInsightLocationCriterionShape
type: NodeShape
target class: AdInsightLocationCriterion
property:
  path: locationId
  name: location id
  description: The Microsoft Advertising identifier of the location that you want to target. You can get keyword ideas and traffic estimates for city, country/region, county, metro area (Microsoft Market Area in the United States), and state locations. Postal code location identifiers are not supported for keyword ideas and traffic estimate requests. Currently this feature is available in the United States, United Kingdom, Canada, Australia, France, and Germany. To get a list of geographical location identifiers use the Campaign Management service i.e., the GetGeoLocationsFileUrl service operation.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightNetworkCriterionShape
type: NodeShape
target class: AdInsightNetworkCriterion
property:
  path: network
  name: network
  description: The network that you want to target. Possible values are OwnedAndOperatedAndSyndicatedSearch, OwnedAndOperatedOnly, and SyndicatedSearchOnly. Note: As of July 2024, Microsoft no longer offers the SyndicatedSearchOnly option as an ad distribution setting. We highly recommend that you switch to "The entire Microsoft Advertising Network" and leverage auto-biding to let Microsoft help you manage your budget.
  datatype: string
  max count: 1
  in: OwnedAndOperatedAndSyndicatedSearch
  in: OwnedAndOperatedOnly
  in: SyndicatedSearchOnly
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightLanguageCriterionShape
type: NodeShape
target class: AdInsightLanguageCriterion
property:
  path: language
  name: language
  description: The language that you require. Possible case-sensitive values are English, French, and German.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightGetAuctionInsightDataResponseShape
type: NodeShape
target class: AdInsightGetAuctionInsightDataResponse
property:
  path: result
  name: result
  description: Includes the auction insight entries for the requested entity, date range, and segment search parameters.
  node: AdInsightAuctionInsightResultShape
  class: AdInsightAuctionInsightResult
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightGetAudienceBreakdownRequestShape
type: NodeShape
target class: AdInsightGetAudienceBreakdownRequest
property:
  path: age
  name: age
  description: The selection of age targeting. Possible values are: EighteenToTwentyFour, TwentyFiveToThirtyFour, ThirtyFiveToFourtyNine, FiftyToSixtyFour, SixtyFiveAndAbove, Unknown. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOfAgeEnumShape
  class: AdInsightSelectionOfAgeEnum
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: gender
  name: gender
  description: The gender to target. Possible values are: Male, Female, Unknown. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOfGenderEnumShape
  class: AdInsightSelectionOfGenderEnum
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: audience
  name: audience
  description: The selection of audience targeting. Supported audience types are: Custom audiences, Combined lists, Customer match lists, Dynamic remarketing lists, In-market audiences, Remarketing lists, and Similar audiences. The values stored in the selection refer to segment IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: company
  name: company
  description: The company of LinkedIn profile targeting. The values stored in the selection refer to segment IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: industry
  name: industry
  description: The industry of LinkedIn profile targeting. The values stored in the selection refer to segment IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: jobFunction
  name: job function
  description: The job function The industry of LinkedIn profile targeting. The values stored in the selection refer to segment IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: location
  name: location
  description: The selection of location targeting. The values stored in selection refer to location IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: placement
  name: placement
  description: The selection of placement targeting. The values stored in selection refer to placement IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: device
  name: device
  description: The type of device.
  node: AdInsightSelectionOfDeviceEnumShape
  class: AdInsightSelectionOfDeviceEnum
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: topic
  name: topic
  description: The selection of topic targeting. The values stored in selection refer to topic IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: radiusTargets
  name: radius targets
  description: Represents the desired geographical area in terms of miles/kilometers. Add: Optional. The default value is null. Update: Optional
  node: AdInsightRadiusTargetShape
  class: AdInsightRadiusTarget
  node kind: BlankNodeOrIRI
property:
  path: campaignBiddingStrategy
  name: campaign bidding strategy
  description: Indicates the desired bidding strategy for estimation response. Supported values are: 5: EnhancedCPC, 12: ManualCP. Add: Optional. The default value is Manual. Update: Optional
  datatype: int
  max count: 1
property:
  path: campaignSubType
  name: campaign sub type
  description: Indicate the desired ad type for estimation response. Supported values are: 0: StaticAds, 1: FeedBasedAds, 2: DynamicFeedBasedAds. Add: Optional. The default value is StaticAds*. Update: Optional
  datatype: int
  max count: 1
property:
  path: feed
  name: feed
  description: Respect this parameter only when CampaignSubType is FeedBasedAds or DynamicFeedBasedAds. It specifies the desired feed traffic to count as estimation. Add: Optional. The default value is null. Update: Optional
  node: AdInsightFeedShape
  class: AdInsightFeed
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: lcid
  name: lcid
  description: The locale identifier. Add: Optional. Update: Optional
  datatype: int
  max count: 1
property:
  path: breakdownReturnCategory
  name: breakdown return category
  description: The category of audience breakdown. Possible values include: All, Demographics, Device, Location, Interest. Add: Optional. Update: Optional
  datatype: string
  max count: 1
  in: All
  in: Demographics
  in: Location
  in: Interest
  in: Device
property:
  path: multiAdTypes
  name: multi ad types
  description: The audience breakdown ad type. Possible values indlude: DisplayAds, StaticAds, VideoAds. Add: Optional. Update: Optional
  datatype: int
  max count: 1

AdInsightSelectionOfAgeEnumShape
type: NodeShape
target class: AdInsightSelectionOfAgeEnum
property:
  path: includes
  name: includes
  description: The traffic matching any value of Includes array is included as an estimation.
  datatype: string
  in: Unknown
  in: ZeroToTwelve
  in: ThirteenToSevenTeen
  in: EighteenToTwentyFour
  in: TwentyFiveToThirtyFour
  in: ThirtyFiveToFourtyNine
  in: FiftyToSixtyFour
  in: SixtyFiveAndAbove
property:
  path: excludes
  name: excludes
  description: The traffic matching any value of Excludes array is excluded as an estimation.
  datatype: string
  in: Unknown
  in: ZeroToTwelve
  in: ThirteenToSevenTeen
  in: EighteenToTwentyFour
  in: TwentyFiveToThirtyFour
  in: ThirtyFiveToFourtyNine
  in: FiftyToSixtyFour
  in: SixtyFiveAndAbove

AdInsightSelectionOfGenderEnumShape
type: NodeShape
target class: AdInsightSelectionOfGenderEnum
property:
  path: includes
  name: includes
  description: The traffic matching any value of Includes array is included as an estimation.
  datatype: string
  in: Unknown
  in: Male
  in: Female
property:
  path: excludes
  name: excludes
  description: The traffic matching any value of Excludes array is excluded as an estimation.
  datatype: string
  in: Unknown
  in: Male
  in: Female

AdInsightSelectionOflongShape
type: NodeShape
target class: AdInsightSelectionOflong
property:
  path: includes
  name: includes
  description: The traffic matching any value of Includes array is included as an estimation.
  datatype: long
property:
  path: excludes
  name: excludes
  description: The traffic matching any value of Excludes array is excluded as an estimation.
  datatype: long

AdInsightSelectionOfDeviceEnumShape
type: NodeShape
target class: AdInsightSelectionOfDeviceEnum
property:
  path: includes
  name: includes
  description: Include the type of desvices present in the DeviceEnum.
  datatype: string
  in: Desktop
  in: Smartphone
  in: Tablet
property:
  path: excludes
  name: excludes
  description: Exclude the type of devices present in the DeviceEnum.
  datatype: string
  in: Desktop
  in: Smartphone
  in: Tablet

AdInsightRadiusTargetShape
type: NodeShape
target class: AdInsightRadiusTarget
property:
  path: radius
  name: radius
  description: Indicates the desired amount of radius units.
  datatype: int
  max count: 1
property:
  path: radiusUnit
  name: radius unit
  description: Indicates the radius unit. Supports Kilometers or Miles.
  datatype: string
  max count: 1
  in: Miles
  in: Kilometers
property:
  path: centerLatitude
  name: center latitude
  description: Defines the center latitude.
  datatype: double
  max count: 1
property:
  path: centerLongitude
  name: center longitude
  description: DEfines the center longitude.
  datatype: double
  max count: 1

AdInsightGetAudienceBreakdownResponseShape
type: NodeShape
target class: AdInsightGetAudienceBreakdownResponse
property:
  path: estAudienceSize
  name: est audience size
  description: Monthly estimated reach user count with rounded results. Output only.
  node: AdInsightDecimalRoundedResultShape
  class: AdInsightDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: estImpression
  name: est impression
  description: Monthly estimated impression with range result. Output only.
  node: AdInsightDecimalRoundedResultShape
  class: AdInsightDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: isImpressionTooSpecific
  name: is impression too specific
  description: Indicates if the impression is too specific.
  datatype: boolean
  max count: 1
property:
  path: isPrivacyCheckPassed
  name: is privacy check passed
  description: Indicates if the estimated audience size passes the privacy check.
  datatype: boolean
  max count: 1
property:
  path: suggestedBid
  name: suggested bid
  description: Suggested bid value under the current targeting. Output only.
  datatype: double
  max count: 1
property:
  path: currency
  name: currency
  description: The currency of DailyBudget and Bid. If null, the currency of account setting will be used. Add: Optional. The default value is null. Update: Optional
  datatype: string
  max count: 1
  in: UnSpecify
  in: AustralianDollar
  in: BrazilianReal
  in: CanadianDollar
  in: SwissFranc
  in: DanishKrone
  in: EURO
  in: UKPound
  in: JapaneseYen
  in: NorwegianKrone
  in: NewZealandDollar
  in: SwedishKrona
  in: USDollar
  in: SouthAfricanRand
  in: ArgentinePeso
  in: ChileanPeso
  in: YuanRenminbi
  in: ColombianPeso
  in: CzechKoruna
  in: UAEDirham
  in: AlgerianDinar
  in: EgyptianPound
  in: HongKongDollar
  in: Forint
  in: Rupiah
  in: IsraeliSheqel
  in: IndianRupee
  in: Won
  in: LebanesePound
  in: MoroccanDirham
  in: MexicanPeso
  in: MalaysianRinggit
  in: NuevoSol
  in: PhilippinePeso
  in: PolishZloty
  in: QatariRial
  in: SaudiRiyal
  in: SingaporeDollar
  in: Baht
  in: NewTaiwanDollar
  in: Bolivar
  in: Dong
  in: TurkishLira
  in: NigerianNaira
property:
  path: breakdowns
  name: breakdowns
  description: The audience breakdown categories.
  node: AdInsightBreakdownsShape
  class: AdInsightBreakdowns
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightGetAudienceFullEstimationRequestShape
type: NodeShape
target class: AdInsightGetAudienceFullEstimationRequest
property:
  path: age
  name: age
  description: The selection of age targeting. Possible values are: EighteenToTwentyFour, TwentyFiveToThirtyFour, ThirtyFiveToFourtyNine, FiftyToSixtyFour, SixtyFiveAndAbove, Unknown. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOfAgeEnumShape
  class: AdInsightSelectionOfAgeEnum
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: gender
  name: gender
  description: The gender to target. Possible values are: Male, Female, Unknown. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOfGenderEnumShape
  class: AdInsightSelectionOfGenderEnum
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: audience
  name: audience
  description: The selection of audience targeting. Supported audience types are: Custom audiences, Combined lists, Customer match lists, Dynamic remarketing lists, In-market audiences, Remarketing lists, and Similar audiences. The values stored in the selection refer to segment IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: company
  name: company
  description: The company of LinkedIn profile targeting. The values stored in the selection refer to segment IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: industry
  name: industry
  description: The industry of LinkedIn profile targeting. The values stored in the selection refer to segment IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: jobFunction
  name: job function
  description: The job function The industry of LinkedIn profile targeting. The values stored in the selection refer to segment IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: location
  name: location
  description: The selection of location targeting. The values stored in selection refer to location IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: placement
  name: placement
  description: The selection of placement targeting. The values stored in selection refer to placement IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: device
  name: device
  description: The type of device.
  node: AdInsightSelectionOfDeviceEnumShape
  class: AdInsightSelectionOfDeviceEnum
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: topic
  name: topic
  description: The selection of topic targeting. The values stored in selection refer to topic IDs. Add: Optional. The default value is null. Update: Optional
  node: AdInsightSelectionOflongShape
  class: AdInsightSelectionOflong
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: radiusTargets
  name: radius targets
  description: Represents the desired geographical area in terms of miles/kilometers. Add: Optional. The default value is null. Update: Optional
  node: AdInsightRadiusTargetShape
  class: AdInsightRadiusTarget
  node kind: BlankNodeOrIRI
property:
  path: campaignBiddingStrategy
  name: campaign bidding strategy
  description: Indicates the desired bidding strategy for estimation response. Supported values are: 5: EnhancedCPC, 12: ManualCP. Add: Optional. The default value is Manual. Update: Optional
  datatype: int
  max count: 1
property:
  path: campaignSubType
  name: campaign sub type
  description: Indicate the desired ad type for estimation response. Supported values are: 0: StaticAds, 1: FeedBasedAds, 2: DynamicFeedBasedAds. Add: Optional. The default value is StaticAds*. Update: Optional
  datatype: int
  max count: 1
property:
  path: feed
  name: feed
  description: Respect this parameter only when CampaignSubType is FeedBasedAds or DynamicFeedBasedAds. It specifies the desired feed traffic to count as estimation. Add: Optional. The default value is null. Update: Optional
  node: AdInsightFeedShape
  class: AdInsightFeed
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: dailyBudget
  name: daily budget
  description: The daily campaign budget value. If set to null, the suggested budget is used to perform estimation. Add: Optional. The default value is null. Update: Optional
  datatype: double
  max count: 1
property:
  path: bid
  name: bid
  description: The desired bid setting value. If set to null, the suggested bid is used to perform estimation. Add: Optional Update: Optional
  datatype: double
  max count: 1
property:
  path: currency
  name: currency
  description: The currency of DailyBudget and Bid. If null, the currency of account setting will be used. Add: Optional. The default value is null. Update: Optional
  datatype: string
  max count: 1
  in: UnSpecify
  in: AustralianDollar
  in: BrazilianReal
  in: CanadianDollar
  in: SwissFranc
  in: DanishKrone
  in: EURO
  in: UKPound
  in: JapaneseYen
  in: NorwegianKrone
  in: NewZealandDollar
  in: SwedishKrona
  in: USDollar
  in: SouthAfricanRand
  in: ArgentinePeso
  in: ChileanPeso
  in: YuanRenminbi
  in: ColombianPeso
  in: CzechKoruna
  in: UAEDirham
  in: AlgerianDinar
  in: EgyptianPound
  in: HongKongDollar
  in: Forint
  in: Rupiah
  in: IsraeliSheqel
  in: IndianRupee
  in: Won
  in: LebanesePound
  in: MoroccanDirham
  in: MexicanPeso
  in: MalaysianRinggit
  in: NuevoSol
  in: PhilippinePeso
  in: PolishZloty
  in: QatariRial
  in: SaudiRiyal
  in: SingaporeDollar
  in: Baht
  in: NewTaiwanDollar
  in: Bolivar
  in: Dong
  in: TurkishLira
  in: NigerianNaira
property:
  path: multiAdTypes
  name: multi ad types
  description: The audience full estimation ad type. Possible values indlude: DisplayAds, StaticAds, VideoAds. Add: Optional. Update: Optional
  datatype: int
  max count: 1
property:
  path: startDate
  name: start date
  description: The start date of the date range that identifies the data that you want to use to determine the audience full estimation. This date must be earlier than or the same as the specified end date.
  datatype: dateTime
  max count: 1
property:
  path: endDate
  name: end date
  description: The end date of the date range that identifies the data that you want to use to determine the audience full estimation. This date must be later than or the same as the specified end date.
  datatype: dateTime
  max count: 1
property:
  path: totalBudget
  name: total budget
  description: The total budget.
  datatype: double
  max count: 1
property:
  path: includeImpressionsBreakdown
  name: include impressions breakdown
  description: Include impressions in the audience breakdown.
  datatype: boolean
  max count: 1

AdInsightGetAudienceFullEstimationResponseShape
type: NodeShape
target class: AdInsightGetAudienceFullEstimationResponse
property:
  path: estImpression
  name: est impression
  description: Monthly estimated impression with range result. Output only.
  node: AdInsightRangeResultOfDecimalRoundedResultShape
  class: AdInsightRangeResultOfDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: estAudienceSize
  name: est audience size
  description: Monthly estimated reach user count with rounded results. Output only.
  node: AdInsightRangeResultOfDecimalRoundedResultShape
  class: AdInsightRangeResultOfDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: estClick
  name: est click
  description: Monthly estimated user count with range result. Output only.
  node: AdInsightRangeResultOfDecimalRoundedResultShape
  class: AdInsightRangeResultOfDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: estSpend
  name: est spend
  description: Monthly estimated spend with range result. Output only.
  node: AdInsightRangeResultOfDecimalRoundedResultShape
  class: AdInsightRangeResultOfDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: estCostPerEvent
  name: est cost per event
  description: Indicates the estimated cost per event. The field meaning varies with CampaignBiddingStrategy request field. Output only. EnhancedCPC: CPC ManualCPM: CPM
  node: AdInsightRangeResultOfDecimalRoundedResultShape
  class: AdInsightRangeResultOfDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: estCPC
  name: est cpc
  description: Indicates the estimated cost per click.
  node: AdInsightRangeResultOfDecimalRoundedResultShape
  class: AdInsightRangeResultOfDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: estCTR
  name: est ctr
  description: Estimated click-through rate (CTR) with range result. Output only.
  node: AdInsightRangeResultOfdoubleShape
  class: AdInsightRangeResultOfdouble
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: suggestedBid
  name: suggested bid
  description: Suggested bid value under the current targeting. Output only.
  datatype: double
  max count: 1
property:
  path: suggestedBudget
  name: suggested budget
  description: Suggested daily budget value under the current targeting and bid. Output only.
  datatype: double
  max count: 1
property:
  path: eventsLostToBid
  name: events lost to bid
  description: Indicates event lost count due to insufficient input bid. The event lost type varies with CampaignBiddingStrategy request field. Output only. EnhancedCPC: Click ManualCPM: Impression
  datatype: int
  max count: 1
property:
  path: eventsLostToBudget
  name: events lost to budget
  description: Indicates the event lost count due to insufficient input budget. The event lost type varies with CampaignBiddingStrategy request field. Output only. EnhancedCPC: Click ManualCPM: Impression
  datatype: int
  max count: 1
property:
  path: estReachAudienceSize
  name: est reach audience size
  description: Monthly estimated user count with range result. Output only.
  node: AdInsightDecimalRoundedResultShape
  class: AdInsightDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: estReachImpression
  name: est reach impression
  description: Monthly estimated impression with range result. Output only.
  node: AdInsightDecimalRoundedResultShape
  class: AdInsightDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: currency
  name: currency
  description: The currency of DailyBudget and Bid. If null, the currency of account setting will be used. Add: Optional. The default value is null. Update: Optional
  datatype: string
  max count: 1
  in: UnSpecify
  in: AustralianDollar
  in: BrazilianReal
  in: CanadianDollar
  in: SwissFranc
  in: DanishKrone
  in: EURO
  in: UKPound
  in: JapaneseYen
  in: NorwegianKrone
  in: NewZealandDollar
  in: SwedishKrona
  in: USDollar
  in: SouthAfricanRand
  in: ArgentinePeso
  in: ChileanPeso
  in: YuanRenminbi
  in: ColombianPeso
  in: CzechKoruna
  in: UAEDirham
  in: AlgerianDinar
  in: EgyptianPound
  in: HongKongDollar
  in: Forint
  in: Rupiah
  in: IsraeliSheqel
  in: IndianRupee
  in: Won
  in: LebanesePound
  in: MoroccanDirham
  in: MexicanPeso
  in: MalaysianRinggit
  in: NuevoSol
  in: PhilippinePeso
  in: PolishZloty
  in: QatariRial
  in: SaudiRiyal
  in: SingaporeDollar
  in: Baht
  in: NewTaiwanDollar
  in: Bolivar
  in: Dong
  in: TurkishLira
  in: NigerianNaira
property:
  path: estImpressionByType
  name: est impression by type
  description: The estimated impressions by type.
  datatype: JSON
  max count: 1
property:
  path: estClickByType
  name: est click by type
  description: The estimated user count by type.
  datatype: JSON
  max count: 1
property:
  path: estSpendByType
  name: est spend by type
  description: The estimated spend by type.
  datatype: JSON
  max count: 1
property:
  path: estCostPerEventByType
  name: est cost per event by type
  description: The estimated cost per event by type.
  datatype: JSON
  max count: 1
property:
  path: estCPCByType
  name: est cpcby type
  description: The estimated cost per click by type.
  datatype: JSON
  max count: 1
property:
  path: estViewByType
  name: est view by type
  description: The estimated views by type.
  datatype: JSON
  max count: 1
property:
  path: estCTRByType
  name: est ctrby type
  description: The estimated click-through rate by type.
  datatype: JSON
  max count: 1
property:
  path: estReachImpressionByType
  name: est reach impression by type
  description: The estimated reach of impressions by type.
  datatype: JSON
  max count: 1

AdInsightRangeResultOfDecimalRoundedResultShape
type: NodeShape
target class: AdInsightRangeResultOfDecimalRoundedResult
property:
  path: high
  name: high
  description: Indicates the upper bound of range result.
  node: AdInsightDecimalRoundedResultShape
  class: AdInsightDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: low
  name: low
  description: Indicates the lower bound of range result.
  node: AdInsightDecimalRoundedResultShape
  class: AdInsightDecimalRoundedResult
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightRangeResultOfdoubleShape
type: NodeShape
target class: AdInsightRangeResultOfdouble
property:
  path: high
  name: high
  description: Indicates the upper bound of range result.
  datatype: double
  max count: 1
property:
  path: low
  name: low
  description: Indicates the lower bound of range result.
  datatype: double
  max count: 1

AdInsightGetAutoApplyOptInStatusRequestShape
type: NodeShape
target class: AdInsightGetAutoApplyOptInStatusRequest
property:
  path: recommendationTypesInputs
  name: recommendation types inputs
  description: Determines the type of recommendations that you want to get the auto-apply opt-in status for. Duplicated inputs are allowed in the same. This field includes the list of recommendation type (case sensitive) as below:ResponsiveSearchAdsOpportunityMultiMediaAdsOpportunityRemoveConflictingNegativeKeywordOpportunityFixConversionGoalSettingsOpportunityCreateConversionGoalOpportunity.You may specify a maximum of 100 input elements.
  datatype: string

AdInsightGetAutoApplyOptInStatusResponseShape
type: NodeShape
target class: AdInsightGetAutoApplyOptInStatusResponse
property:
  path: autoApplyRecommendationsStatus
  name: auto apply recommendations status
  description: An array of AutoApplyRecommendationsInfo object which identifies auto-apply opt-in status for the given recommendation types in the request.
  node: AdInsightAutoApplyRecommendationsInfoShape
  class: AdInsightAutoApplyRecommendationsInfo
  node kind: BlankNodeOrIRI

AdInsightGetBidLandscapeByAdGroupIdsRequestShape
type: NodeShape
target class: AdInsightGetBidLandscapeByAdGroupIdsRequest
property:
  path: adGroupBidLandscapeInputs
  name: ad group bid landscape inputs
  description: An array of ad group identifiers with corresponding bid landscape type input. A list of suggested bid values with estimated performance statistics will be returned for each input. You may specify a maximum of 1,000 input elements.
  node: AdInsightAdGroupBidLandscapeInputShape
  class: AdInsightAdGroupBidLandscapeInput
  node kind: BlankNodeOrIRI

AdInsightGetBidLandscapeByAdGroupIdsResponseShape
type: NodeShape
target class: AdInsightGetBidLandscapeByAdGroupIdsResponse
property:
  path: bidLandscape
  name: bid landscape
  description: An array of AdGroupBidLandscape objects. The array contains a AdGroupBidLandscape corresponding to each ad group and bid landscape type input specified in the request. Duplicate input are allowed in the same call and will return the same results. If the specified input is invalid or has no associated data results, all elements within the AdGroupBidLandscape will be nil except the AdGroupId which reflects the ad group identifier specified in the request. If there is data available for the ad group, the AdGroupBidLandscape object will provide a list of suggested bids and estimated performance statistics.
  node: AdInsightAdGroupBidLandscapeShape
  class: AdInsightAdGroupBidLandscape
  node kind: BlankNodeOrIRI

AdInsightGetBidLandscapeByCampaignIdsRequestShape
type: NodeShape
target class: AdInsightGetBidLandscapeByCampaignIdsRequest
property:
  path: campaignIds
  name: campaign ids
  description: The campaign identifiers.
  datatype: long

AdInsightGetBidLandscapeByCampaignIdsResponseShape
type: NodeShape
target class: AdInsightGetBidLandscapeByCampaignIdsResponse
property:
  path: bidLandscape
  name: bid landscape
  description: An array of CampaignBidLandscape objects. The array contains a CampaignBidLandscape corresponding to each campaign and bid landscape type input specified in the request. Duplicate input are allowed in the same call and will return the same results. If the specified input is invalid or has no associated data results, all elements within the CampaignBidLandscape will be nil except the CampaignId which reflects the campaign identifier specified in the request. If there is data available for the campaign, the CampaignBidLandscape object will provide a list of suggested bids and estimated performance statistics.
  node: AdInsightCampaignBidLandscapeShape
  class: AdInsightCampaignBidLandscape
  node kind: BlankNodeOrIRI

AdInsightGetBidLandscapeByKeywordIdsRequestShape
type: NodeShape
target class: AdInsightGetBidLandscapeByKeywordIdsRequest
property:
  path: keywordIds
  name: keyword ids
  description: An array of identifiers of the keywords for which you want to get the list of suggested bid values with estimated performance statistics. You may specify a maximum of 1,000 keywords.
  datatype: long
property:
  path: includeCurrentBid
  name: include current bid
  description: When set to false, the suggested bid values might not include the keyword's current bid. The default value is false. When set to true, one of the suggested bid values will be equal to the keyword's current bid.
  datatype: boolean
  max count: 1

AdInsightGetBidLandscapeByKeywordIdsResponseShape
type: NodeShape
target class: AdInsightGetBidLandscapeByKeywordIdsResponse
property:
  path: bidLandscape
  name: bid landscape
  description: An array of KeywordBidLandscape objects. The array contains a KeywordBidLandscape corresponding to each keyword specified in the request. Duplicate keyword identifiers are allowed in the same call and will return the same results. If the specified keyword identifier is invalid or has no associated data results, all elements within the KeywordBidLandscape will be nil except the KeywordId which reflects the keyword identifier specified in the request. If there is data available for the keyword, the KeywordBidLandscape object will provide a list of suggested bids and estimated performance statistics.
  node: AdInsightKeywordBidLandscapeShape
  class: AdInsightKeywordBidLandscape
  node kind: BlankNodeOrIRI

AdInsightKeywordBidLandscapeShape
type: NodeShape
target class: AdInsightKeywordBidLandscape
property:
  path: keywordId
  name: keyword id
  description: The keyword identifier.
  datatype: long
  max count: 1
property:
  path: startDate
  name: start date
  description: The first date used to calculate the bid landscape. The start date is usually seven days prior to the end date. The difference between the start and end dates could be less than seven if performance data is not available, for example with a new keyword.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: The most recent date used to calculate the bid landscape. The end date should be approximately 2 days prior to today's date when the service is called.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: bidLandscapePoints
  name: bid landscape points
  description: The list of the total estimated clicks, cost, and impressions from StartDate to EndDate given the suggested bid.
  node: AdInsightBidLandscapePointShape
  class: AdInsightBidLandscapePoint
  node kind: BlankNodeOrIRI

AdInsightGetBidOpportunitiesRequestShape
type: NodeShape
target class: AdInsightGetBidOpportunitiesRequest
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group for which you want to determine keyword bid opportunities. If this element is nil or empty, the operation will return all bid opportunities for the specified campaign.
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign that owns the ad group specified in the AdGroupId element. If this element is nil or empty, then the AdGroupId must also be nil or empty, and the operation will return all bid opportunities for the account.
  datatype: long
  max count: 1
property:
  path: opportunityType
  name: opportunity type
  description: Determines the type or types of bid opportunities corresponding to your ad position goals. The operation will only return opportunities if there's a suggested increase within 100% of your current bid that will help you achieve the specified goal.
  datatype: string
  max count: 1

AdInsightGetBidOpportunitiesResponseShape
type: NodeShape
target class: AdInsightGetBidOpportunitiesResponse
property:
  path: opportunities
  name: opportunities
  description: An array of BidOpportunity objects that identifies the keywords whose clicks and impressions may increase if you were to apply the suggested match-type bid value. Currently up to 1,000 list items can be returned although the limit is subject to change.
  node: AdInsightBidOpportunityShape
  class: AdInsightBidOpportunity
  node kind: BlankNodeOrIRI

AdInsightGetBudgetOpportunitiesRequestShape
type: NodeShape
target class: AdInsightGetBudgetOpportunitiesRequest
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign for which you want to discover possible campaign budget opportunities. If this element is nil or empty, then the operation will return all budget opportunities for the account.
  datatype: long
  max count: 1

AdInsightGetBudgetOpportunitiesResponseShape
type: NodeShape
target class: AdInsightGetBudgetOpportunitiesResponse
property:
  path: opportunities
  name: opportunities
  description: An array of BudgetOpportunity data objects that identify the campaigns whose clicks and impressions may increase if you were to apply the suggested budget. The list will not include opportunities for campaigns that are currently paused by the user. Currently up to 1,000 list items can be returned although the limit is subject to change.
  node: AdInsightBudgetOpportunityShape
  class: AdInsightBudgetOpportunity
  node kind: BlankNodeOrIRI

AdInsightGetDomainCategoriesRequestShape
type: NodeShape
target class: AdInsightGetDomainCategoriesRequest
property:
  path: domainName
  name: domain name
  description: The website name corresponding to the pages you want your ads to target. The maximum length of the domain is 2,048 characters. You do not need to include the http, https, or www prefix.
  datatype: string
  max count: 1
property:
  path: language
  name: language
  description: The language of the website domain. Currently only English is supported, so you must set this element to EN.
  datatype: string
  max count: 1
property:
  path: categoryName
  name: category name
  description: The category name filter. If you already know one or more of the categories, then you can optionally filter the list of results by sub-category. Up to three category levels can be specified, and must be separated by a forward slash ("/"). For example you can format the filter as CategoryL1 / CategoryL2 / CategoryL3. If you do not include any category name, then all categories for the domain and language will be returned.
  datatype: string
  max count: 1

AdInsightGetDomainCategoriesResponseShape
type: NodeShape
target class: AdInsightGetDomainCategoriesResponse
property:
  path: categories
  name: categories
  description: The list of domain categories.
  node: AdInsightDomainCategoryShape
  class: AdInsightDomainCategory
  node kind: BlankNodeOrIRI

AdInsightGetEstimatedBidByKeywordIdsRequestShape
type: NodeShape
target class: AdInsightGetEstimatedBidByKeywordIdsRequest
property:
  path: keywordIds
  name: keyword ids
  description: An array of identifiers of the keywords for which you want to get the suggested bid values that could have resulted in your ad appearing in the targeted position in the search results. You may specify a maximum of 1,000 keywords.
  datatype: long
property:
  path: targetPositionForAds
  name: target position for ads
  description: The position in which you want your ads to appear in the search results. The default value is MainLine1.
  datatype: string
  max count: 1
  in: MainLine1
  in: MainLine
  in: FirstPage

AdInsightGetEstimatedBidByKeywordIdsResponseShape
type: NodeShape
target class: AdInsightGetEstimatedBidByKeywordIdsResponse
property:
  path: keywordEstimatedBids
  name: keyword estimated bids
  description: An array of KeywordIdEstimatedBid data objects. The array contains a corresponding item for each keyword specified in the request. If the keyword ID is not valid, the corresponding item in the array will be null. Each KeywordIdEstimatedBid contains a keyword identifier and a KeywordEstimatedBid. If there is data available for the keyword, the KeywordEstimatedBid will provide a suggested bid value that could have resulted in an ad appearing in the targeted position of the search results. Otherwise, the KeywordEstimatedBid element will be set to null.
  node: AdInsightKeywordIdEstimatedBidShape
  class: AdInsightKeywordIdEstimatedBid
  node kind: BlankNodeOrIRI

AdInsightKeywordIdEstimatedBidShape
type: NodeShape
target class: AdInsightKeywordIdEstimatedBid
property:
  path: keywordId
  name: keyword id
  description: The identifier of the keyword to which the suggested bid applies.
  datatype: long
  max count: 1
property:
  path: keywordEstimatedBid
  name: keyword estimated bid
  description: An object that contains the keyword string and the suggested bid value for each match type.
  node: AdInsightKeywordEstimatedBidShape
  class: AdInsightKeywordEstimatedBid
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightKeywordEstimatedBidShape
type: NodeShape
target class: AdInsightKeywordEstimatedBid
property:
  path: keyword
  name: keyword
  description: The keyword to which the estimates apply.
  datatype: string
  max count: 1
property:
  path: estimatedBids
  name: estimated bids
  description: A list of EstimatedBidAndTraffic data objects that contains the suggested bid value for the keyword and match type. If there is data available for the keyword, the EstimatedBidAndTraffic object will provide an estimated bid value. Otherwise, if no data is available the EstimatedBids element will be null. Each object also contains estimates of clicks, average cost per click (CPC), impressions, click-through rate (CTR), and total cost given the suggested bid. If there is no data available for a match type, the array will not include estimates for the match type. Some returned elements of the EstimatedBidAndTraffic may be NULL.
  node: AdInsightEstimatedBidAndTrafficShape
  class: AdInsightEstimatedBidAndTraffic
  node kind: BlankNodeOrIRI

AdInsightGetEstimatedBidByKeywordsRequestShape
type: NodeShape
target class: AdInsightGetEstimatedBidByKeywordsRequest
property:
  path: keywords
  name: keywords
  description: A list of KeywordAndMatchType data objects for which you want to get suggested bid values. You may specify a maximum of 1,000 keywords, and each keyword can contain a maximum of 100 characters.
  node: AdInsightKeywordAndMatchTypeShape
  class: AdInsightKeywordAndMatchType
  node kind: BlankNodeOrIRI
property:
  path: targetPositionForAds
  name: target position for ads
  description: The position where you want your ads to appear in the search results. The default value is MainLine1.
  datatype: string
  max count: 1
  in: MainLine1
  in: MainLine
  in: FirstPage
property:
  path: language
  name: language
  description: The language used in parallel with location identifiers for estimating the bids. The language must be supported in each of the locations that you specify in LocationIds. For possible language values, see Ad Languages. If you do not specify the language, the service operation uses the language of the specified AdGroupId or CampaignId. If none of these properties are set, then EN (English) is used by default.
  datatype: string
  max count: 1
property:
  path: locationIds
  name: location ids
  description: The identifier or identifiers of the geographical locations to use for estimating the bids. All of the locations must support the language specified in the Language element. Although you can specify multiple location identifiers, as a best practice for the most accurate bid estimates per location, you should specify only one location per service call. For possible location identifiers, see Geographical Location Codes. If you do not specify any locations, the service operation uses the location criterions of the specified AdGroupId or CampaignId. If none of these properties are set, then 190 (United States) is used by default.
  datatype: long
property:
  path: currencyCode
  name: currency code
  description: The ISO code for the monetary unit to use to calculate the cost estimates and suggested bid value. If not set, the service determines the currency from the account specified in the CustomerAccountId header element. If neither Currency or CustomerAccountId is set, the service uses USD.
  datatype: string
  max count: 1
  in: AED
  in: ALL
  in: AMD
  in: ARS
  in: AUD
  in: AZM
  in: BGL
  in: BHD
  in: BND
  in: BOB
  in: BRL
  in: BYB
  in: BZD
  in: CAD
  in: CHF
  in: CLP
  in: CNY
  in: COP
  in: CRC
  in: CZK
  in: DOP
  in: DKK
  in: DZD
  in: EEK
  in: EGP
  in: EUR
  in: GBP
  in: GEL
  in: GTQ
  in: HKD
  in: HNL
  in: HRK
  in: HUF
  in: IDR
  in: ILS
  in: INR
  in: IQD
  in: IRR
  in: ISK
  in: JMD
  in: JOD
  in: JPY
  in: KES
  in: KGS
  in: KRW
  in: KWD
  in: KZT
  in: LBP
  in: LTL
  in: LVL
  in: LYD
  in: MAD
  in: MKD
  in: MOP
  in: MNT
  in: MVR
  in: MXN
  in: MYR
  in: NIO
  in: NOK
  in: NZD
  in: OMR
  in: PAB
  in: PEN
  in: PHP
  in: PKR
  in: PLN
  in: PYG
  in: QAR
  in: ROL
  in: RUR
  in: SAR
  in: SEK
  in: SGD
  in: SIT
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign that owns the ad group specified in AdGroupId. If you do not specify an ad group, the campaign's performance data is used to help determine how well the keyword might perform in the context of the campaign. Specifying a campaign and ad group helps improve the accuracy of the suggested bid. If neither AdGroupId or CampaignId are specified, the operation uses the specified CustomerAccountId header element to help determine how well the keyword might perform in the context of the account.
  datatype: long
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group whose performance data is used to help determine how well the keyword might perform in the context of the ad group. Specifying an ad group helps improve the accuracy of the suggested bid. If you specify an ad group, you must specify the campaign that it belongs to.
  datatype: long
  max count: 1
property:
  path: entityLevelBid
  name: entity level bid
  description: Determines whether to return estimates for keyword level bids, ad group level bids, or both. - Set EntityLevelBid to Keyword to get an array of KeywordEstimatedBid corresponding to the specified keywords. - Set EntityLevelBid to AdGroup to get one EstimatedBidAndTraffic for the specified ad group. - Set EntityLevelBid to AllEntities to get an array of KeywordEstimatedBid for keywords and one EstimatedBidAndTraffic for an ad group. If you do not set EntityLevelBid, the default is to return only an array of KeywordEstimatedBid, or the equivalent of setting EntityLevelBid to Keyword. If you set EntityLevelBid to any value other thanKeyword, AdGroup, or AllEntities, the service will return Code 3501 with ErrorCode CampaignServiceBidLevelInvalid.
  datatype: string
  max count: 1

AdInsightKeywordAndMatchTypeShape
type: NodeShape
target class: AdInsightKeywordAndMatchType
property:
  path: keywordText
  name: keyword text
  description: The keyword text.
  datatype: string
  max count: 1
property:
  path: matchTypes
  name: match types
  description: The corresponding match types for the keyword.
  datatype: string
  in: Exact
  in: Phrase
  in: Broad
  in: Aggregate

AdInsightGetEstimatedBidByKeywordsResponseShape
type: NodeShape
target class: AdInsightGetEstimatedBidByKeywordsResponse
property:
  path: keywordEstimatedBids
  name: keyword estimated bids
  description: An array of KeywordEstimatedBid data objects. The array contains an item for each keyword specified in the request. If the keyword is not valid, the corresponding item in the array will be null. Each KeywordEstimatedBid contains a keyword and EstimatedPositions element. If data is available for the keyword, the EstimatedPositionAndTraffic will provide the suggested bid value that could have resulted in an ad appearing in the targeted position of the search results. Otherwise, the EstimatedPositions element will be set to null.
  node: AdInsightKeywordEstimatedBidShape
  class: AdInsightKeywordEstimatedBid
  node kind: BlankNodeOrIRI
property:
  path: adGroupEstimatedBid
  name: ad group estimated bid
  description: Contains estimates of clicks, average cost per click (CPC), impressions, click-through rate (CTR), and total cost for the specified ad group if you would use the suggested bid. The MatchType value within the EstimatedBidAndTraffic will always be Aggregate. In this context, it represents the default search bid for an ad group.
  node: AdInsightEstimatedBidAndTrafficShape
  class: AdInsightEstimatedBidAndTraffic
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightGetEstimatedPositionByKeywordIdsRequestShape
type: NodeShape
target class: AdInsightGetEstimatedPositionByKeywordIdsRequest
property:
  path: keywordIds
  name: keyword ids
  description: An array of identifiers of the keywords for which you want to get the estimated position in the search results, based on the specified bid value. You may specify a maximum of 1,000 keyword identifiers.
  datatype: long
property:
  path: maxBid
  name: max bid
  description: The maximum bid value to use to determine the estimated position in the search results. You must specify the bid value in the currency of the account.
  datatype: double
  max count: 1

AdInsightGetEstimatedPositionByKeywordIdsResponseShape
type: NodeShape
target class: AdInsightGetEstimatedPositionByKeywordIdsResponse
property:
  path: keywordEstimatedPositions
  name: keyword estimated positions
  description: A list of KeywordIdEstimatedPosition data objects. The array contains an item for each keyword specified in the request. If the keyword ID is not valid, the corresponding item in the array will be null. Each KeywordIdEstimatedPosition contains a keyword identifier and a KeywordEstimatedPosition. If data is available for the keyword, the EstimatedPositionAndTraffic will provide the estimated position in the search results, based on the specified bid value. Otherwise, the EstimatedPositions element will be set to null.
  node: AdInsightKeywordIdEstimatedPositionShape
  class: AdInsightKeywordIdEstimatedPosition
  node kind: BlankNodeOrIRI

AdInsightKeywordIdEstimatedPositionShape
type: NodeShape
target class: AdInsightKeywordIdEstimatedPosition
property:
  path: keywordId
  name: keyword id
  description: The identifier of the keyword to which the estimated position applies.
  datatype: long
  max count: 1
property:
  path: keywordEstimatedPosition
  name: keyword estimated position
  description: An object that contains the keyword string and estimated position in the search results given the specified maximum bid.
  node: AdInsightKeywordEstimatedPositionShape
  class: AdInsightKeywordEstimatedPosition
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightKeywordEstimatedPositionShape
type: NodeShape
target class: AdInsightKeywordEstimatedPosition
property:
  path: keyword
  name: keyword
  description: The keyword to which the estimates apply.
  datatype: string
  max count: 1
property:
  path: estimatedPositions
  name: estimated positions
  description: An array of EstimatedPositionAndTraffic data objects that contains the position in the search results corresponding to the specified maximum bid. Each object also contains estimates of clicks, average cost per click (CPC), impressions, click-through rate (CTR), and total cost given the specified bid. If there is no data available for a match type, the array will not include estimates for the match type.
  node: AdInsightEstimatedPositionAndTrafficShape
  class: AdInsightEstimatedPositionAndTraffic
  node kind: BlankNodeOrIRI

AdInsightGetEstimatedPositionByKeywordsRequestShape
type: NodeShape
target class: AdInsightGetEstimatedPositionByKeywordsRequest
property:
  path: keywords
  name: keywords
  description: An array of keywords for which you want to get the estimated position in the search results, based on the specified bid value. You may specify a maximum of 1,000 keywords and each keyword can contains a maximum of 100 characters.
  datatype: string
property:
  path: maxBid
  name: max bid
  description: The maximum bid value to use to determine the estimated position in the search results.
  datatype: double
  max count: 1
property:
  path: language
  name: language
  description: The language used in parallel with location identifiers for estimating the position. The language must be supported in each of the locations that you specify in LocationIds. For possible language values, see Ad Languages. If you do not specify the language, the service operation uses the language of the specified AdGroupId or CampaignId. If none of these properties are set, then EN (English) is used by default.
  datatype: string
  max count: 1
property:
  path: locationIds
  name: location ids
  description: The identifier or identifiers of the geographical locations to use for estimating the position. All of the locations must support the language specified in the Language element. Although you can specify multiple location identifiers, as a best practice for the most accurate position estimates per location, you should specify only one location per service call. For possible location identifiers, see Geographical Location Codes. If you do not specify any locations, the service operation uses the location criterions of the specified AdGroupId or CampaignId. If none of these properties are set, then 190 (United States) is used by default.
  datatype: long
property:
  path: currencyCode
  name: currency code
  description: The ISO code for the monetary unit to use to calculate the cost estimates and suggested bid value. If not set, the service determines the currency from the account specified in the CustomerAccountId header element. If neither Currency or CustomerAccountId is set, the service uses USD.
  datatype: string
  max count: 1
  in: AED
  in: ALL
  in: AMD
  in: ARS
  in: AUD
  in: AZM
  in: BGL
  in: BHD
  in: BND
  in: BOB
  in: BRL
  in: BYB
  in: BZD
  in: CAD
  in: CHF
  in: CLP
  in: CNY
  in: COP
  in: CRC
  in: CZK
  in: DOP
  in: DKK
  in: DZD
  in: EEK
  in: EGP
  in: EUR
  in: GBP
  in: GEL
  in: GTQ
  in: HKD
  in: HNL
  in: HRK
  in: HUF
  in: IDR
  in: ILS
  in: INR
  in: IQD
  in: IRR
  in: ISK
  in: JMD
  in: JOD
  in: JPY
  in: KES
  in: KGS
  in: KRW
  in: KWD
  in: KZT
  in: LBP
  in: LTL
  in: LVL
  in: LYD
  in: MAD
  in: MKD
  in: MOP
  in: MNT
  in: MVR
  in: MXN
  in: MYR
  in: NIO
  in: NOK
  in: NZD
  in: OMR
  in: PAB
  in: PEN
  in: PHP
  in: PKR
  in: PLN
  in: PYG
  in: QAR
  in: ROL
  in: RUR
  in: SAR
  in: SEK
  in: SGD
  in: SIT
property:
  path: matchTypes
  name: match types
  description: An array of unique match types for which you want to get estimates. You may not specify the Content match type.
  datatype: string
  in: Exact
  in: Phrase
  in: Broad
  in: Aggregate
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign that owns the ad group specified in AdGroupId. If you do not specify an ad group, the campaign's performance data is used to help determine how well the keyword might perform in the context of the campaign. Specifying a campaign and ad group helps improve the accuracy of the suggested position. If neither AdGroupId or CampaignId are specified, the operation uses the specified CustomerAccountId header element to help determine how well the keyword might perform in the context of the account.
  datatype: long
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group whose performance data is used to help determine how well the keyword might perform in the context of the ad group. Specifying an ad group helps improve the accuracy of the suggested position. If you specify an ad group, you must specify the campaign that it belongs to.
  datatype: long
  max count: 1

AdInsightGetEstimatedPositionByKeywordsResponseShape
type: NodeShape
target class: AdInsightGetEstimatedPositionByKeywordsResponse
property:
  path: keywordEstimatedPositions
  name: keyword estimated positions
  description: An array of KeywordEstimatedPosition data objects. The array contains an item for each keyword specified in the request. If the keyword is not valid, the corresponding item in the array will be null. If data is available for the keyword, the EstimatedPositionAndTraffic will provide the estimated position in the search results where your ads could appear, based on the specified bid value. Otherwise, the EstimatedPositions element will be set to null.
  node: AdInsightKeywordEstimatedPositionShape
  class: AdInsightKeywordEstimatedPosition
  node kind: BlankNodeOrIRI

AdInsightGetHistoricalKeywordPerformanceRequestShape
type: NodeShape
target class: AdInsightGetHistoricalKeywordPerformanceRequest
property:
  path: keywords
  name: keywords
  description: An array of keywords for which you want to get historical performance statistics. The array can contain a maximum of 1,000 keywords, and each keyword can contain a maximum of 100 characters.
  datatype: string
property:
  path: timeInterval
  name: time interval
  description: The time period that identifies the data to use to determine the key performance index of the specified keywords. For example, use data from the previous seven days or previous 30 days to determine the keyword performance. The default value is LastDay.
  datatype: string
  max count: 1
  in: LastMonth
  in: LastWeek
  in: LastDay
property:
  path: targetAdPosition
  name: target ad position
  description: The position of the search results for which you want to get performance data. For example, to get performance data when ads appeared in the first position of the mainline by using the keyword and match type, set this element to MainLine1. To get performance data when ads appeared in any position of the search results by using the keyword and match type, set this element to All. The default value is All. If you specify All for this element, the service will return multiple results per keyword for each supported ad position. If you specify Aggregate, the service will return one aggregated result. Sidebar ads no longer serve on Bing owned and operated sites in the United States. If you only request first page data e.g., FirstPage1 for the United States (US), then the KeywordKPIs element in the result will be nil/empty. If you include additional countries/regions e.g., US and CA in the same request, then any first page results are only attributed to countries/regions outside the United States.
  datatype: string
  max count: 1
  in: All
  in: MainLine1
  in: MainLine2
  in: MainLine3
  in: MainLine4
  in: FirstPage1
  in: FirstPage2
  in: FirstPage3
  in: FirstPage4
  in: FirstPage5
  in: FirstPage6
  in: FirstPage7
  in: FirstPage8
  in: FirstPage9
  in: FirstPage10
  in: Aggregate
property:
  path: matchTypes
  name: match types
  description: The match types for which you want to get historical data. You may not specify the Content match type.
  datatype: string
  in: Exact
  in: Phrase
  in: Broad
  in: Aggregate
property:
  path: language
  name: language
  description: The language in which the keywords are written. The countries/regions that you specify in the PublisherCountries element must support the specified language. Possible values include Danish, Dutch, English, Finnish, French, German, Italian, Norwegian, Portuguese, Spanish, Swedish, and TraditionalChinese.
  datatype: string
  max count: 1
property:
  path: publisherCountries
  name: publisher countries
  description: The country codes of the countries/regions to use as the source of the historical data. You can specify one or more country codes. Each country/region that you specify must support the language specified in the Language element. The following language and country/region combinations are supported: Danish: DK Dutch: NL English: AU, CA, GB, ID, IN, MY, PH, SG, TH, US, VN Finnish: FI French: CA, FR German: AT, CH, DE Italian: IT Norwegian: NB Portuguese: BR Spanish: AR, CL, CO, ES, MX, PE, VE Swedish: SE TraditionalChinese: HK, TW If this element is null, then by default the service includes all countries/regions that support the specified language.
  datatype: string
property:
  path: devices
  name: devices
  description: A list of one or more of the following device types: Computers, NonSmartphones, Smartphones, Tablets. The default is Computers. The response includes keyword performance data for the device types that you specify only, if available. Used to determine a keyword's performance on the specified device types.
  datatype: string

AdInsightGetHistoricalKeywordPerformanceResponseShape
type: NodeShape
target class: AdInsightGetHistoricalKeywordPerformanceResponse
property:
  path: keywordHistoricalPerformances
  name: keyword historical performances
  description: An array of KeywordHistoricalPerformance data objects. The array contains an item for each keyword, device, match type, and ad position specified in the request. If the keyword is not valid or has no data available, the corresponding item in the array will be null.
  node: AdInsightKeywordHistoricalPerformanceShape
  class: AdInsightKeywordHistoricalPerformance
  node kind: BlankNodeOrIRI

AdInsightKeywordHistoricalPerformanceShape
type: NodeShape
target class: AdInsightKeywordHistoricalPerformance
property:
  path: keyword
  name: keyword
  description: The keyword to which the keyword performance data applies.
  datatype: string
  max count: 1
property:
  path: keywordKPIs
  name: keyword kpis
  description: An array of KeywordKPI objects that contains the performance data. For each requested keyword that has no available data, the KeywordKPI element will be nil. If the request specified a specific target position, the array will contain only one item per requested keyword. If the request specified All for the target position, then for each requested keyword the array will contain an item for each possible position in the search results. Sidebar ads no longer serve on Bing owned and operated sites in the United States. If you only request first page data e.g., FirstPage1 for the United States (US), then this element will be nil/empty. If you include additional countries/regions e.g., US and CA in the same request, then any first page results are only attributed to countries/regions outside the United States.
  node: AdInsightKeywordKPIShape
  class: AdInsightKeywordKPI
  node kind: BlankNodeOrIRI

AdInsightKeywordKPIShape
type: NodeShape
target class: AdInsightKeywordKPI
property:
  path: device
  name: device
  description: The device where the ad appeared.
  datatype: string
  max count: 1
property:
  path: matchType
  name: match type
  description: The match type that you specified in the request.
  datatype: string
  max count: 1
  in: Exact
  in: Phrase
  in: Broad
  in: Aggregate
property:
  path: adPosition
  name: ad position
  description: The position in the search results in which the ad appeared.
  datatype: string
  max count: 1
  in: All
  in: MainLine1
  in: MainLine2
  in: MainLine3
  in: MainLine4
  in: FirstPage1
  in: FirstPage2
  in: FirstPage3
  in: FirstPage4
  in: FirstPage5
  in: FirstPage6
  in: FirstPage7
  in: FirstPage8
  in: FirstPage9
  in: FirstPage10
  in: Aggregate
property:
  path: clicks
  name: clicks
  description: The number of clicks that the keyword and match type generated during the specified time interval.
  datatype: int
  max count: 1
property:
  path: impressions
  name: impressions
  description: The number of impressions that the keyword and match type generated during the specified time interval.
  datatype: long
  max count: 1
property:
  path: averageCPC
  name: average cpc
  description: The average cost per click (CPC). The average CPC is calculated by dividing the cost of all clicks by the number of clicks.
  datatype: double
  max count: 1
property:
  path: cTR
  name: c tr
  description: The click-through rate (CTR) as a percentage. The CTR is calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100.
  datatype: double
  max count: 1
property:
  path: totalCost
  name: total cost
  description: The cost of using the specified keyword and match type during the specified time interval. The service determines the currency from the account specified in the CustomerAccountId header element. If CustomerAccountId is not set, the service uses USDollar.
  datatype: double
  max count: 1
property:
  path: averageBid
  name: average bid
  description: The average bid of the keyword.
  datatype: double
  max count: 1

AdInsightGetHistoricalSearchCountRequestShape
type: NodeShape
target class: AdInsightGetHistoricalSearchCountRequest
property:
  path: keywords
  name: keywords
  description: An array of keywords for which you want to determine the number of times that the keyword was used in a search query. The array can contain a maximum of 1,000 keywords, and each keyword can contain a maximum of 100 characters.
  datatype: string
property:
  path: language
  name: language
  description: The language in which the keywords are written. The countries/regions that you specify in the PublisherCountries element must support the specified language. For possible values, see Supported Languages.
  datatype: string
  max count: 1
property:
  path: publisherCountries
  name: publisher countries
  description: The country codes of the countries/regions to use as the source of the historical data. You can specify one or more country codes. Each country/region that you specify must support the language specified in the Language element. For possible values, see Ad Languages. If Null, the default is all countries/regions that support the specified language.
  datatype: string
property:
  path: startDate
  name: start date
  description: The start date of the date range that identifies the data that you want to use to determine the historical search count. This date must be earlier than or the same as the specified end date. The date should be later than the maximum available historical data range corresponding to the specified TimePeriodRollup element. The effective start date may be adjusted if the specified TimePeriodRollup is Weekly or Monthly.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: The end date of the date range that identifies the data that you want to use to determine the historical search count. The date cannot be later than today's date, and must be later than or the same as the specified start date. The effective end date may be adjusted if the specified TimePeriodRollup is Weekly or Monthly.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: timePeriodRollup
  name: time period rollup
  description: You may specify whether to return data aggregated daily, weekly, or monthly. For a list of supported values, see the Remarks section below.
  datatype: string
  max count: 1
property:
  path: devices
  name: devices
  description: A list of one or more of the following device types: Computers, NonSmartphones, Smartphones, Tablets. The default is Computers. The response includes search counts for the device types that you specify only, if available.
  datatype: string

AdInsightGetHistoricalSearchCountResponseShape
type: NodeShape
target class: AdInsightGetHistoricalSearchCountResponse
property:
  path: keywordSearchCounts
  name: keyword search counts
  description: An array of KeywordSearchCount data objects. The array contains an item for each keyword specified in the request. If the keyword is not valid, the corresponding item in the array will be null. Each KeywordSearchCount contains an array of SearchCountsByAttributes. The array contains an item for each unique device specified in the request.
  node: AdInsightKeywordSearchCountShape
  class: AdInsightKeywordSearchCount
  node kind: BlankNodeOrIRI

AdInsightKeywordSearchCountShape
type: NodeShape
target class: AdInsightKeywordSearchCount
property:
  path: keyword
  name: keyword
  description: The keyword to which the search count data applies.
  datatype: string
  max count: 1
property:
  path: searchCountsByAttributes
  name: search counts by attributes
  description: An array of SearchCountsByAttributes objects that contain search counts for each device and network where the keyword was included in a search query. For each requested keyword that has no available data, the SearchCountsByAttributes element will be nil.
  node: AdInsightSearchCountsByAttributesShape
  class: AdInsightSearchCountsByAttributes
  node kind: BlankNodeOrIRI

AdInsightSearchCountsByAttributesShape
type: NodeShape
target class: AdInsightSearchCountsByAttributes
property:
  path: device
  name: device
  description: The device of the user who entered the search query.
  datatype: string
  max count: 1
property:
  path: historicalSearchCounts
  name: historical search counts
  description: An array of HistoricalSearchCountPeriodic objects that contain a count of the number of times that the keyword was used in a search query. The array contains an item for each month in the specified date range. The items are ordered by calendar month. For each requested keyword that has no available data, the HistoricalSearchCountPeriodic element will be nil.
  node: AdInsightHistoricalSearchCountPeriodicShape
  class: AdInsightHistoricalSearchCountPeriodic
  node kind: BlankNodeOrIRI

AdInsightHistoricalSearchCountPeriodicShape
type: NodeShape
target class: AdInsightHistoricalSearchCountPeriodic
property:
  path: searchCount
  name: search count
  description: The number of times that the keyword was used in a search query on the specified device type during the time period. The count aggregates data from all specified countries or regions.
  datatype: long
  max count: 1
property:
  path: dayMonthAndYear
  name: day month and year
  description: The time period in which the count was captured. The type of aggregation (daily, weekly, or monthly) that you specify in the request determines the length of the time period. For example, if you specified weekly aggregation, the time period is a week and the date is the Sunday of the week when the count was captured.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightGetKeywordCategoriesRequestShape
type: NodeShape
target class: AdInsightGetKeywordCategoriesRequest
property:
  path: keywords
  name: keywords
  description: An array of keywords for which you want to determine the possible keyword categories that each keyword belongs to. The array can contain a maximum of 1,000 keywords, and each keyword can contain a maximum of 100 characters.
  datatype: string
property:
  path: language
  name: language
  description: The language in which the keywords are written. You must set this element to English.
  datatype: string
  max count: 1
property:
  path: publisherCountry
  name: publisher country
  description: The country code of the country/region to use as the source of the category data. You must set this element to US.
  datatype: string
  max count: 1
property:
  path: maxCategories
  name: max categories
  description: The number of categories to include in the results. The maximum number of categories that you can request is 5. The default is 5.
  datatype: int
  max count: 1

AdInsightGetKeywordCategoriesResponseShape
type: NodeShape
target class: AdInsightGetKeywordCategoriesResponse
property:
  path: result
  name: result
  description: An array of KeywordCategoryResult data objects. Each object contains the keyword and a list of categories to which it belongs. The list will include an item for each keyword that you specified in the request. If the keyword category cannot be determined, the KeywordCategories list will contain a single KeywordCategory. The value of Category will be Unknown Category and the value of ConfidenceScore will be 0.0.
  node: AdInsightKeywordCategoryResultShape
  class: AdInsightKeywordCategoryResult
  node kind: BlankNodeOrIRI

AdInsightKeywordCategoryResultShape
type: NodeShape
target class: AdInsightKeywordCategoryResult
property:
  path: keyword
  name: keyword
  description: The keyword being categorized.
  datatype: string
  max count: 1
property:
  path: keywordCategories
  name: keyword categories
  description: An array of KeywordCategory objects that contains a keyword category and a score that indicates the confidence that the keyword belongs to that keyword category.
  node: AdInsightKeywordCategoryShape
  class: AdInsightKeywordCategory
  node kind: BlankNodeOrIRI

AdInsightKeywordCategoryShape
type: NodeShape
target class: AdInsightKeywordCategory
property:
  path: category
  name: category
  description: The keyword category that the keyword might belong to. If the category is undetermined, this element is set to Unknown Category and the ConfidenceScore element is set to 0.0.
  datatype: string
  max count: 1
property:
  path: confidenceScore
  name: confidence score
  description: A score from 0.0 to 1.0 that indicates the likelihood that the keyword belongs to the category.
  datatype: double
  max count: 1

AdInsightGetKeywordDemographicsRequestShape
type: NodeShape
target class: AdInsightGetKeywordDemographicsRequest
property:
  path: keywords
  name: keywords
  description: An array of keywords for which you want to get demographics data. The data is also broken out by device type. The array can contain a maximum of 1,000 keywords, and each keyword can contain a maximum of 100 characters.
  datatype: string
property:
  path: language
  name: language
  description: The language in which the keywords are written. For possible values, see Ad Languages.
  datatype: string
  max count: 1
property:
  path: publisherCountry
  name: publisher country
  description: The country code of the country/region to use as the source of the demographics data. The country/region that you specify must support the language specified in the Language element. For possible values, see Ad Languages.
  datatype: string
  max count: 1
property:
  path: device
  name: device
  description: An array of devices for which you want to get demographics data. Supported device types include the following: Computers, NonSmartphones, Smartphones, Tablets. The default is Computers. If available the response only includes keyword demographics data for the device types that you specify.
  datatype: string

AdInsightGetKeywordDemographicsResponseShape
type: NodeShape
target class: AdInsightGetKeywordDemographicsResponse
property:
  path: keywordDemographicResult
  name: keyword demographic result
  description: An array of KeywordDemographicResult data objects. The order of the items corresponds directly to the keywords specified in the request. If there is no demographic data available for a keyword, the keyword will be included in the list, but the KeywordDemographics element of the corresponding KeywordDemographicResult will be null. Each KeywordDemographicResult contains an array of KeywordDemographic data objects. The array contains an item for each device specified in the request. Each KeywordDemographic contains the percentage of time that users of a certain age and gender searched for the specified keyword.
  node: AdInsightKeywordDemographicResultShape
  class: AdInsightKeywordDemographicResult
  node kind: BlankNodeOrIRI

AdInsightKeywordDemographicResultShape
type: NodeShape
target class: AdInsightKeywordDemographicResult
property:
  path: keyword
  name: keyword
  description: The keyword.
  datatype: string
  max count: 1
property:
  path: keywordDemographics
  name: keyword demographics
  description: An array of KeywordDemographic data objects that contains the percentage of users by age and gender (if known) that searched for the keyword on the device.
  node: AdInsightKeywordDemographicShape
  class: AdInsightKeywordDemographic
  node kind: BlankNodeOrIRI

AdInsightKeywordDemographicShape
type: NodeShape
target class: AdInsightKeywordDemographic
property:
  path: device
  name: device
  description: The device of the user who entered the search query.
  datatype: string
  max count: 1
property:
  path: eighteenToTwentyFour
  name: eighteen to twenty four
  description: The percentage of time that users 18 through 24 years of age searched for the keyword. The value is specified in the range 0.0 through 1.0.
  datatype: double
  max count: 1
property:
  path: twentyFiveToThirtyFour
  name: twenty five to thirty four
  description: The percentage of time that users 25 through 34 years of age searched for the keyword. The value is specified in the range 0.0 through 1.0.
  datatype: double
  max count: 1
property:
  path: thirtyFiveToFourtyNine
  name: thirty five to fourty nine
  description: The percentage of time that users 35 through 49 years of age searched for the keyword. The value is specified in the range 0.0 through 1.0.
  datatype: double
  max count: 1
property:
  path: fiftyToSixtyFour
  name: fifty to sixty four
  description: The percentage of time that users 50 through 64 years of age searched for the keyword. The value is specified in the range 0.0 through 1.0.
  datatype: double
  max count: 1
property:
  path: sixtyFiveAndAbove
  name: sixty five and above
  description: The percentage of time that users 65 years of age or older searched for the keyword. The value is specified in the range 0.0 through 1.0.
  datatype: double
  max count: 1
property:
  path: ageUnknown
  name: age unknown
  description: Not used.
  datatype: double
  max count: 1
property:
  path: female
  name: female
  description: The percentage of time that female users searched for the keyword. The value is specified in the range 0.0 through 1.0.
  datatype: double
  max count: 1
property:
  path: male
  name: male
  description: The percentage of time that male users searched for the keyword. The value is specified in the range 0.0 through 1.0.
  datatype: double
  max count: 1
property:
  path: genderUnknown
  name: gender unknown
  description: Not Used.
  datatype: double
  max count: 1

AdInsightGetKeywordIdeaCategoriesResponseShape
type: NodeShape
target class: AdInsightGetKeywordIdeaCategoriesResponse
property:
  path: keywordIdeaCategories
  name: keyword idea categories
  description: The list of keyword idea categories.
  node: AdInsightKeywordIdeaCategoryShape
  class: AdInsightKeywordIdeaCategory
  node kind: BlankNodeOrIRI

AdInsightKeywordIdeaCategoryShape
type: NodeShape
target class: AdInsightKeywordIdeaCategory
property:
  path: categoryId
  name: category id
  description: The Microsoft Advertising identifier of the keyword idea category.
  datatype: long
  max count: 1
property:
  path: categoryName
  name: category name
  description: The name of the keyword idea category.
  datatype: string
  max count: 1

AdInsightGetKeywordIdeasRequestShape
type: NodeShape
target class: AdInsightGetKeywordIdeasRequest
property:
  path: expandIdeas
  name: expand ideas
  description: Determines whether you want new keyword ideas, or if you only want keyword attributes for the set of keywords that you specified in the SearchParameters list. If you set this element false, the QuerySearchParameter object must be included in the SearchParameters list.
  datatype: boolean
  max count: 1
property:
  path: ideaAttributes
  name: idea attributes
  description: The keyword idea attributes that you want included in the response e.g., Keyword, Competition, MonthlySearchCounts, and SuggestedBid. The Competition attribute is required. The Keyword attribute will always be returned for each returned KeywordIdea whether or not you include the Keyword value in the requested list of idea attributes.
  datatype: string
  in: AdGroupId
  in: AdGroupName
  in: Keyword
  in: Source
  in: MonthlySearchCounts
  in: SuggestedBid
  in: Competition
  in: Relevance
  in: AdImpressionShare
property:
  path: searchParameters
  name: search parameters
  description: The search parameters define your criteria and filters for the requested keyword ideas. Do not try to instantiate a SearchParameter. You can include one or more the following objects that derive from it: CategorySearchParameter, CompetitionSearchParameter, DateRangeSearchParameter, DeviceSearchParameter, ExcludeAccountKeywordsSearchParameter, IdeaTextSearchParameter, ImpressionShareSearchParameter, LanguageSearchParameter, LocationSearchParameter, NetworkSearchParameter, QuerySearchParameter, SearchVolumeSearchParameter, SuggestedBidSearchParameter and UrlSearchParameter. Other objects that derive from SearchParameter are not valid for this operation. You cannot include duplicates of any search parameter type. The list must include all of these search parameters: LanguageSearchParameter, LocationSearchParameter, and NetworkSearchParameter. The list must include one or more of these search parameters: CategorySearchParameter, QuerySearchParameter, or UrlSearchParameter. If the ExpandIdeas element is false, then the QuerySearchParameter is required whether or not you included additional search parameters. It can take up to 72 hours for the previous calendar month's data to be available. For example, if you request keyword ideas on August 1st, 2nd or 3rd, and July's data is not ready, the response will be based on June's data. If you do not include the DateRangeSearchParameter in the GetKeywordIdeas request, then you will not be able to confirm whether the first list item is data for the previous month, or the month prior. If the date range is specified and the most recent month's data is not yet available, then GetKeywordIdeas will return an error.
  or:
    node: AdInsightAuctionSegmentSearchParameterShape
    class: AdInsightAuctionSegmentSearchParameter
  or:
    node: AdInsightCategorySearchParameterShape
    class: AdInsightCategorySearchParameter
  or:
    node: AdInsightCompetitionSearchParameterShape
    class: AdInsightCompetitionSearchParameter
  or:
    node: AdInsightDateRangeSearchParameterShape
    class: AdInsightDateRangeSearchParameter
  or:
    node: AdInsightDeviceSearchParameterShape
    class: AdInsightDeviceSearchParameter
  or:
    node: AdInsightExcludeAccountKeywordsSearchParameterShape
    class: AdInsightExcludeAccountKeywordsSearchParameter
  or:
    node: AdInsightIdeaTextSearchParameterShape
    class: AdInsightIdeaTextSearchParameter
  or:
    node: AdInsightImpressionShareSearchParameterShape
    class: AdInsightImpressionShareSearchParameter
  or:
    node: AdInsightLanguageSearchParameterShape
    class: AdInsightLanguageSearchParameter
  or:
    node: AdInsightLocationSearchParameterShape
    class: AdInsightLocationSearchParameter
  or:
    node: AdInsightNetworkSearchParameterShape
    class: AdInsightNetworkSearchParameter
  or:
    node: AdInsightQuerySearchParameterShape
    class: AdInsightQuerySearchParameter
  or:
    node: AdInsightSearchParameterShape
    class: AdInsightSearchParameter
  or:
    node: AdInsightSearchVolumeSearchParameterShape
    class: AdInsightSearchVolumeSearchParameter
  or:
    node: AdInsightSuggestedBidSearchParameterShape
    class: AdInsightSuggestedBidSearchParameter
  or:
    node: AdInsightUrlSearchParameterShape
    class: AdInsightUrlSearchParameter
  node kind: BlankNodeOrIRI

AdInsightGetKeywordIdeasResponseShape
type: NodeShape
target class: AdInsightGetKeywordIdeasResponse
property:
  path: keywordIdeas
  name: keyword ideas
  description: The list of keyword ideas. Currently up to 3,000 list items can be returned although the limit is subject to change.
  node: AdInsightKeywordIdeaShape
  class: AdInsightKeywordIdea
  node kind: BlankNodeOrIRI

AdInsightKeywordIdeaShape
type: NodeShape
target class: AdInsightKeywordIdea
property:
  path: keyword
  name: keyword
  description: The suggested keyword.
  datatype: string
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The negative ad group identifier that groups keyword ideas into suggested new ad groups. Keyword ideas for existing ad group identifiers is not supported. If the ad group ID is null then the keyword idea Source element is set to Seed, and there is not any specific recommended ad group.
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  description: The suggested name of the ad group for the keyword idea. If the ad group name is null then the keyword idea Source element is set to Seed, and there is not any specific recommended ad group.
  datatype: string
  max count: 1
property:
  path: source
  name: source
  description: The source or seed for the keyword.
  datatype: string
  max count: 1
  in: Unknown
  in: Seed
  in: SuggestionFromKeyword
  in: SuggestionFromUrl
  in: SuggestionFromCategory
property:
  path: monthlySearchCounts
  name: monthly search counts
  description: The number of times this keyword was used as a search term for each month within the date range and targeting settings you've selected. By default the size of the list is 12 and the last 12 months of available data are returned. The search counts are sorted in order starting with the most recent month's data at MonthlySeachCounts[0]. It can take up to 72 hours for the previous calendar month's data to be available. For example, if you request keyword ideas on August 1st, 2nd or 3rd, and July's data is not ready, the response will be based on June's data. If you do not include the DateRangeSearchParameter in the GetKeywordIdeas request, then you will not be able to confirm whether the first list item is data for the previous month, or the month prior. If the date range is specified and the most recent month's data is not yet available, then GetKeywordIdeas will return an error.
  datatype: long
property:
  path: suggestedBid
  name: suggested bid
  description: The suggested minimum bid for this keyword. We create this suggestion using the location and network criterion you included, along with the average cost-per-click (CPC) advertisers are paying for this keyword. This amount is only an estimate and your actual CPC may vary.
  datatype: double
  max count: 1
property:
  path: competition
  name: competition
  description: Determined by the number of advertisers bidding on this keyword, relative to all other keywords across Microsoft Advertising.
  datatype: string
  max count: 1
  in: Low
  in: Medium
  in: High
property:
  path: relevance
  name: relevance
  description: The keyword relevance score. Higher relevance means "more relevant". There is no defined range, but as an example you might see values such as 1.00 or 87,083.82. Although the values are not displayed, relevance is used to sort Keyword Planner results by relevance in the Microsoft Advertising UI.
  datatype: double
  max count: 1
property:
  path: adImpressionShare
  name: ad impression share
  description: Ad impression share is the number of impressions you've received divided by the total number of searches for the location and network you're targeting that matched the keyword exactly in the last calendar month.
  datatype: double
  max count: 1

AdInsightGetKeywordLocationsRequestShape
type: NodeShape
target class: AdInsightGetKeywordLocationsRequest
property:
  path: keywords
  name: keywords
  description: An array of keywords for which you want to get geographical location information. The data is also broken out by device type. The array can contain a maximum of 1,000 keywords, and each keyword can contain a maximum of 100 characters.
  datatype: string
property:
  path: language
  name: language
  description: The language in which the keywords are written. For possible values, see Ad Languages.
  datatype: string
  max count: 1
property:
  path: publisherCountry
  name: publisher country
  description: The country code of the country/region to use as the source of the location data. The country/region that you specify must support the language specified in the Language element. For possible values, see Ad Languages.
  datatype: string
  max count: 1
property:
  path: device
  name: device
  description: An array of devices for which you want to get geographical location information. Supported device types include the following: Computers, NonSmartphones, Smartphones, Tablets. The default is Computers. The response includes keyword locations data for only the device types that you specify, if available.
  datatype: string
property:
  path: level
  name: level
  description: The level at which to aggregate the geographical location data. The following are the possible values: 0 - Country 1 - State/Province 2 - Metropolitan area 3 - City The default value is 1 (State/Province).
  datatype: int
  max count: 1
property:
  path: parentCountry
  name: parent country
  description: The country/region from which the search originated. For possible values, see Geographical Location Codes. The default is US.
  datatype: string
  max count: 1
property:
  path: maxLocations
  name: max locations
  description: The maximum number of locations to return. You can request a maximum of 10 locations. The default value is 10.
  datatype: int
  max count: 1

AdInsightGetKeywordLocationsResponseShape
type: NodeShape
target class: AdInsightGetKeywordLocationsResponse
property:
  path: keywordLocationResult
  name: keyword location result
  description: An array of KeywordLocationResult data objects. The order of the items corresponds directly to the keywords specified in the request. If there is no location data available for a keyword, the keyword will be included in the list, but the KeywordLocations element of the corresponding KeywordLocationResult object will be null. Each KeywordLocationResult data object contains an array of KeywordLocation. The array contains an item for each device specified in the request. Each KeywordLocation contains the geographical location and percentage of time that users in the geographical location searched for the specified keyword.
  node: AdInsightKeywordLocationResultShape
  class: AdInsightKeywordLocationResult
  node kind: BlankNodeOrIRI

AdInsightKeywordLocationResultShape
type: NodeShape
target class: AdInsightKeywordLocationResult
property:
  path: keyword
  name: keyword
  description: The keyword.
  datatype: string
  max count: 1
property:
  path: keywordLocations
  name: keyword locations
  description: An array of KeywordLocation objects that contains the geographical locations and the percentage of times that users searched for the keyword from that location.
  node: AdInsightKeywordLocationShape
  class: AdInsightKeywordLocation
  node kind: BlankNodeOrIRI

AdInsightKeywordLocationShape
type: NodeShape
target class: AdInsightKeywordLocation
property:
  path: device
  name: device
  description: The device of the user who entered the search query.
  datatype: string
  max count: 1
property:
  path: location
  name: location
  description: The country/region, state, metropolitan area, or city where users entered the search query.
  datatype: string
  max count: 1
property:
  path: percentage
  name: percentage
  description: The percentage of time that users searched for the keyword from the location. The value is specified in the range 0.0 through 100.0.
  datatype: double
  max count: 1

AdInsightGetKeywordOpportunitiesRequestShape
type: NodeShape
target class: AdInsightGetKeywordOpportunitiesRequest
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group to get keyword suggestions for. The following restrictions apply to the specified ad group: - Its language must be set to English. - Its distribution medium must include Search. - It should contain keywords and ads. The operation will suggest keywords only if the ad group contains one or more ads and keywords; the more keywords and ads that the ad group contains, the richer the set of suggested keywords will be. If AdGroupId is nil or empty, the operation will return all keyword opportunities for the specified campaign.
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign that owns the specified ad group. If the CampaignId element is nil or empty, then the AdGroupId must also be nil or empty, and the operation will return all keyword opportunities for the account.
  datatype: long
  max count: 1
property:
  path: opportunityType
  name: opportunity type
  description: Determines the type or types of keyword opportunities that you want. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, BroadMatch CampaignContext.
  datatype: string
  max count: 1

AdInsightGetKeywordOpportunitiesResponseShape
type: NodeShape
target class: AdInsightGetKeywordOpportunitiesResponse
property:
  path: opportunities
  name: opportunities
  description: A list of KeywordOpportunity data objects that identifies a suggested keyword and bid value. The list will be empty if there are no suggestions, which may occur if the ad group does not contain existing ads and keywords. Currently up to 1,000 list items can be returned although the limit is subject to change.
  or:
    node: AdInsightBroadMatchKeywordOpportunityShape
    class: AdInsightBroadMatchKeywordOpportunity
  or:
    node: AdInsightKeywordOpportunityShape
    class: AdInsightKeywordOpportunity
  or:
    node: AdInsightKeywordOpportunityBaseShape
    class: AdInsightKeywordOpportunityBase
  node kind: BlankNodeOrIRI

AdInsightKeywordOpportunityShape
type: NodeShape
target class: AdInsightKeywordOpportunity
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group to apply the suggested keyword to.
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign that owns the ad group.
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  description: The name of the ad group to apply the suggested keyword to.
  datatype: string
  max count: 1
property:
  path: campaignName
  name: campaign name
  description: The name of the campaign that owns the ad group.
  datatype: string
  max count: 1
property:
  path: matchType
  name: match type
  description: The match type that the suggested bid applies to. The following are the possible match-type values: 1 - Exact match 2 - Phrase match 3 - Broad match
  datatype: int
  max count: 1
property:
  path: suggestedKeyword
  name: suggested keyword
  description: The suggested keyword.
  datatype: string
  max count: 1
property:
  path: suggestedBid
  name: suggested bid
  description: The suggested bid that may result in your ads serving on the first page of the search query results.
  datatype: double
  max count: 1
property:
  path: monthlySearches
  name: monthly searches
  description: The estimated monthly volume of user search queries that may match the suggested keyword for the corresponding MatchType element.
  datatype: long
  max count: 1
property:
  path: competition
  name: competition
  description: An indicator of competitive bids for this keyword relative to all search keywords. The competition score ranges from 0 to 1.00, where 0 indicates low competition and 1.00 indicates that there is a high number of advertisers competing for this keyword.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: Estimated increase in clicks if the opportunity is applied.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: Estimated increase in cost if the opportunity is applied.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: Estimated increase in impressions if the opportunity is applied.
  datatype: long
  max count: 1
property:
  path: opportunityKey
  name: opportunity key
  description: An identifier that uniquely identifies the opportunity.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: clickShare
  name: click share
  datatype: double
  max count: 1
property:
  path: averageCTR
  name: average ctr
  datatype: double
  max count: 1
property:
  path: averageCPC
  name: average cpc
  datatype: double
  max count: 1
property:
  path: referenceKeywordId
  name: reference keyword id
  datatype: long
  max count: 1
property:
  path: referenceKeywordBid
  name: reference keyword bid
  datatype: double
  max count: 1
property:
  path: referenceKeywordMatchType
  name: reference keyword match type
  datatype: int
  max count: 1
property:
  path: impressionShare
  name: impression share
  datatype: double
  max count: 1
property:
  path: searchQueryKPIs
  name: search query kpis
  node: AdInsightBroadMatchSearchQueryKPIShape
  class: AdInsightBroadMatchSearchQueryKPI
  node kind: BlankNodeOrIRI

AdInsightGetKeywordTrafficEstimatesRequestShape
type: NodeShape
target class: AdInsightGetKeywordTrafficEstimatesRequest
property:
  path: campaignEstimators
  name: campaign estimators
  description: Defines your campaign, ad group, and keyword level criteria and filters for the requested keyword traffic estimates.
  node: AdInsightCampaignEstimatorShape
  class: AdInsightCampaignEstimator
  node kind: BlankNodeOrIRI

AdInsightGetKeywordTrafficEstimatesResponseShape
type: NodeShape
target class: AdInsightGetKeywordTrafficEstimatesResponse
property:
  path: campaignEstimates
  name: campaign estimates
  description: The list of campaign estimates. Within each campaign estimate is a nested list of keyword traffic estimates for each ad group. You can inspect the BatchError Details element to find out which of the requested list items failed. For example if Details contains "CampaignEstimators[0], AdGroupEstimators[1], KeywordEstimators is null or contains no value", the error occurred for the 2nd AdGroupEstimator in the submitted list. The Index element of the BatchError is only a sequential count of returned batch errors, and cannot be used to determine where in the request the error occurred.
  node: AdInsightCampaignEstimateShape
  class: AdInsightCampaignEstimate
  node kind: BlankNodeOrIRI

AdInsightGetPerformanceInsightsDetailDataByAccountIdRequestShape
type: NodeShape
target class: AdInsightGetPerformanceInsightsDetailDataByAccountIdRequest
property:
  path: entityType
  name: entity type
  description: The entity level that you want to request performance insights summary data from. We currently support account and campaign level data.
  datatype: string
  max count: 1
  in: Account
  in: Campaign
  in: AdGroup
  in: Keyword
property:
  path: startDate
  name: start date
  description: The start date range for performance insights.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: The end date range for performance insights. The maximum date range is one month.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightGetPerformanceInsightsDetailDataByAccountIdResponseShape
type: NodeShape
target class: AdInsightGetPerformanceInsightsDetailDataByAccountIdResponse
property:
  path: result
  name: result
  description: Defines the performance insight results from calling the GetPerformanceInsightsDetailDataByAccountId operation.
  node: AdInsightPerformanceInsightsDetailShape
  class: AdInsightPerformanceInsightsDetail
  node kind: BlankNodeOrIRI

AdInsightPerformanceInsightsDetailShape
type: NodeShape
target class: AdInsightPerformanceInsightsDetail
property:
  path: entityId
  name: entity id
  description: For account level, this is AccountId. For campaign level, this is CampaignId.
  datatype: long
  max count: 1
property:
  path: entityType
  name: entity type
  description: The supported types are account and campaign.
  datatype: string
  max count: 1
  in: Account
  in: Campaign
  in: AdGroup
  in: Keyword
property:
  path: kPIType
  name: k pitype
  description: Defines the type of key performance indicator. At the account level, we support impression, click, spend, and conversion. At the campaign level, we support impression, click, and spend.
  datatype: string
  max count: 1
  in: Impression
  in: Click
  in: Spend
  in: Conversion
property:
  path: date
  name: date
  description: The date of the detected performance insights.
  node: AdInsightDayMonthAndYearShape
  class: AdInsightDayMonthAndYear
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: description
  name: description
  description: A message to describe the performance insights.
  node: AdInsightPerformanceInsightsMessageShape
  class: AdInsightPerformanceInsightsMessage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: rootCauses
  name: root causes
  description: Messages that describe the root causes in "What happened."
  node: AdInsightPerformanceInsightsMessageShape
  class: AdInsightPerformanceInsightsMessage
  node kind: BlankNodeOrIRI
property:
  path: actions
  name: actions
  description: Messages that describe the actions in "What can I do."
  node: AdInsightPerformanceInsightsMessageShape
  class: AdInsightPerformanceInsightsMessage
  node kind: BlankNodeOrIRI

AdInsightPerformanceInsightsMessageShape
type: NodeShape
target class: AdInsightPerformanceInsightsMessage
property:
  path: templateId
  name: template id
  description: The message template ID.
  datatype: string
  max count: 1
  in: FluxImprIncreaseAcct
  in: FluxImprDecreaseAcct
  in: FluxImprIncreaseInfinityAcct
  in: FluxImprIncreaseAcctPrevDay
  in: FluxImprDecreaseAcctPrevDay
  in: FluxImprIncreaseInfinityAcctPrevDay
  in: FluxClickIncreaseAcct
  in: FluxClickDecreaseAcct
  in: FluxClickIncreaseInfinityAcct
  in: FluxClickIncreaseAcctPrevDay
  in: FluxClickDecreaseAcctPrevDay
  in: FluxClickIncreaseInfinityAcctPrevDay
  in: FluxCostIncreaseAcct
  in: FluxCostDecreaseAcct
  in: FluxCostIncreaseInfinityAcct
  in: FluxCostIncreaseAcctPrevDay
  in: FluxCostDecreaseAcctPrevDay
  in: FluxCostIncreaseInfinityAcctPrevDay
  in: FluxImprIncreaseCampaign
  in: FluxImprDecreaseCampaign
  in: FluxImprIncreaseInfinityCampaign
  in: FluxImprIncreaseCampaignPrevDay
  in: FluxImprDecreaseCampaignPrevDay
  in: FluxImprIncreaseInfinityCampaignPrevDay
  in: FluxClickIncreaseCampaign
  in: FluxClickDecreaseCampaign
  in: FluxClickIncreaseInfinityCampaign
  in: FluxClickIncreaseCampaignPrevDay
  in: FluxClickDecreaseCampaignPrevDay
  in: FluxClickIncreaseInfinityCampaignPrevDay
  in: FluxCostIncreaseCampaign
  in: FluxCostDecreaseCampaign
  in: FluxCostIncreaseInfinityCampaign
  in: FluxCostIncreaseCampaignPrevDay
  in: FluxCostDecreaseCampaignPrevDay
  in: FluxCostIncreaseInfinityCampaignPrevDay
  in: FluxConversionDecreaseAcct
  in: FluxConversionZeroAcct
  in: RCAudienceIncrease
  in: RCAudienceDecrease
  in: RCBidIncrease
  in: RCBidDecrease
  in: RCBudgetIncrease
  in: RCBudgetDecrease
  in: RCClickIncrease
  in: RCClickDecrease
  in: RCConversionGoalIssue
  in: RCDeviceTargetingBidChange
  in: RCEditorialApproval
  in: RCEditorialDisapproval
  in: RCEntityAdditionWithCount
  in: RCEntityDeletionWithCount
  in: RCEntityPauseWithCount
  in: RCEntityUnpauseWithCount
  in: RCMoreCompetitive
  in: RCNetworkLessRestrict
  in: RCNetworkMoreRestrict
  in: RCPaymentIssueInvoiceAccountPaused
  in: RCPaymentIssueInvoiceAccountOnHold
  in: RCPaymentIssuePrepayAccountPaused
  in: RCPaymentIssueThresholdAccountOnHold
  in: RCPaymentIssueYesterday
  in: RCSearchTermIncrease
  in: RCSearchTermIncreaseClick
  in: RCSearchTermDecrease
  in: RCSearchTermDecreaseClick
  in: RCSearchTermCompetitionIncrease
  in: RCSearchTermCompetitionIncreaseClick
  in: RCSearchTermCompetitionDecrease
  in: RCSearchTermCompetitionDecreaseClick
  in: RCSingleCampaignAddition
  in: RCSingleCampaignPause
  in: RCSingleCampaignUnpause
  in: RCSingleCampaignBudgetIncrease
  in: RCSingleCampaignBudgetDecrease
property:
  path: parameters
  name: parameters
  description: Message parameters are used to fill in the template that renders the message string.
  or:
    node: AdInsightEntityParameterShape
    class: AdInsightEntityParameter
  or:
    node: AdInsightPerformanceInsightsMessageParameterShape
    class: AdInsightPerformanceInsightsMessageParameter
  or:
    node: AdInsightPerformanceInsightsMessageParameterBaseShape
    class: AdInsightPerformanceInsightsMessageParameterBase
  or:
    node: AdInsightTextParameterShape
    class: AdInsightTextParameter
  or:
    node: AdInsightUrlParameterShape
    class: AdInsightUrlParameter
  node kind: BlankNodeOrIRI
property:
  path: indentationLevel
  name: indentation level
  description: Indentation distance or depth when displaying the message. By default, it is 0, which means no indentation distance.
  datatype: int
  max count: 1

AdInsightPerformanceInsightsMessageParameterShape
type: NodeShape
target class: AdInsightPerformanceInsightsMessageParameter
property:
  path: type
  name: type
  description: The supported types are: text, URL, and entities.
  datatype: string
  max count: 1
  in: Text
  in: Url
  in: Entities
property:
  path: suggestedText
  name: suggested text
  datatype: string
  max count: 1
property:
  path: urlCategory
  name: url category
  datatype: string
  max count: 1
  in: Recommendation
  in: Setting
  in: Report
  in: HelpDoc
property:
  path: urlId
  name: url id
  datatype: string
  max count: 1
  in: RecRecommendationPage
  in: RecCompetitionPage
  in: SettingCreateOrder
  in: SettingRemoveHold
  in: SettingAddFunds
  in: ReportSearchTerm
  in: ReportPublisherWebsite
  in: ReportAuctionInsights
  in: HelpDocNetworkSetting
  in: HelpDocEditorial
  in: HelpDocWebsiteReport
  in: HelpDocWebsiteExclusion
  in: HelpDocCreateOrder
  in: HelpDocRemoveHold
  in: HelpDocAddFunds
  in: HelpDocRecommendation
  in: HelpDocAudienceNetwork
property:
  path: suggestedUrl
  name: suggested url
  datatype: string
  max count: 1
property:
  path: entityType
  name: entity type
  datatype: string
  max count: 1
  in: Account
  in: Campaign
  in: AdGroup
  in: Keyword
  in: ProductGroup
  in: SearchTerm
  in: Website
property:
  path: entityCount
  name: entity count
  datatype: int
  max count: 1
property:
  path: entityDetails
  name: entity details
  node: AdInsightEntityDetailShape
  class: AdInsightEntityDetail
  node kind: BlankNodeOrIRI

AdInsightGetRecommendationsRequestShape
type: NodeShape
target class: AdInsightGetRecommendationsRequest
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign that owns the ad group specified in the AdGroupId element. If this element is nil or empty, then the AdGroupId must also be nil or empty, and the operation will return all opportunities of a certain recommendation type for the account.
  datatype: long
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group for which you want to determine responsive search ads opportunities. If this element is nil or empty, the operation will return all opportunities of certain recommendation type for the specified campaign.
  datatype: long
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The identifier of the recommendation type that you want to get. This element can't be nil or empty. One recommendation type per request, e.g., ResponsiveSearchAdsOpportunity.
  datatype: string
  max count: 1

AdInsightGetRecommendationsResponseShape
type: NodeShape
target class: AdInsightGetRecommendationsResponse
property:
  path: recommendations
  name: recommendations
  description: An array of Recommendation objects. 2,000 list items can be returned at maximum.
  or:
    node: AdInsightCampaignBudgetRecommendationShape
    class: AdInsightCampaignBudgetRecommendation
  or:
    node: AdInsightKeywordRecommendationShape
    class: AdInsightKeywordRecommendation
  or:
    node: AdInsightRecommendationShape
    class: AdInsightRecommendation
  or:
    node: AdInsightRecommendationBaseShape
    class: AdInsightRecommendationBase
  or:
    node: AdInsightRecommendationBaseBaseShape
    class: AdInsightRecommendationBaseBase
  or:
    node: AdInsightRemoveConflictingNegativeKeywordRecommendationShape
    class: AdInsightRemoveConflictingNegativeKeywordRecommendation
  or:
    node: AdInsightResponsiveSearchAdAssetRecommendationShape
    class: AdInsightResponsiveSearchAdAssetRecommendation
  or:
    node: AdInsightResponsiveSearchAdRecommendationShape
    class: AdInsightResponsiveSearchAdRecommendation
  or:
    node: AdInsightResponsiveSearchAdsRecommendationShape
    class: AdInsightResponsiveSearchAdsRecommendation
  or:
    node: AdInsightUseBroadMatchKeywordRecommendationShape
    class: AdInsightUseBroadMatchKeywordRecommendation
  node kind: BlankNodeOrIRI

AdInsightRecommendationShape
type: NodeShape
target class: AdInsightRecommendation
property:
  path: accountId
  name: account id
  description: The identifier of the account.
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign for the ad group that owns the recommendation.
  datatype: long
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group that owns the recommendation.
  datatype: long
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation.
  datatype: string
  max count: 1
property:
  path: currentClicks
  name: current clicks
  description: Actual clicks of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: The estimated click opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentCost
  name: current cost
  description: Actual spending of the ad group in the past 7 days, in the currency of this account.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: The estimated increase in spend corresponding to the suggested ad.
  datatype: double
  max count: 1
property:
  path: currentImpressions
  name: current impressions
  description: Actual impressions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentConversions
  name: current conversions
  description: Actual conversions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInConversions
  name: estimated increase in conversions
  description: The estimated impression opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: suggestedAd
  name: suggested ad
  node: AdInsightSuggestedResponsiveSearchAdShape
  class: AdInsightSuggestedResponsiveSearchAd
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightSuggestedResponsiveSearchAdShape
type: NodeShape
target class: AdInsightSuggestedResponsiveSearchAd
property:
  path: headlines
  name: headlines
  description: The list of titles of suggested ads with 3-15 headlines.
  datatype: string
property:
  path: descriptions
  name: descriptions
  description: The list of descriptions of suggested ad with 2-4 descriptions.
  datatype: string
property:
  path: path1
  name: path1
  description: The first part of the optional path that will be appended to the domain portion of your display URL.
  datatype: string
  max count: 1
property:
  path: path2
  name: path2
  description: The second part of the optional path that will be appended to the domain portion of your display URL.
  datatype: string
  max count: 1
property:
  path: finalUrl
  name: final url
  description: The landing page URL.
  datatype: string
  max count: 1

AdInsightGetTextAssetSuggestionsByFinalUrlsRequestShape
type: NodeShape
target class: AdInsightGetTextAssetSuggestionsByFinalUrlsRequest
property:
  path: finalUrls
  name: final urls
  description: The last or final URL where a user is ultimately taken, whether or not the click to final URL path included any redirects. The maximum array limit of FinalUrls for each request is 5.
  datatype: string

AdInsightGetTextAssetSuggestionsByFinalUrlsResponseShape
type: NodeShape
target class: AdInsightGetTextAssetSuggestionsByFinalUrlsResponse
property:
  path: textAssetSuggestions
  name: text asset suggestions
  description: The suggested string value to use for the text asset.
  node: AdInsightTextAssetSuggestionsShape
  class: AdInsightTextAssetSuggestions
  node kind: BlankNodeOrIRI
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  node: AdInsightBatchErrorShape
  class: AdInsightBatchError
  node kind: BlankNodeOrIRI

AdInsightTextAssetSuggestionsShape
type: NodeShape
target class: AdInsightTextAssetSuggestions
property:
  path: finalUrl
  name: final url
  description: The Final URL of the ad, keyword, or criterion. Only the first URL in the list is reported. If the URL contains dynamic text substitution parameters (for example, {param1}), the report will contain the URL before substitution.
  datatype: string
  max count: 1
property:
  path: textAssets
  name: text assets
  description: Text assets that can be reused across multiple ads.
  datatype: string

AdInsightIdeaTextSearchParameterShape
type: NodeShape
target class: AdInsightIdeaTextSearchParameter
property:
  path: included
  name: included
  description: The list of keywords that you explicitly want included in the list of returned keyword ideas. The match type of each keyword must be set to Broad.
  node: AdInsightKeywordShape
  class: AdInsightKeyword
  node kind: BlankNodeOrIRI
property:
  path: excluded
  name: excluded
  description: The list of keywords that you explicitly want excluded from the list of returned keyword ideas. The match type of each keyword must be set to Broad.
  node: AdInsightKeywordShape
  class: AdInsightKeyword
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightImpressionShareSearchParameterShape
type: NodeShape
target class: AdInsightImpressionShareSearchParameter
property:
  path: minimum
  name: minimum
  description: The minimum impression share that you want for keyword ideas.
  datatype: double
  max count: 1
property:
  path: maximum
  name: maximum
  description: The maximum impression share that you want for keyword ideas.
  datatype: double
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightKeywordAndConfidenceShape
type: NodeShape
target class: AdInsightKeywordAndConfidence
property:
  path: suggestedKeyword
  name: suggested keyword
  description: The suggested keyword.
  datatype: string
  max count: 1
property:
  path: confidenceScore
  name: confidence score
  description: A score from 0.0 to 1.0 that indicates the probability that the keyword would match a user's search query.
  datatype: double
  max count: 1

AdInsightKeywordOpportunityBaseShape
type: NodeShape
target class: AdInsightKeywordOpportunityBase
property:
  path: adGroupId
  name: ad group id
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  datatype: string
  max count: 1
property:
  path: campaignName
  name: campaign name
  datatype: string
  max count: 1
property:
  path: matchType
  name: match type
  datatype: int
  max count: 1
property:
  path: suggestedKeyword
  name: suggested keyword
  datatype: string
  max count: 1
property:
  path: suggestedBid
  name: suggested bid
  datatype: double
  max count: 1
property:
  path: monthlySearches
  name: monthly searches
  datatype: long
  max count: 1
property:
  path: competition
  name: competition
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  datatype: long
  max count: 1
property:
  path: opportunityKey
  name: opportunity key
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightKeywordRecommendationShape
type: NodeShape
target class: AdInsightKeywordRecommendation
property:
  path: accountId
  name: account id
  description: The identifier of the account. Output only.
  datatype: long
  max count: 1
property:
  path: accountName
  name: account name
  description: The name of the account. Output only.
  datatype: string
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The campaign ID targeted by this recommendation. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD
  datatype: long
  max count: 1
property:
  path: campaignName
  name: campaign name
  description: The name of the campaign. Output only.
  datatype: string
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The ad group ID targeted by this recommendation. This will be set only when the recommendation affects a single ad group. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD.
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  description: The name of the ad group. Output only.
  datatype: string
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation. Note: We currently support CAMPAIGN_BUDGET, KEYWORD, and RESPONSIVE_SEARCH_AD. RecommendationType is output only.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The RecommendationType value set has the following values: CampaignBudgetRecommendation, KeywordRecommendation, ResponsiveSearchAdRecommendation.
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation.
  datatype: string
  max count: 1
property:
  path: currentClicks
  name: current clicks
  description: Actual clicks of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: The estimated click opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentCost
  name: current cost
  description: Actual spending of the ad group in the past 7 days, in the currency of this account.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: The estimated increase in spend corresponding to the suggested ad.
  datatype: double
  max count: 1
property:
  path: currentImpressions
  name: current impressions
  description: Actual impressions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentConversions
  name: current conversions
  description: Actual conversions of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInConversions
  name: estimated increase in conversions
  description: The estimated impression opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: dismissed
  name: dismissed
  description: Whether the recommendation is dismissed or not. Output only.
  datatype: boolean
  max count: 1
property:
  path: suggestedKeyword
  name: suggested keyword
  description: The text of the keyword (at most 80 characters and 10 words). Output only.
  datatype: string
  max count: 1
property:
  path: suggestedBid
  name: suggested bid
  description: The suggested bid that may result in your ads serving on the first page of the search query results. Output only.
  datatype: double
  max count: 1
property:
  path: monthlySearches
  name: monthly searches
  description: The estimated monthly volume of user search queries that may match the suggested keyword for the corresponding MatchType element. Output only.
  datatype: long
  max count: 1
property:
  path: matchType
  name: match type
  description: The match type that the suggested bid applies to. Output only. The following are the possible match-type values: 1 - Exact match2 - Phrase match3 - Broad match
  datatype: int
  max count: 1
property:
  path: competition
  name: competition
  description: An indicator of competitive bids for this keyword relative to all search keywords. The competition score ranges from 0 to 1.00, where 0 indicates low competition and 1.00 indicates that there is a high number of advertisers competing for this keyword. Output only.
  datatype: double
  max count: 1

AdInsightKeywordSuggestionShape
type: NodeShape
target class: AdInsightKeywordSuggestion
property:
  path: keyword
  name: keyword
  description: The keyword to which the suggested keywords apply.
  datatype: string
  max count: 1
property:
  path: suggestionsAndConfidence
  name: suggestions and confidence
  description: A KeywordAndConfidence array that contains a list of suggested keywords and, for each keyword, a score that indicates the probability that using the keyword would result in an ad being included in the results of a search query. The suggested keywords are sorted in order from keywords with the highest confidence score to those with the lowest confidence score.
  node: AdInsightKeywordAndConfidenceShape
  class: AdInsightKeywordAndConfidence
  node kind: BlankNodeOrIRI

AdInsightLanguageSearchParameterShape
type: NodeShape
target class: AdInsightLanguageSearchParameter
property:
  path: languages
  name: languages
  description: The language criterion list for the returned keyword ideas.
  node: AdInsightLanguageCriterionShape
  class: AdInsightLanguageCriterion
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightLocationSearchParameterShape
type: NodeShape
target class: AdInsightLocationSearchParameter
property:
  path: locations
  name: locations
  description: The location criterion list for the returned keyword ideas. You must include between 1 to 2,000 locations.
  node: AdInsightLocationCriterionShape
  class: AdInsightLocationCriterion
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightNetworkSearchParameterShape
type: NodeShape
target class: AdInsightNetworkSearchParameter
property:
  path: network
  name: network
  description: The network criterion for the returned keyword ideas.
  node: AdInsightNetworkCriterionShape
  class: AdInsightNetworkCriterion
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightPerformanceInsightsMessageParameterBaseShape
type: NodeShape
target class: AdInsightPerformanceInsightsMessageParameterBase
property:
  path: type
  name: type
  datatype: string
  max count: 1
  in: Text
  in: Url
  in: Entities

AdInsightQuerySearchParameterShape
type: NodeShape
target class: AdInsightQuerySearchParameter
property:
  path: queries
  name: queries
  description: Up to 200 words or phrases that describe what you're advertising.
  datatype: string
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightRecommendationBaseShape
type: NodeShape
target class: AdInsightRecommendationBase
property:
  path: accountId
  name: account id
  description: The identifier of the account. Output only.
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The campaign ID targeted by this recommendation. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD
  datatype: long
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The ad group ID targeted by this recommendation. This will be set only when the recommendation affects a single ad group. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD.
  datatype: long
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation. Note: We currently support ADD_BROAD_MATCH_KEYWORD, CAMPAIGN_BUDGET, KEYWORD, REMOVE_CONFLICTING_NEGATIVE_KEYWORD, RESPONSIVE_SEARCH_AD, and RESPONSIVE_SEARCH_AD_ASSET. RecommendationType is output only.
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation.
  datatype: string
  max count: 1
property:
  path: currentClicks
  name: current clicks
  description: Actual clicks of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: The estimated click opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentCost
  name: current cost
  description: Actual spending of the ad group in the past 7 days, in the currency of this account.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: The estimated increase in spend corresponding to the suggested ad.
  datatype: double
  max count: 1
property:
  path: currentImpressions
  name: current impressions
  description: Actual impressions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentConversions
  name: current conversions
  description: Actual conversions of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInConversions
  name: estimated increase in conversions
  description: The estimated impression opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The RecommendationType value set has the following values: AddBroadMatchKeywordRecommendation, CampaignBudgetRecommendation, KeywordRecommendation, RemoveConflictingNegativeKeywordRecommendation, ResponsiveSearchAdRecommendation, and ResponsiveSearchAdAssetRecommendation.
  datatype: string
  max count: 1

AdInsightRecommendationBaseBaseShape
type: NodeShape
target class: AdInsightRecommendationBaseBase
property:
  path: accountId
  name: account id
  datatype: long
  max count: 1
property:
  path: accountName
  name: account name
  datatype: string
  max count: 1
property:
  path: campaignId
  name: campaign id
  datatype: long
  max count: 1
property:
  path: campaignName
  name: campaign name
  datatype: string
  max count: 1
property:
  path: adGroupId
  name: ad group id
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  datatype: string
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  datatype: string
  max count: 1
property:
  path: currentClicks
  name: current clicks
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  datatype: long
  max count: 1
property:
  path: currentCost
  name: current cost
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  datatype: double
  max count: 1
property:
  path: currentImpressions
  name: current impressions
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  datatype: long
  max count: 1
property:
  path: currentConversions
  name: current conversions
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInConversions
  name: estimated increase in conversions
  datatype: long
  max count: 1
property:
  path: dismissed
  name: dismissed
  datatype: boolean
  max count: 1

AdInsightRecommendationInfoShape
type: NodeShape
target class: AdInsightRecommendationInfo
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation. It is required.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation. It is required.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: adId
  name: ad id
  datatype: long
  max count: 1

AdInsightRecommendationInfoBaseShape
type: NodeShape
target class: AdInsightRecommendationInfoBase
property:
  path: recommendationId
  name: recommendation id
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightRemoveConflictingNegativeKeywordRecommendationShape
type: NodeShape
target class: AdInsightRemoveConflictingNegativeKeywordRecommendation
property:
  path: accountId
  name: account id
  description: The identifier of the account. Output only.
  datatype: long
  max count: 1
property:
  path: accountName
  name: account name
  description: The name of the account. Output only.
  datatype: string
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The campaign ID targeted by this recommendation. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD
  datatype: long
  max count: 1
property:
  path: campaignName
  name: campaign name
  description: The name of the campaign. Output only.
  datatype: string
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The ad group ID targeted by this recommendation. This will be set only when the recommendation affects a single ad group. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD.
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  description: The name of the ad group. Output only.
  datatype: string
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation. Note: We currently support CAMPAIGN_BUDGET, KEYWORD, and RESPONSIVE_SEARCH_AD. RecommendationType is output only.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The RecommendationType value set has the following values: CampaignBudgetRecommendation, KeywordRecommendation, ResponsiveSearchAdRecommendation.
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation.
  datatype: string
  max count: 1
property:
  path: currentClicks
  name: current clicks
  description: Actual clicks of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: The estimated click opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentCost
  name: current cost
  description: Actual spending of the ad group in the past 7 days, in the currency of this account.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: The estimated increase in spend corresponding to the suggested ad.
  datatype: double
  max count: 1
property:
  path: currentImpressions
  name: current impressions
  description: Actual impressions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentConversions
  name: current conversions
  description: Actual conversions of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInConversions
  name: estimated increase in conversions
  description: The estimated impression opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: dismissed
  name: dismissed
  description: Whether the recommendation is dismissed or not. Output only.
  datatype: boolean
  max count: 1
property:
  path: negativeKeywordId
  name: negative keyword id
  description: The ID of the negative keyword.
  datatype: long
  max count: 1
property:
  path: negativeKeyword
  name: negative keyword
  description: The negative keyword.
  datatype: string
  max count: 1
property:
  path: negativeKeywordMatchType
  name: negative keyword match type
  description: The match type of the negative keyword.
  datatype: int
  max count: 1
property:
  path: negativeKeywordSharedListId
  name: negative keyword shared list id
  description: The shared list ID of the negative keyword.
  datatype: long
  max count: 1
property:
  path: negativeKeywordListName
  name: negative keyword list name
  description: The list name of the negative keyword.
  datatype: string
  max count: 1
property:
  path: source
  name: source
  description: The source name.
  datatype: string
  max count: 1

AdInsightResponsiveSearchAdAssetRecommendationShape
type: NodeShape
target class: AdInsightResponsiveSearchAdAssetRecommendation
property:
  path: accountId
  name: account id
  description: The identifier of the account. Output only.
  datatype: long
  max count: 1
property:
  path: accountName
  name: account name
  description: The name of the account. Output only.
  datatype: string
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The campaign ID targeted by this recommendation. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD
  datatype: long
  max count: 1
property:
  path: campaignName
  name: campaign name
  description: The name of the campaign. Output only.
  datatype: string
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The ad group ID targeted by this recommendation. This will be set only when the recommendation affects a single ad group. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD.
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  description: The name of the ad group. Output only.
  datatype: string
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation. Note: We currently support CAMPAIGN_BUDGET, KEYWORD, and RESPONSIVE_SEARCH_AD. RecommendationType is output only.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The RecommendationType value set has the following values: CampaignBudgetRecommendation, KeywordRecommendation, ResponsiveSearchAdRecommendation.
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation.
  datatype: string
  max count: 1
property:
  path: currentClicks
  name: current clicks
  description: Actual clicks of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: The estimated click opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentCost
  name: current cost
  description: Actual spending of the ad group in the past 7 days, in the currency of this account.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: The estimated increase in spend corresponding to the suggested ad.
  datatype: double
  max count: 1
property:
  path: currentImpressions
  name: current impressions
  description: Actual impressions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentConversions
  name: current conversions
  description: Actual conversions of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInConversions
  name: estimated increase in conversions
  description: The estimated impression opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: dismissed
  name: dismissed
  description: Whether the recommendation is dismissed or not. Output only.
  datatype: boolean
  max count: 1
property:
  path: responsiveSearchAdId
  name: responsive search ad id
  description: The ID of the responsive search ad.
  datatype: long
  max count: 1
property:
  path: recommendedResponsiveSearchAd
  name: recommended responsive search ad
  description: The recommended responsive search ad.
  node: AdInsightSuggestedResponsiveSearchAdShape
  class: AdInsightSuggestedResponsiveSearchAd
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightResponsiveSearchAdRecommendationShape
type: NodeShape
target class: AdInsightResponsiveSearchAdRecommendation
property:
  path: accountId
  name: account id
  description: The identifier of the account. Output only.
  datatype: long
  max count: 1
property:
  path: accountName
  name: account name
  description: The account name. Output only.
  datatype: string
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The campaign ID targeted by this recommendation. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD
  datatype: long
  max count: 1
property:
  path: campaignName
  name: campaign name
  description: The campaign name. Output only.
  datatype: string
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The ad group ID targeted by this recommendation. This will be set only when the recommendation affects a single ad group. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD.
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  description: The ad group name. Output only.
  datatype: string
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation. Note: We currently support CAMPAIGN_BUDGET, KEYWORD, and RESPONSIVE_SEARCH_AD. RecommendationType is output only.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The RecommendationType value set has the following values: CampaignBudgetRecommendation, KeywordRecommendation, ResponsiveSearchAdRecommendation.
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation.
  datatype: string
  max count: 1
property:
  path: currentClicks
  name: current clicks
  description: Actual clicks of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: The estimated click opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentCost
  name: current cost
  description: Actual spending of the ad group in the past 7 days, in the currency of this account.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: The estimated increase in spend corresponding to the suggested ad.
  datatype: double
  max count: 1
property:
  path: currentImpressions
  name: current impressions
  description: Actual impressions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentConversions
  name: current conversions
  description: Actual conversions of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInConversions
  name: estimated increase in conversions
  description: The estimated impression opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: dismissed
  name: dismissed
  description: Whether the recommendation is dismissed or not. Output only.
  datatype: boolean
  max count: 1
property:
  path: suggestedAd
  name: suggested ad
  description: The ad info in the recommendation. Output only.
  node: AdInsightSuggestedResponsiveSearchAdShape
  class: AdInsightSuggestedResponsiveSearchAd
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightResponsiveSearchAdsRecommendationShape
type: NodeShape
target class: AdInsightResponsiveSearchAdsRecommendation
property:
  path: accountId
  name: account id
  description: The identifier of the account.
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign for the ad group that owns the recommendation.
  datatype: long
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group that owns the recommendation.
  datatype: long
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation.
  datatype: string
  max count: 1
property:
  path: currentClicks
  name: current clicks
  description: Actual clicks of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: The estimated click opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentCost
  name: current cost
  description: Actual spending of the ad group in the past 7 days, in the currency of this account.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: The estimated increase in spend corresponding to the suggested ad.
  datatype: double
  max count: 1
property:
  path: currentImpressions
  name: current impressions
  description: Actual impressions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentConversions
  name: current conversions
  description: Actual conversions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInConversions
  name: estimated increase in conversions
  description: The estimated impression opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: suggestedAd
  name: suggested ad
  description: The ad info in the recommendation.
  node: AdInsightSuggestedResponsiveSearchAdShape
  class: AdInsightSuggestedResponsiveSearchAd
  node kind: BlankNodeOrIRI
  max count: 1

AdInsightRetrieveRecommendationsRequestShape
type: NodeShape
target class: AdInsightRetrieveRecommendationsRequest
property:
  path: maxCount
  name: max count
  description: The max number of returned recommendations. The default value is null. If MaxCount is null or 0, it returns all available recommendations. Optional.
  datatype: int
  max count: 1
property:
  path: recommendationTypes
  name: recommendation types
  description: The recommendation type names: ADD_BROAD_MATCH_KEYWORD, CAMPAIGN_BUDGET, KEYWORD, REMOVE_CONFLICTING_NEGATIVE_KEYWORD, RESPONSIVE_SEARCH_AD, or RESPONSIVE_SEARCH_AD_ASSET. Required.
  datatype: string

AdInsightRetrieveRecommendationsResponseShape
type: NodeShape
target class: AdInsightRetrieveRecommendationsResponse
property:
  path: recommendations
  name: recommendations
  description: The available recommendations for specific account ID. The types of recommendations are: AddBroadMatchKeywordRecommendation, CampaignBudgetRecommendation, KeywordRecommendation, RemoveConflictingNegativeKeywordRecommendation, ResponsiveSearchAdRecommendation, and ResponsiveSearchAdAssetRecommendation.
  or:
    node: AdInsightCampaignBudgetRecommendationShape
    class: AdInsightCampaignBudgetRecommendation
  or:
    node: AdInsightKeywordRecommendationShape
    class: AdInsightKeywordRecommendation
  or:
    node: AdInsightRecommendationBaseShape
    class: AdInsightRecommendationBase
  or:
    node: AdInsightRecommendationBaseBaseShape
    class: AdInsightRecommendationBaseBase
  or:
    node: AdInsightRemoveConflictingNegativeKeywordRecommendationShape
    class: AdInsightRemoveConflictingNegativeKeywordRecommendation
  or:
    node: AdInsightResponsiveSearchAdAssetRecommendationShape
    class: AdInsightResponsiveSearchAdAssetRecommendation
  or:
    node: AdInsightResponsiveSearchAdRecommendationShape
    class: AdInsightResponsiveSearchAdRecommendation
  or:
    node: AdInsightUseBroadMatchKeywordRecommendationShape
    class: AdInsightUseBroadMatchKeywordRecommendation
  node kind: BlankNodeOrIRI

AdInsightRSARecommendationInfoShape
type: NodeShape
target class: AdInsightRSARecommendationInfo
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation. It is required.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation. It is required.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: adId
  name: ad id
  description: Ad id of the responsive search ad that is created by adopting the recommendation. Optional. It is required when you try to tag a recommendation as applied.
  datatype: long
  max count: 1

AdInsightSearchVolumeSearchParameterShape
type: NodeShape
target class: AdInsightSearchVolumeSearchParameter
property:
  path: minimum
  name: minimum
  description: The minimum search volume that you want for keyword ideas.
  datatype: long
  max count: 1
property:
  path: maximum
  name: maximum
  description: The maximum search volume that you want for keyword ideas.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightSetAutoApplyOptInStatusRequestShape
type: NodeShape
target class: AdInsightSetAutoApplyOptInStatusRequest
property:
  path: autoApplyOptInStatusInputs
  name: auto apply opt in status inputs
  description: A string array which identifies auto-apply opt-in status of the given recommendation types in the request. Duplicated input keys are not allowed in the same call. This field includes the list of recommendation types with the auto-apply opt-in status to be specified. The existing key and value pairs are as follows (case sensitive): ResponsiveSearchAdsOpportunity = falseMultiMediaAdsOpportunity = true RemoveConflictingNegativeKeywordOpportunity = false FixConversionGoalSettingsOpportunity = false CreateConversionGoalOpportunity = false .If the value of a key is set to true, then the account will opt-in auto-apply of the corresponding recommendation type. You may specify a maximum of 100 input elements.
  datatype: string

AdInsightSetAutoApplyOptInStatusResponseShape
type: NodeShape
target class: AdInsightSetAutoApplyOptInStatusResponse
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  node: AdInsightBatchErrorShape
  class: AdInsightBatchError
  node kind: BlankNodeOrIRI

AdInsightSuggestedBidSearchParameterShape
type: NodeShape
target class: AdInsightSuggestedBidSearchParameter
property:
  path: minimum
  name: minimum
  description: The minimum suggested bid that you want for keyword ideas.
  datatype: double
  max count: 1
property:
  path: maximum
  name: maximum
  description: The maximum suggested bid that you want for keyword ideas.
  datatype: double
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightSuggestKeywordsForUrlRequestShape
type: NodeShape
target class: AdInsightSuggestKeywordsForUrlRequest
property:
  path: url
  name: url
  description: The URL of the webpage to scan for possible keywords. The URL can contain a maximum of 2,000 characters.
  datatype: string
  max count: 1
property:
  path: language
  name: language
  description: The language used by the website. For possible values, see Ad Languages. The default is English.
  datatype: string
  max count: 1
property:
  path: maxKeywords
  name: max keywords
  description: A positive integer value that specifies the maximum number of keywords to return. The maximum value that you can specify is 800. The default is 10.
  datatype: int
  max count: 1
property:
  path: minConfidenceScore
  name: min confidence score
  description: A filter value that limits the keywords that the service returns to those that have a confidence score that is greater than or equal to the specified score. For example, you can specify that you want the operation to return only keywords that have a confidence score of at least 80 percent (0.8). If null, the confidence score is not used to limit the results.
  datatype: double
  max count: 1
property:
  path: excludeBrand
  name: exclude brand
  description: A value that determines whether the results exclude brand keywords. To exclude brand keywords in the result, set to true. The default is false.
  datatype: boolean
  max count: 1

AdInsightSuggestKeywordsForUrlResponseShape
type: NodeShape
target class: AdInsightSuggestKeywordsForUrlResponse
property:
  path: keywords
  name: keywords
  description: An array of KeywordAndConfidence objects that contains the possible keywords found in the content of the specified URL. In addition, the object includes a score that indicates the probability that using the keyword would result in the URL being included in the results of a search query. The results are sorted in order from keywords with the highest confidence score to those with the lowest confidence score.
  node: AdInsightKeywordAndConfidenceShape
  class: AdInsightKeywordAndConfidence
  node kind: BlankNodeOrIRI

AdInsightSuggestKeywordsFromExistingKeywordsRequestShape
type: NodeShape
target class: AdInsightSuggestKeywordsFromExistingKeywordsRequest
property:
  path: keywords
  name: keywords
  description: An array of keywords for which you want to get suggested keywords that could perform better. The array can contain a maximum of 1,000 keywords, and each keyword can contain a maximum of 100 characters.
  datatype: string
property:
  path: language
  name: language
  description: The language in which the keyword is written. Possible case-sensitive values are English, French, and German. See the Remarks section below for a list of providers that are supported for each language. The default is English.
  datatype: string
  max count: 1
property:
  path: publisherCountries
  name: publisher countries
  description: The country codes of the countries/regions to use as the source of data for determining the suggested keywords. You can specify one or more country codes. Each country/region that you specify must support the language that you specified in the Language element. For supported values, see the Remarks section below. The default is all countries/regions that support the specified language.
  datatype: string
property:
  path: maxSuggestionsPerKeyword
  name: max suggestions per keyword
  description: The maximum number of keyword suggestions to return per specified keyword. If SuggestionType is set to 4, you can request a maximum of 200 suggestions per keyword; otherwise the maximum suggestions that you can request is 100. The default is 50.
  datatype: int
  max count: 1
property:
  path: suggestionType
  name: suggestion type
  description: The provider to use to generate the keyword suggestions. For a list of possible providers, the language and country/region restrictions of each provider, and the default provider by country/region, see the Remarks section below.
  datatype: int
  max count: 1
property:
  path: removeDuplicates
  name: remove duplicates
  description: A Boolean value that determines whether to remove duplicate keywords from the list of suggested keywords. To remove duplicates, set to true. The default is false.
  datatype: boolean
  max count: 1
property:
  path: excludeBrand
  name: exclude brand
  description: A value that determines whether the results exclude brand keywords. To exclude brand keywords in the result, set to true. The default is false.
  datatype: boolean
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group for suggested keywords. This element is not yet supported and may be used to influence keyword suggestions in a future release
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign for suggested keywords. This element is not yet supported and may be used to influence keyword suggestions in a future release
  datatype: long
  max count: 1

AdInsightSuggestKeywordsFromExistingKeywordsResponseShape
type: NodeShape
target class: AdInsightSuggestKeywordsFromExistingKeywordsResponse
property:
  path: keywordSuggestions
  name: keyword suggestions
  description: An array of KeywordSuggestion data objects. The array contains an item for each keyword specified in the request. The object contains a list of suggested keywords that may perform better than the specified keyword. For each suggested keyword, the object includes a score that indicates the probability that using the keyword would result in an ad being included in the results of a search query. If there are no suggestions for a keyword, the SuggestionsAndConfidence element will be null.
  node: AdInsightKeywordSuggestionShape
  class: AdInsightKeywordSuggestion
  node kind: BlankNodeOrIRI

AdInsightTagRecommendationsRequestShape
type: NodeShape
target class: AdInsightTagRecommendationsRequest
property:
  path: recommendationType
  name: recommendation type
  description: The identifier of the recommendation type that you have applied. This element cannot be nil or empty. One specific recommendation type per request, e.g., ResponsiveSearchAdsOpportunity.
  datatype: string
  max count: 1
property:
  path: recommendationsInfo
  name: recommendations info
  description: The information for an individual recommendation. Duplicate RecommendationInfo (RecommendationId) will be returned as DuplicateRecommendationInfo error. You may specify a maximum of 100 input elements.
  or:
    node: AdInsightRSARecommendationInfoShape
    class: AdInsightRSARecommendationInfo
  or:
    node: AdInsightRecommendationInfoShape
    class: AdInsightRecommendationInfo
  or:
    node: AdInsightRecommendationInfoBaseShape
    class: AdInsightRecommendationInfoBase
  node kind: BlankNodeOrIRI
property:
  path: lable
  name: lable
  description: The value must be set to either applied or dismissed
  datatype: string
  max count: 1

AdInsightTagRecommendationsResponseShape
type: NodeShape
target class: AdInsightTagRecommendationsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  node: AdInsightBatchErrorShape
  class: AdInsightBatchError
  node kind: BlankNodeOrIRI

AdInsightTextParameterShape
type: NodeShape
target class: AdInsightTextParameter
property:
  path: type
  name: type
  description: Defines the type of parameter: string, URL, or a list of demand entities.
  datatype: string
  max count: 1
  in: Text
  in: Url
  in: Entities
property:
  path: suggestedText
  name: suggested text
  description: The suggested string value to substitute for the message.
  datatype: string
  max count: 1

AdInsightUrlParameterShape
type: NodeShape
target class: AdInsightUrlParameter
property:
  path: type
  name: type
  description: Defines the type of parameter: string, URL, or a list of demand entities.
  datatype: string
  max count: 1
  in: Text
  in: Url
  in: Entities
property:
  path: suggestedText
  name: suggested text
  description: The suggested string value to substitute for the message.
  datatype: string
  max count: 1
property:
  path: urlCategory
  name: url category
  description: The main category of the URL.
  datatype: string
  max count: 1
  in: Recommendation
  in: Setting
  in: Report
  in: HelpDoc
property:
  path: urlId
  name: url id
  description: The specified type of the URL.
  datatype: string
  max count: 1
  in: RecRecommendationPage
  in: RecCompetitionPage
  in: SettingCreateOrder
  in: SettingRemoveHold
  in: SettingAddFunds
  in: ReportSearchTerm
  in: ReportPublisherWebsite
  in: ReportAuctionInsights
  in: HelpDocNetworkSetting
  in: HelpDocEditorial
  in: HelpDocWebsiteReport
  in: HelpDocWebsiteExclusion
  in: HelpDocCreateOrder
  in: HelpDocRemoveHold
  in: HelpDocAddFunds
  in: HelpDocRecommendation
  in: HelpDocAudienceNetwork
property:
  path: suggestedUrl
  name: suggested url
  description: THe Suggested URL.
  datatype: string
  max count: 1

AdInsightUrlSearchParameterShape
type: NodeShape
target class: AdInsightUrlSearchParameter
property:
  path: url
  name: url
  description: The URL of your website or a page on your website. Microsoft Advertising extracts keywords from the HTML code on your website or landing page. If your HTML code contains Javascript, which generates content at runtime, Microsoft Advertising will not extract keywords rendered from the Javascript and you'll see fewer or no keywords.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

AdInsightUseBroadMatchKeywordRecommendationShape
type: NodeShape
target class: AdInsightUseBroadMatchKeywordRecommendation
property:
  path: accountId
  name: account id
  description: The identifier of the account. Output only.
  datatype: long
  max count: 1
property:
  path: accountName
  name: account name
  description: The name of the account. Output only.
  datatype: string
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The campaign ID targeted by this recommendation. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD
  datatype: long
  max count: 1
property:
  path: campaignName
  name: campaign name
  description: The name of the campaign. Output only.
  datatype: string
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: The ad group ID targeted by this recommendation. This will be set only when the recommendation affects a single ad group. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD.
  datatype: long
  max count: 1
property:
  path: adGroupName
  name: ad group name
  description: The name of the ad group. Output only.
  datatype: string
  max count: 1
property:
  path: recommendationType
  name: recommendation type
  description: The type of recommendation. Note: We currently support CAMPAIGN_BUDGET, KEYWORD, and RESPONSIVE_SEARCH_AD. RecommendationType is output only.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The RecommendationType value set has the following values: CampaignBudgetRecommendation, KeywordRecommendation, ResponsiveSearchAdRecommendation.
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  description: The identifier of the recommendation.
  datatype: string
  max count: 1
property:
  path: recommendationHash
  name: recommendation hash
  description: The hash of the recommendation.
  datatype: string
  max count: 1
property:
  path: currentClicks
  name: current clicks
  description: Actual clicks of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInClicks
  name: estimated increase in clicks
  description: The estimated click opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentCost
  name: current cost
  description: Actual spending of the ad group in the past 7 days, in the currency of this account.
  datatype: double
  max count: 1
property:
  path: estimatedIncreaseInCost
  name: estimated increase in cost
  description: The estimated increase in spend corresponding to the suggested ad.
  datatype: double
  max count: 1
property:
  path: currentImpressions
  name: current impressions
  description: Actual impressions of the ad group in the past 7 days.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInImpressions
  name: estimated increase in impressions
  description: The estimated impressions opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: currentConversions
  name: current conversions
  description: Actual conversions of the ad group in the past 7 days. Output only.
  datatype: long
  max count: 1
property:
  path: estimatedIncreaseInConversions
  name: estimated increase in conversions
  description: The estimated impression opportunities corresponding to the suggested ad.
  datatype: long
  max count: 1
property:
  path: dismissed
  name: dismissed
  description: Whether the recommendation is dismissed or not. Output only.
  datatype: boolean
  max count: 1
property:
  path: keywordOrderItemId
  name: keyword order item id
  description: The ID of the keyword order item.
  datatype: long
  max count: 1
property:
  path: keyword
  name: keyword
  description: The keyword.
  datatype: string
  max count: 1
property:
  path: currentMatchType
  name: current match type
  description: The current match type.
  datatype: int
  max count: 1
property:
  path: suggestedMatchType
  name: suggested match type
  description: The suggested match type.
  datatype: int
  max count: 1
property:
  path: suggestedBid
  name: suggested bid
  description: The suggested bid.
  datatype: double
  max count: 1
property:
  path: currentStatus
  name: current status
  description: The current status.
  datatype: string
  max count: 1
property:
  path: suggestedStatus
  name: suggested status
  description: The suggested status.
  datatype: string
  max count: 1

BulkAdApiErrorShape
type: NodeShape
target class: BulkAdApiError
property:
  path: code
  name: code
  description: A numeric error code that identifies the error.
  datatype: int
  max count: 1
property:
  path: message
  name: message
  description: A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.
  datatype: string
  max count: 1
property:
  path: detail
  name: detail
  description: A message that contains additional details about the error. This string can be empty.
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error. For example, UserIsNotAuthorized.
  datatype: string
  max count: 1

BulkAdApiFaultDetailShape
type: NodeShape
target class: BulkAdApiFaultDetail
property:
  path: trackingId
  name: tracking id
  description: The identifier of the log entry that contains the details of the API call.
  datatype: string
  max count: 1
property:
  path: errors
  name: errors
  description: An array of AdApiError objects that contains the details that explain why the service operation failed.
  node: BulkAdApiErrorShape
  class: BulkAdApiError
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

BulkAdCenterAuthenticationFaultShape
type: NodeShape
target class: BulkAdCenterAuthenticationFault
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  datatype: string
  max count: 1
  in: NoCredential
  in: InvalidCustomerId
  in: InvalidSecurityTicket
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

BulkAdCenterAuthorizationFaultShape
type: NodeShape
target class: BulkAdCenterAuthorizationFault
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

BulkAdCenterFaultShape
type: NodeShape
target class: BulkAdCenterFault
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

BulkAdCenterInternalErrorFaultShape
type: NodeShape
target class: BulkAdCenterInternalErrorFault
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

BulkAdCenterSystemFaultShape
type: NodeShape
target class: BulkAdCenterSystemFault
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

BulkApiFaultDetailShape
type: NodeShape
target class: BulkApiFaultDetail
property:
  path: trackingId
  name: tracking id
  description: The identifier of the log entry that contains the details of the API call.
  datatype: string
  max count: 1
property:
  path: batchErrors
  name: batch errors
  description: An array of batch errors that identifies the items in the batch of items in the request message that caused the operation to fail. Each object contains the details that explain why the item caused the failure.
  or:
    node: BulkBatchErrorShape
    class: BulkBatchError
  or:
    node: BulkBatchErrorBaseShape
    class: BulkBatchErrorBase
  or:
    node: BulkEditorialErrorShape
    class: BulkEditorialError
  node kind: BlankNodeOrIRI
property:
  path: operationErrors
  name: operation errors
  description: An array of operation errors that contains the reasons that explain why the service operation failed when the error is not related to a specific item in the batch of items.
  node: BulkOperationErrorShape
  class: BulkOperationError
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

BulkBatchErrorShape
type: NodeShape
target class: BulkBatchError
property:
  path: index
  name: index
  description: The zero-based index of the item in the batch of items in the request message that failed.
  datatype: int
  max count: 1
property:
  path: disapprovedText
  name: disapproved text
  datatype: string
  max count: 1
property:
  path: reasonCode
  name: reason code
  datatype: int
  max count: 1
property:
  path: location
  name: location
  datatype: string
  max count: 1
property:
  path: publisherCountry
  name: publisher country
  datatype: string
  max count: 1
property:
  path: fieldPath
  name: field path
  description: Reserved for future use.
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error. For example, UserIsNotAuthorized.
  datatype: string
  max count: 1
property:
  path: message
  name: message
  description: A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.
  datatype: string
  max count: 1
property:
  path: code
  name: code
  description: A numeric error code that identifies the error.
  datatype: int
  max count: 1
property:
  path: details
  name: details
  description: A message that provides additional details about the batch error. This string can be empty.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Reserved for future use.
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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.
  node: BulkKeyValuePairOfstringAndstringShape
  class: BulkKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: appealable
  name: appealable
  datatype: boolean
  max count: 1

BulkKeyValuePairOfstringAndstringShape
type: NodeShape
target class: BulkKeyValuePairOfstringAndstring
property:
  path: key
  name: key
  datatype: string
  max count: 1
property:
  path: value
  name: value
  datatype: string
  max count: 1

BulkOperationErrorShape
type: NodeShape
target class: BulkOperationError
property:
  path: code
  name: code
  description: A numeric error code that identifies the error.
  datatype: int
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error. For example, UserIsNotAuthorized.
  datatype: string
  max count: 1
property:
  path: details
  name: details
  description: A message that provides additional details about the error. This string can be empty.
  datatype: string
  max count: 1
property:
  path: message
  name: message
  description: A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.
  datatype: string
  max count: 1

BulkApplicationFaultShape
type: NodeShape
target class: BulkApplicationFault
property:
  path: trackingId
  name: tracking id
  description: The identifier of the log entry that contains the details of the API call.
  datatype: string
  max count: 1
property:
  path: errors
  name: errors
  node: BulkAdApiErrorShape
  class: BulkAdApiError
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: editorialErrors
  name: editorial errors
  node: BulkEditorialErrorShape
  class: BulkEditorialError
  node kind: BlankNodeOrIRI
property:
  path: batchErrors
  name: batch errors
  or:
    node: BulkBatchErrorShape
    class: BulkBatchError
  or:
    node: BulkBatchErrorBaseShape
    class: BulkBatchErrorBase
  or:
    node: BulkEditorialErrorShape
    class: BulkEditorialError
  node kind: BlankNodeOrIRI
property:
  path: operationErrors
  name: operation errors
  node: BulkOperationErrorShape
  class: BulkOperationError
  node kind: BlankNodeOrIRI
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  datatype: string
  max count: 1
  in: NoCredential
  in: InvalidCustomerId
  in: InvalidSecurityTicket

BulkEditorialErrorShape
type: NodeShape
target class: BulkEditorialError
property:
  path: index
  name: index
  description: The zero-based index of the item in the batch of items in the request message that failed.
  datatype: int
  max count: 1
property:
  path: disapprovedText
  name: disapproved text
  description: The text that caused the entity to be disapproved. For text length violations, this element specifies the number of characters by which the specified text exceeds the maximum.
  datatype: string
  max count: 1
property:
  path: reasonCode
  name: reason code
  description: A numeric code that identifies the error. For more information, see Editorial Reason Codes.
  datatype: int
  max count: 1
property:
  path: location
  name: location
  description: The element or property of the entity that caused the entity to be disapproved.
  datatype: string
  max count: 1
property:
  path: publisherCountry
  name: publisher country
  description: The corresponding country or region for the flagged editorial issue.
  datatype: string
  max count: 1
property:
  path: fieldPath
  name: field path
  description: Reserved for future use.
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error. For example, UserIsNotAuthorized.
  datatype: string
  max count: 1
property:
  path: message
  name: message
  description: A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.
  datatype: string
  max count: 1
property:
  path: code
  name: code
  description: A numeric error code that identifies the error.
  datatype: int
  max count: 1
property:
  path: details
  name: details
  description: A message that provides additional details about the batch error. This string can be empty.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Reserved for future use.
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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.
  node: BulkKeyValuePairOfstringAndstringShape
  class: BulkKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: appealable
  name: appealable
  description: Reserved for future use.
  datatype: boolean
  max count: 1

BulkApplicationFaultBaseShape
type: NodeShape
target class: BulkApplicationFaultBase
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1

BulkBatchErrorBaseShape
type: NodeShape
target class: BulkBatchErrorBase
property:
  path: fieldPath
  name: field path
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  datatype: string
  max count: 1
property:
  path: message
  name: message
  datatype: string
  max count: 1
property:
  path: code
  name: code
  datatype: int
  max count: 1
property:
  path: details
  name: details
  datatype: string
  max count: 1
property:
  path: index
  name: index
  datatype: int
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  node: BulkKeyValuePairOfstringAndstringShape
  class: BulkKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

BulkCampaignScopeShape
type: NodeShape
target class: BulkCampaignScope
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign to download.
  datatype: long
  max count: 1
property:
  path: parentAccountId
  name: parent account id
  description: The identifier of the account that owns the campaign to download.
  datatype: long
  max count: 1

BulkDownloadCampaignsByAccountIdsRequestShape
type: NodeShape
target class: BulkDownloadCampaignsByAccountIdsRequest
property:
  path: accountIds
  name: account ids
  description: The identifier of the account that contains the campaign data to download. The maximum number of accounts that you can specify is one. The size of the account that you can download is limited to four million keywords. If you try to download an account that contains more than 4 million keywords, the call will fail with error 3207 (AccountTooBigToDownload). If the call fails, please call the DownloadCampaignsByCampaignIds operation to download the account by campaigns. The Details element of the fault includes a comma-delimited list of the campaign IDs that the account owns.
  datatype: long
property:
  path: lastSyncTimeInUTC
  name: last sync time in utc
  description: The last time that you requested a download. The date and time is expressed in Coordinated Universal Time (UTC). If you specify the last sync time, only those entities that have changed (added, updated, or deleted) since the specified date and time will be downloaded. If the parent campaign or ad group has been deleted since the specified last sync time, you will only see a deleted record for the deleted parent campaign or ad group. For example if a campaign was deleted, the bulk file will not contain deleted records for the ad groups, criterions, ads, and keywords that were in the campaign. Target criterion are treated slightly different from other entities, and deleted records are not returned. If any changes were made to a campaign or ad group's target, then all currently active sub target criterion records are returned. Typically, you request a full download the first time you call the operation by setting this element to null. On all subsequent calls you set the last sync time to the time stamp of the previous download. The download file contains the time stamp of the download in the Sync Time column of the Account record. You should use the account Sync Time to set this element the next time that you request a download. If you set a date and time that is more than 30 days ago, an error will be returned.
  datatype: dateTime
  max count: 1
property:
  path: downloadEntities
  name: download entities
  description: The entities to include in the download. For a list of entities that you can download, see the DownloadEntity value set. You must specify at least one download entity, and otherwise the operation will error.
  datatype: string
  in: None
  in: Campaigns
  in: AdGroups
  in: Ads
  in: Keywords
  in: CampaignNegativeKeywords
  in: AdGroupNegativeKeywords
  in: CampaignTargetCriterions
  in: AdGroupTargetCriterions
  in: CampaignNegativeSites
  in: AdGroupNegativeSites
  in: CampaignLocationAdExtensions
  in: CampaignCallAdExtensions
  in: LocationAdExtensions
  in: CallAdExtensions
  in: NegativeKeywordLists
  in: SharedNegativeKeywords
  in: CampaignNegativeKeywordListAssociations
  in: ImageAdExtensions
  in: CampaignImageAdExtensions
  in: AdGroupImageAdExtensions
  in: AppAdExtensions
  in: AdGroupAppAdExtensions
  in: CampaignAppAdExtensions
  in: PriceAdExtensions
  in: ReviewAdExtensions
  in: CampaignNegativeDynamicSearchAdTargets
  in: AdGroupProductPartitions
  in: CampaignProductScopes
  in: CampaignReviewAdExtensions
  in: AdGroupReviewAdExtensions
  in: CalloutAdExtensions
  in: CampaignCalloutAdExtensions
  in: AdGroupCalloutAdExtensions
  in: SitelinkAdExtensions
  in: CampaignSitelinkAdExtensions
  in: AdGroupSitelinkAdExtensions
  in: StructuredSnippetAdExtensions
  in: CampaignStructuredSnippetAdExtensions
  in: AdGroupStructuredSnippetAdExtensions
  in: RemarketingLists
  in: AdGroupRemarketingListAssociations
  in: Budgets
  in: TextAds
  in: ProductAds
  in: AppInstallAds
  in: ExpandedTextAds
  in: DynamicSearchAds
  in: AdGroupDynamicSearchAdTargets
  in: AdGroupNegativeDynamicSearchAdTargets
  in: CampaignPriceAdExtensions
  in: AdGroupPriceAdExtensions
  in: Labels
  in: CampaignLabels
  in: AdGroupLabels
  in: TextAdLabels
  in: KeywordLabels
  in: AdGroupNegativeRemarketingListAssociations
  in: CustomAudiences
  in: AdGroupCustomAudienceAssociations
  in: AdGroupNegativeCustomAudienceAssociations
  in: InMarketAudiences
  in: AdGroupInMarketAudienceAssociations
  in: AdGroupNegativeInMarketAudienceAssociations
  in: Audiences
  in: AdGroupAudienceAssociations
  in: AdGroupNegativeAudienceAssociations
  in: ProductAdLabels
  in: AppInstallAdLabels
  in: ExpandedTextAdLabels
  in: DynamicSearchAdLabels
  in: AccountLocationAdExtensions
  in: AccountImageAdExtensions
  in: AccountAppAdExtensions
  in: AccountPriceAdExtensions
  in: AccountReviewAdExtensions
property:
  path: dataScope
  name: data scope
  description: You may include quality score data such as ad relevance, in addition to entity data such as campaign settings. The default value is EntityData. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, EntityData QualityScoreData. If BidSuggestionsData or QualityScoreData are included, you must request a full sync. To perform a full sync, do not set LastSyncTimeInUTC i.e., leave it nil.
  datatype: string
  max count: 1
property:
  path: downloadFileType
  name: download file type
  description: The file type of the download file. For possible values, see DownloadFileType. The default is CSV.
  datatype: string
  max count: 1
  in: Csv
  in: Tsv
property:
  path: formatVersion
  name: format version
  description: The format for records of the download file. As a best practice you should always specify the latest format version. Currently the only supported format version for Bing Ads API Version 13 is 6.0. You should manage records according to the Bulk File Schema for the corresponding format version.
  datatype: string
  max count: 1
property:
  path: compressionType
  name: compression type
  description: The compression type of the download file. For possible values, see CompressionType. The default compression type is Zip.
  datatype: string
  max count: 1
  in: Zip
  in: GZip

BulkDownloadCampaignsByAccountIdsResponseShape
type: NodeShape
target class: BulkDownloadCampaignsByAccountIdsResponse
property:
  path: downloadRequestId
  name: download request id
  description: The identifier of the download request. You use the identifier to call the GetBulkDownloadStatus operation to check the status of the download. The identifier is valid for a maximum of two days. If you have not successfully downloaded the file within this period, it is removed from the download site and you will need to get a new download request identifier. The string has a length up to 40 and can contain any character.
  datatype: string
  max count: 1

BulkDownloadCampaignsByCampaignIdsRequestShape
type: NodeShape
target class: BulkDownloadCampaignsByCampaignIdsRequest
property:
  path: campaigns
  name: campaigns
  description: The campaigns to download. You can specify a maximum of 1,000 campaigns. The campaigns that you specify must belong to the same account.
  node: BulkCampaignScopeShape
  class: BulkCampaignScope
  node kind: BlankNodeOrIRI
property:
  path: lastSyncTimeInUTC
  name: last sync time in utc
  description: The last time that you requested a download. The date and time is expressed in Coordinated Universal Time (UTC). If you specify the last sync time, only those entities that have changed (added, updated, or deleted) since the specified date and time will be downloaded. If the parent campaign or ad group has been deleted since the specified last sync time, you will only see a deleted record for the deleted parent campaign or ad group. For example if a campaign was deleted, the bulk file will not contain deleted records for the ad groups, criterions, ads, and keywords that were in the campaign. Target criterion are treated slightly different from other entities, and deleted records are not returned. If any changes were made to a campaign or ad group's target, then all currently active sub target criterion records are returned. Typically, you request a full download the first time you call the operation by setting this element to null. On all subsequent calls you set the last sync time to the time stamp of the previous download. The download file contains the time stamp of the download in the Sync Time column of the Account record. You should use the account Sync Time to set this element the next time that you request a download. If you set a date and time that is more than 30 days prior, an error will be returned.
  datatype: dateTime
  max count: 1
property:
  path: downloadEntities
  name: download entities
  description: The entities to include in the download. For a list of entities that you can download, see the DownloadEntity value set. You must specify at least one download entity, and otherwise the operation will error.
  datatype: string
  in: None
  in: Campaigns
  in: AdGroups
  in: Ads
  in: Keywords
  in: CampaignNegativeKeywords
  in: AdGroupNegativeKeywords
  in: CampaignTargetCriterions
  in: AdGroupTargetCriterions
  in: CampaignNegativeSites
  in: AdGroupNegativeSites
  in: CampaignLocationAdExtensions
  in: CampaignCallAdExtensions
  in: LocationAdExtensions
  in: CallAdExtensions
  in: NegativeKeywordLists
  in: SharedNegativeKeywords
  in: CampaignNegativeKeywordListAssociations
  in: ImageAdExtensions
  in: CampaignImageAdExtensions
  in: AdGroupImageAdExtensions
  in: AppAdExtensions
  in: AdGroupAppAdExtensions
  in: CampaignAppAdExtensions
  in: PriceAdExtensions
  in: ReviewAdExtensions
  in: CampaignNegativeDynamicSearchAdTargets
  in: AdGroupProductPartitions
  in: CampaignProductScopes
  in: CampaignReviewAdExtensions
  in: AdGroupReviewAdExtensions
  in: CalloutAdExtensions
  in: CampaignCalloutAdExtensions
  in: AdGroupCalloutAdExtensions
  in: SitelinkAdExtensions
  in: CampaignSitelinkAdExtensions
  in: AdGroupSitelinkAdExtensions
  in: StructuredSnippetAdExtensions
  in: CampaignStructuredSnippetAdExtensions
  in: AdGroupStructuredSnippetAdExtensions
  in: RemarketingLists
  in: AdGroupRemarketingListAssociations
  in: Budgets
  in: TextAds
  in: ProductAds
  in: AppInstallAds
  in: ExpandedTextAds
  in: DynamicSearchAds
  in: AdGroupDynamicSearchAdTargets
  in: AdGroupNegativeDynamicSearchAdTargets
  in: CampaignPriceAdExtensions
  in: AdGroupPriceAdExtensions
  in: Labels
  in: CampaignLabels
  in: AdGroupLabels
  in: TextAdLabels
  in: KeywordLabels
  in: AdGroupNegativeRemarketingListAssociations
  in: CustomAudiences
  in: AdGroupCustomAudienceAssociations
  in: AdGroupNegativeCustomAudienceAssociations
  in: InMarketAudiences
  in: AdGroupInMarketAudienceAssociations
  in: AdGroupNegativeInMarketAudienceAssociations
  in: Audiences
  in: AdGroupAudienceAssociations
  in: AdGroupNegativeAudienceAssociations
  in: ProductAdLabels
  in: AppInstallAdLabels
  in: ExpandedTextAdLabels
  in: DynamicSearchAdLabels
  in: AccountLocationAdExtensions
  in: AccountImageAdExtensions
  in: AccountAppAdExtensions
  in: AccountPriceAdExtensions
  in: AccountReviewAdExtensions
property:
  path: dataScope
  name: data scope
  description: You may include quality score data such as ad relevance, in addition to entity data such as campaign settings. The default value is EntityData. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, EntityData QualityScoreData. If BidSuggestionsData or QualityScoreData are included, you must request a full sync. To perform a full sync, do not set LastSyncTimeInUTC i.e., leave it nil.
  datatype: string
  max count: 1
property:
  path: downloadFileType
  name: download file type
  description: The format of the download file. For possible values, see DownloadFileType. The default is CSV.
  datatype: string
  max count: 1
  in: Csv
  in: Tsv
property:
  path: formatVersion
  name: format version
  description: The format for records of the download file. As a best practice you should always specify the latest format version. Currently the only supported format version for Bing Ads API Version 13 is 6.0. You should manage records according to the Bulk File Schema for the corresponding format version.
  datatype: string
  max count: 1
property:
  path: compressionType
  name: compression type
  description: The compression type of the download file. For possible values, see CompressionType. The default compression type is Zip.
  datatype: string
  max count: 1
  in: Zip
  in: GZip

BulkDownloadCampaignsByCampaignIdsResponseShape
type: NodeShape
target class: BulkDownloadCampaignsByCampaignIdsResponse
property:
  path: downloadRequestId
  name: download request id
  description: The identifier of the download request. You use the identifier to call the GetBulkDownloadStatus operation to check the status of the download. The identifier is valid for a maximum of two days. If you have not successfully downloaded the file within this period, it is removed from the download site and you will need to get a new download request identifier. The string has a length up to 40 and can contain any character.
  datatype: string
  max count: 1

BulkEditorialApiFaultDetailShape
type: NodeShape
target class: BulkEditorialApiFaultDetail
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: editorialErrors
  name: editorial errors
  node: BulkEditorialErrorShape
  class: BulkEditorialError
  node kind: BlankNodeOrIRI
property:
  path: batchErrors
  name: batch errors
  or:
    node: BulkBatchErrorShape
    class: BulkBatchError
  or:
    node: BulkBatchErrorBaseShape
    class: BulkBatchErrorBase
  or:
    node: BulkEditorialErrorShape
    class: BulkEditorialError
  node kind: BlankNodeOrIRI
property:
  path: operationErrors
  name: operation errors
  node: BulkOperationErrorShape
  class: BulkOperationError
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

BulkGetBulkDownloadStatusRequestShape
type: NodeShape
target class: BulkGetBulkDownloadStatusRequest
property:
  path: requestId
  name: request id
  description: The identifier of the download request. The DownloadCampaignsByAccountIds and DownloadCampaignsByCampaignIds operations return this element as the DownloadRequestId. The identifier is valid for a maximum of two days. If you have not successfully downloaded the file within this period, it is removed from the download site and you will need to get a new download request identifier. The string has a length up to 40 and can contain any character.
  datatype: string
  max count: 1

BulkGetBulkDownloadStatusResponseShape
type: NodeShape
target class: BulkGetBulkDownloadStatusResponse
property:
  path: requestStatus
  name: request status
  description: The status of the download. The possible values are as follows. Completed - The download completed successfully. InProgress - The download is in progress. Failed - The download failed. You may submit a new download with fewer entities, without quality score and bid suggestions data, or try again to submit the same download later. FailedFullSyncRequired - The request's LastSyncTimeInUTC element must be set to null, for example if the specified account was included in a data migration. After requesting a full download, you may begin requesting delta downloads again.
  datatype: string
  max count: 1
property:
  path: resultFileUrl
  name: result file url
  description: The URL that contains the download data when the RequestStatus value is Completed. You have five minutes from the time this URL is returned to download the file. If you do not start the download within this time period, you will need to call GetBulkDownloadStatus again to get a new URL. You should not take a dependency on the domain of the download URL, as it is subject to change. The download file is compressed (in zip format), so you must unzip the file to access the data. For information about the bulk file format, see Bulk File Schema.
  datatype: string
  max count: 1
property:
  path: percentComplete
  name: percent complete
  description: The progress completion percentage for system processing of the bulk download file.
  datatype: int
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this operation.
  node: BulkKeyValuePairOfstringAndstringShape
  class: BulkKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: errors
  name: errors
  description: An array of OperationError objects corresponding to errors encountered during the system processing of the bulk file after your download request was submitted.
  node: BulkOperationErrorShape
  class: BulkOperationError
  node kind: BlankNodeOrIRI

BulkGetBulkUploadStatusRequestShape
type: NodeShape
target class: BulkGetBulkUploadStatusRequest
property:
  path: requestId
  name: request id
  description: The identifier of the upload request. The identifier is valid for up to 15 minutes. If you have not successfully uploaded the file within this period, you will need to get a new request identifier and upload URL.
  datatype: string
  max count: 1

BulkGetBulkUploadStatusResponseShape
type: NodeShape
target class: BulkGetBulkUploadStatusResponse
property:
  path: requestStatus
  name: request status
  description: The status of the upload. The following are the possible returned status values. Completed - The upload file was accepted and processed successfully without errors. CompletedWithErrors - The upload completed with one or more errors. While the overall upload was successful, one or more add or update errors could have occurred. As a best practice you should request error information via the ResponseMode element when calling GetBulkUploadUrl and check the ResultFileUrl for any errors. Failed - The entire upload failed due to an unexpected error. You may submit a new upload with fewer entities or try again to submit the same upload later. FileUploaded - The upload request has been received and is in the queue for processing. InProgress - The upload file has been accepted and the upload is in progress. PendingFileUpload - The upload file has not been received for the corresponding RequestId. UploadFileRowCountExceeded - The limit of bulk records in the upload file has been exceeded. For more information about limits and upload best practices, see Bulk Upload. UploadFileFormatNotSupported - The Format Version Name field specified in the upload is not supported for this version of the Bulk API.
  datatype: string
  max count: 1
property:
  path: resultFileUrl
  name: result file url
  description: The URL of the file that contains the requested results, for example upload error information. The URL must be used within five minutes of the time that the GetBulkUploadStatus operation returns the Completed or CompletedWithErrors status response string. If you do not start the download within this period of time, you will need to call GetBulkUploadStatus again to get a new URL. You should not take a dependency on the domain of the download URL, as it is subject to change.
  datatype: string
  max count: 1
property:
  path: percentComplete
  name: percent complete
  description: The progress completion percentage for system processing of the uploaded bulk file. The value range is between 0 and 100. You should also compare the upload status. If the upload fails, the percent complete will reset to zero (0).
  datatype: int
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this operation.
  node: BulkKeyValuePairOfstringAndstringShape
  class: BulkKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: errors
  name: errors
  description: An array of OperationError objects corresponding to errors encountered during the system processing of the bulk file after your HTTP POST upload completed. For example, an OperationError would include the BulkServiceFormatVersionNotSupported error code if the uploaded file contains one or more bulk records that are not supported with the corresponding file format version.
  node: BulkOperationErrorShape
  class: BulkOperationError
  node kind: BlankNodeOrIRI

BulkGetBulkUploadUrlRequestShape
type: NodeShape
target class: BulkGetBulkUploadUrlRequest
property:
  path: responseMode
  name: response mode
  description: Specify whether to return errors and their corresponding data, or only the errors in the results file. The default is ErrorsOnly.
  datatype: string
  max count: 1
  in: ErrorsOnly
  in: ErrorsAndResults
property:
  path: accountId
  name: account id
  description: The account identifier corresponding to the data that will be uploaded.
  datatype: long
  max count: 1

BulkGetBulkUploadUrlResponseShape
type: NodeShape
target class: BulkGetBulkUploadUrlResponse
property:
  path: uploadUrl
  name: upload url
  description: The URL where you may submit your bulk upload file via HTTP POST. The upload URL is valid for up to 15 minutes. If you have not successfully uploaded the file within this period, you will need to get a new request identifier and upload URL.
  datatype: string
  max count: 1
property:
  path: requestId
  name: request id
  description: The identifier of the upload request. The identifier is valid for up to 15 minutes. If you have not successfully uploaded the file within this period, you will need to get a new request identifier and upload URL.
  datatype: string
  max count: 1

BulkUploadEntityRecordsRequestShape
type: NodeShape
target class: BulkUploadEntityRecordsRequest
property:
  path: responseMode
  name: response mode
  datatype: string
  max count: 1
  in: ErrorsOnly
  in: ErrorsAndResults
property:
  path: entityRecords
  name: entity records
  datatype: string
property:
  path: accountId
  name: account id
  datatype: long
  max count: 1

BulkUploadEntityRecordsResponseShape
type: NodeShape
target class: BulkUploadEntityRecordsResponse
property:
  path: entityRecords
  name: entity records
  datatype: string
property:
  path: requestId
  name: request id
  datatype: string
  max count: 1
property:
  path: requestStatus
  name: request status
  datatype: string
  max count: 1
property:
  path: errors
  name: errors
  node: BulkOperationErrorShape
  class: BulkOperationError
  node kind: BlankNodeOrIRI

CampaignManagementAccountContentNegativeKeywordListShape
type: NodeShape
target class: CampaignManagementAccountContentNegativeKeywordList
property:
  path: itemCount
  name: item count
  description: The number of SharedListItem objects that are added to this shared list. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the shared entity. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the shared entity. The maximum string length is 255. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the shared entity. This value is NegativeKeywordList when you retrieve a NegativeKeywordList. This value is PlacementExclusionList when you retrieve a PlacementExclusionList. This value is AccountNegativeKeywordList when you retrieve an AccountNegativeKeywordList. For more information about shared entity types, see SharedEntity Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: associationCount
  name: association count
  description: The number of active associations between this shared entity and another entity such as campaign or ad account. For a NegativeKeywordList, the maximum number of active associations between the negative keyword list and campaign is 20. For a PlacementExclusionList, the maximum number of active associations between the website exclusion list and ad account is undefined. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementKeyValuePairOfstringAndstringShape
type: NodeShape
target class: CampaignManagementKeyValuePairOfstringAndstring
property:
  path: key
  name: key
  datatype: string
  max count: 1
property:
  path: value
  name: value
  datatype: string
  max count: 1

CampaignManagementAccountMigrationStatusesInfoShape
type: NodeShape
target class: CampaignManagementAccountMigrationStatusesInfo
property:
  path: accountId
  name: account id
  description: The Microsoft Advertising identifier of the account.
  datatype: long
  max count: 1
property:
  path: migrationStatusInfos
  name: migration status infos
  description: The list of migration status info for the corresponding account.
  node: CampaignManagementMigrationStatusInfoShape
  class: CampaignManagementMigrationStatusInfo
  node kind: BlankNodeOrIRI

CampaignManagementMigrationStatusInfoShape
type: NodeShape
target class: CampaignManagementMigrationStatusInfo
property:
  path: migrationType
  name: migration type
  description: The migration type.
  datatype: string
  max count: 1
property:
  path: startTimeInUtc
  name: start time in utc
  description: The date and time when the migration began. The value is in Coordinated Universal Time (UTC). The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.
  datatype: dateTime
  max count: 1
property:
  path: status
  name: status
  description: The migration status.
  datatype: string
  max count: 1
  in: NotInPilot
  in: NotStarted
  in: InProgress
  in: Completed

CampaignManagementAccountNegativeKeywordListShape
type: NodeShape
target class: CampaignManagementAccountNegativeKeywordList
property:
  path: itemCount
  name: item count
  description: The number of SharedListItem objects that are added to this shared list. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the shared entity. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the shared entity. The maximum string length is 255. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the shared entity. This value is NegativeKeywordList when you retrieve a NegativeKeywordList. This value is PlacementExclusionList when you retrieve a PlacementExclusionList. This value is AccountNegativeKeywordList when you retrieve an AccountNegativeKeywordList. For more information about shared entity types, see SharedEntity Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: associationCount
  name: association count
  description: The number of active associations between this shared entity and another entity such as campaign or ad account. For a NegativeKeywordList, the maximum number of active associations between the negative keyword list and campaign is 20. For a PlacementExclusionList, the maximum number of active associations between the website exclusion list and ad account is undefined. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementAccountPlacementExclusionListShape
type: NodeShape
target class: CampaignManagementAccountPlacementExclusionList
property:
  path: itemCount
  name: item count
  description: The number of Site objects that are added to this shared list. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the shared entity. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the shared entity. The maximum string length is 255. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the shared entity. This value is NegativeKeywordList when you retrieve a NegativeKeywordList. This value is PlacementExclusionList when you retrieve a PlacementExclusionList. This value is AccountNegativeKeywordList when you retrieve an AccountNegativeKeywordList. For more information about shared entity types, see SharedEntity Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: associationCount
  name: association count
  description: The number of active associations between this shared entity and another entity such as campaign or ad account. For a NegativeKeywordList, the maximum number of active associations between the negative keyword list and campaign is 20. For a PlacementExclusionList, the maximum number of active associations between the website exclusion list and ad account is undefined. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementAccountPlacementInclusionListShape
type: NodeShape
target class: CampaignManagementAccountPlacementInclusionList
property:
  path: itemCount
  name: item count
  description: The number of Site objects that are added to this shared list. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the shared entity. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the shared entity. The maximum string length is 255. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the shared entity. This value is NegativeKeywordList when you retrieve a NegativeKeywordList. This value is PlacementExclusionList when you retrieve a PlacementExclusionList. This value is AccountNegativeKeywordList when you retrieve an AccountNegativeKeywordList. For more information about shared entity types, see SharedEntity Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: associationCount
  name: association count
  description: The number of active associations between this shared entity and another entity such as campaign or ad account. For a NegativeKeywordList, the maximum number of active associations between the negative keyword list and campaign is 20. For a PlacementExclusionList, the maximum number of active associations between the website exclusion list and ad account is undefined. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementAccountPropertyShape
type: NodeShape
target class: CampaignManagementAccountProperty
property:
  path: name
  name: name
  description: The name of the account property.
  datatype: string
  max count: 1
  in: None
  in: TrackingUrlTemplate
  in: MSCLKIDAutoTaggingEnabled
  in: AdClickParallelTracking
  in: FinalUrlSuffix
  in: IncludeViewThroughConversions
  in: ProfileExpansionEnabled
  in: AllowImageAutoRetrieve
  in: AutoApplyRecommendations
  in: IncludeAutoBiddingViewThroughConversions
  in: AutoBiddingViewThroughConversionsValueAttributionWeight
  in: LoopBackWindowForViewThroughConversions
  in: BusinessAttributes
  in: EnableMMAUnderDSAAdgroups
  in: OptOutFromMCM
  in: NetflixTCAccepted
  in: BlockedContentSegments
  in: AssetAIEnhancementOptout
  in: AcceptNielsenTermsAndConditions
  in: ImageMissingWarningOptout
  in: OptOutFromSystemSourcedImagesInSWF
property:
  path: value
  name: value
  description: The value of the named account property. The value will vary by account property name. For more information, see Account Property Values in the section below.
  datatype: string
  max count: 1

CampaignManagementActionAdExtensionShape
type: NodeShape
target class: CampaignManagementActionAdExtension
property:
  path: status
  name: status
  description: The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Deleted
property:
  path: scheduling
  name: scheduling
  description: Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads. Add: Optional Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. To remove all scheduling set this element to an empty Schedule object.
  node: CampaignManagementScheduleShape
  class: CampaignManagementSchedule
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: devicePreference
  name: device preference
  description: Not supported for this ad extension type.
  datatype: long
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad extension. Add: Read-only Update: Read-only and Required
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad extension. This value is ActionAdExtension when you retrieve an action ad extension. Add: Read-only Update: Read-only For more information about ad extension types, see the Ad Extension Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Tracks the number of times the ad extension has been updated. The version is set to 1 when the ad extension is created, and increments by one after each update. Add: Not allowed Update: Not allowed
  datatype: int
  max count: 1
property:
  path: actionType
  name: action type
  description: The action type that you choose here, as well as the Language that you set, determines the text that is displayed on your call-to-action button. Microsoft Advertising does not support all action types for all languages. If you attempt to use an unsupported action type and language combination, an error will be returned. For details see Action Text for Action Ad Extensions. Add: Required Update: Required
  datatype: string
  max count: 1
  in: Unknown
  in: ActNow
  in: ApplyNow
  in: BetNow
  in: BidNow
  in: BookACar
  in: BookHotel
  in: BookNow
  in: Browse
  in: BuyNow
  in: ChatNow
  in: Compare
  in: ContactUs
  in: Coupon
  in: Donate
  in: Download
  in: EmailNow
  in: EnrollNow
  in: Explore
  in: FileNow
  in: FindJob
  in: FreePlay
  in: FreeQuote
  in: FreeTrial
  in: GetDeals
  in: GetOffer
  in: GetQuote
  in: JoinNow
  in: LearnMore
  in: ListenNow
  in: LogIn
  in: Message
  in: NewCars
  in: OrderNow
  in: PlayGame
  in: PlayNow
  in: PostJob
  in: Register
  in: RentACar
  in: RentNow
  in: Reserve
  in: Sale
  in: SaveNow
  in: Schedule
  in: SeeMenu
  in: SeeMore
  in: SeeOffer
  in: SellNow
  in: ShopNow
  in: Showtimes
  in: SignIn
  in: SignUp
  in: StartFree
  in: StartNow
  in: Subscribe
  in: TestDrive
  in: TryNow
  in: UsedCars
  in: ViewCars
  in: ViewNow
  in: ViewPlans
  in: VisitSite
  in: VoteNow
  in: Watch
  in: WatchMore
  in: WatchNow
  in: Directions
  in: FindStore
  in: SwitchNow
  in: VisitStore
  in: RenewNow
  in: Reorder
  in: BuildNow
  in: Dealers
  in: GetDemo
property:
  path: language
  name: language
  description: The language that the ad extension will be served in. The extension will always be served in this language, regardless of the campaign or ad group's language settings. The supported language strings are: Danish, Dutch, English, Finnish, French, German, Italian, Norwegian, Portuguese, Spanish, Swedish, and TraditionalChinese. Microsoft Advertising does not support all action types for all languages. If you attempt to use an unsupported action type and language combination, an error will be returned. For details see Action Text for Action Ad Extensions. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: finalMobileUrls
  name: final mobile urls
  description: This is a mobile-friendly landing page URL when Action Extensions are served on mobile devices. If you specify final mobile URLs, you must also specify FinalUrls. The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. Add: Optional Update: Optional. If you set this element null, the previous setting will be deleted.
  datatype: string
property:
  path: finalUrls
  name: final urls
  description: This is the link to your specific web page or form that corresponds to the action text. When an action URL isn't provided, the ad's final URL will be used. The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. Although the data type is a list of strings, only the first list item is used by Microsoft Advertising. Add: Optional Update: Optional. If you set this element null, the previous setting will be deleted.
  datatype: string
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all FinalUrls and FinalMobileUrls. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If you set this element null, the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If you set this element null, the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. For customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635), Microsoft Advertising will accept the first 8 custom parameter key and value pairs that you include, and if you include more than 8 custom parameters an error will be returned. Add: Optional Update: Optional. If you set this element null, the previous setting will be deleted.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. There are currently no forward compatibility changes for the AdExtension object. Add: Read-only Update: Read-only
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementScheduleShape
type: NodeShape
target class: CampaignManagementSchedule
property:
  path: startDate
  name: start date
  description: The scheduled start date. The start date is inclusive. For example, if you set StartDate to 5/5/2020, the ad extensions will start being shown at 12:00 AM on 5/5/2020. Add: Required with a FlyerAdExtension; Optional for other ad extension types. If you do not specify a start date, the ad extensions are immediately eligible to be scheduled during the day and time ranges. Update: Optional. For most ad extension types the start date can be shortened or extended, as long as the end date is either null or occurs after the new start date. If set the start date to null, then you are effectively removing the start date and the ad extensions are immediately eligible to be scheduled during the day and time ranges. With a FlyerAdExtension you can cannot remove the start date. The start date can be shortened or extended, as long as the end date occurs up to 30 days after the new start date.
  node: CampaignManagementDateShape
  class: CampaignManagementDate
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: The scheduled end date. The end date is inclusive. For example, if you set EndDate to 12/31/2020, the ad extensions will stop being shown at 11:59 PM on 12/31/2020. Add: Required with a FlyerAdExtension; Optional for other ad extension types. For most ad extension types if you do not specify an end date, the ad extensions will continue to be delivered unless you pause the associated campaigns, ad groups, or ads. Update: Optional. For most ad extension types the end date can be shortened or extended, as long as the start date is either null or occurs before the new end date. If you set the end date to null, then you are effectively removing the end date and the ad extensions will continue to be delivered unless you pause the associated campaigns, ad groups, or ads. With a FlyerAdExtension you can cannot remove the end date; The end date can be shortened or extended, as long as the start date occurs up to 30 days before the new end date.
  node: CampaignManagementDateShape
  class: CampaignManagementDate
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: useSearcherTimeZone
  name: use searcher time zone
  description: Determines whether to use the account time zone or the time zone of the search user where the ads could be delivered. Set this property to true if you want the ad extensions to be shown in the search user's time zone, and otherwise set it to false. Add: Optional. If you do not specify this element or leave it null, the default value of false will be set and the account time zone will be used. Update: When you update a schedule the existing settings are replaced with the new setting. Thus if you update a schedule and leave this element null, then you are effectively resetting to the default value of false.
  datatype: boolean
  max count: 1
property:
  path: dayTimeRanges
  name: day time ranges
  description: The list of day and time ranges. Each day and time range includes the scheduled day of week, start/end hour, and start/end minute. Add: Optional. If you set this element to null, then ad extensions will be eligible for scheduling anytime during the calendar start and end dates. Update: Optional. The individual DayTime objects cannot be updated. You can effectively update the day and time ranges by sending a new list of all DayTime settings that should replace the prior set. If you set this element to null, then you are effectively removing all existing day and time ranges.
  node: CampaignManagementDayTimeShape
  class: CampaignManagementDayTime
  node kind: BlankNodeOrIRI

CampaignManagementDateShape
type: NodeShape
target class: CampaignManagementDate
property:
  path: year
  name: year
  description: Specifies the year. Add: Required Update: Required
  datatype: int
  max count: 1
property:
  path: month
  name: month
  description: Specifies the month. Add: Required Update: Required
  datatype: int
  max count: 1
property:
  path: day
  name: day
  description: Specifies the day of the month. Add: Required Update: Required
  datatype: int
  max count: 1

CampaignManagementDayTimeShape
type: NodeShape
target class: CampaignManagementDayTime
property:
  path: day
  name: day
  description: The scheduled day of week. Add: Required. Update: The DayTime object cannot be updated.
  datatype: string
  max count: 1
  in: Sunday
  in: Monday
  in: Tuesday
  in: Wednesday
  in: Thursday
  in: Friday
  in: Saturday
property:
  path: startHour
  name: start hour
  description: The scheduled start hour. The possible values range from 0 to 23, where 0 is equivalent to 12:00AM and 12 is 12:00PM. Add: Required. Update: The DayTime object cannot be updated.
  datatype: int
  max count: 1
property:
  path: startMinute
  name: start minute
  description: The scheduled start minute. The possible values range from 0 to 60. Add: Required. Update: The DayTime object cannot be updated.
  datatype: string
  max count: 1
  in: Zero
  in: Fifteen
  in: Thirty
  in: FortyFive
property:
  path: endHour
  name: end hour
  description: The scheduled end hour. The possible values range from 0 to 24, where 0 is equivalent to 12:00AM and 12 is 12:00PM. Add: Required. Update: The DayTime object cannot be updated.
  datatype: int
  max count: 1
property:
  path: endMinute
  name: end minute
  description: The scheduled end minute. The possible values range from 0 to 60. Add: Required. Update: The DayTime object cannot be updated.
  datatype: string
  max count: 1
  in: Zero
  in: Fifteen
  in: Thirty
  in: FortyFive

CampaignManagementCustomParametersShape
type: NodeShape
target class: CampaignManagementCustomParameters
property:
  path: parameters
  name: parameters
  description: The collection of key and value custom parameters for URL tracking. For campaigns, ad groups, and ad groups, ad group criterions, and ads Microsoft Advertising will accept the first 8 custom parameter key and value pairs that you include, and if you include more than 8 custom parameters an error will be returned. For action, price, and sitelink ad extensions Microsoft Advertising will accept the first 3 custom parameter key and value pairs that you include, and any additional custom parameters will be ignored. For customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635) for action, price, and sitelink ad extensions, Microsoft Advertising will accept the first 8 custom parameter key and value pairs that you include, and if you include more than 8 custom parameters an error will be returned. Add: Required Update: Optional. Once you create this CustomParameters object, the existing custom parameters will be removed or replaced. To remove all existing custom parameters create this CustomParameters object and set the Parameters element to nil. To replace or append to the list of custom parameters, create this CustomParameters object and assign to the Parameters element a new list of CustomParameter objects, including any previous custom parameters that you want to retain. To retain all of the existing custom parameters, set the element that uses this CustomParameters object to nil. For example set the UrlCustomParameters element of an ExpandedTextAd to nil if you do not want to update any of the custom parameters.CustomParameter array
  node: CampaignManagementCustomParameterShape
  class: CampaignManagementCustomParameter
  node kind: BlankNodeOrIRI

CampaignManagementCustomParameterShape
type: NodeShape
target class: CampaignManagementCustomParameter
property:
  path: key
  name: key
  description: The name of the custom parameter that you want to track. The maximum length of this string is 16, in UTF-8 bytes. With the Campaign Management service you may not specify special characters such as braces and underscore: \"\{\", \"\_\", and \"\}\". With the Bulk service the surrounding braces and underscore are required. The maximum length of 16 UTF-8 bytes does not include the optional braces and underscore: \"\{\", \"\_\", and \"\}\". Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: value
  name: value
  description: The value to track using your custom parameter. The maximum length of this string is 200, in UTF-8 bytes. You can set the value to an empty string ("") but it cannot be null or empty. The maximum length of the value string is 250 for all entities except action, price, and sitelink ad extensions. The maximum length of the value string is 200 for action, price, and sitelink ad extensions. For action, price, and sitelink ad extensions, the maximum length increases to 250 for customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635). Add: Required Update: Required
  datatype: string
  max count: 1

CampaignManagementAdShape
type: NodeShape
target class: CampaignManagementAd
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the ad.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad. For more information about ad types, see the Remarks.
  datatype: string
  max count: 1
  in: Text
  in: Image
  in: Product
  in: AppInstall
  in: ExpandedText
  in: DynamicSearch
  in: ResponsiveAd
  in: ResponsiveSearch
  in: Hotel
property:
  path: status
  name: status
  description: The status of the ad. You can set the ad status to Active or Paused.
  datatype: string
  max count: 1
  in: Inactive
  in: Active
  in: Paused
  in: Deleted
property:
  path: editorialStatus
  name: editorial status
  description: The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved.
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: devicePreference
  name: device preference
  description: Determines the device preference for showing the ad. Device preference is only supported for AppInstallAd and TextAd objects.
  datatype: long
  max count: 1
property:
  path: adFormatPreference
  name: ad format preference
  description: The Ad Format Preference is used to indicate whether or not you prefer the ad copy to be shown to users as a search or audience ad. Search ads tend to be written as a call to action, whereas audience ads should be written in more of an informational style. While you have the option to use search ads as audience ads, designating an ad as Audience ads preferred format allows you to optimize its messaging for native delivery. Possible values are AudienceAd and All. If set to All, the ad will be eligible for both search and audience ad formats. If set to AudienceAd, the ad will only be eligible for the audience ad format. Ad Format Preference is only supported for ExpandedTextAd and TextAd objects.
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all landing page URLs. This element is only supported for AppInstallAd, DynamicSearchAd, ExpandedTextAd, ResponsiveAd, ResponsiveSearchAd, and TextAd objects. It is not supported with the ProductAd object.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. This element is only supported for AppInstallAd, DynamicSearchAd, ExpandedTextAd, ResponsiveAd, and ResponsiveSearchAd objects. It is not supported with the ProductAd and and TextAd objects.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. This element is only supported for AppInstallAd, DynamicSearchAd, ExpandedTextAd, ResponsiveAd, ResponsiveSearchAd, and TextAd objects. It is not supported with the ProductAd object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: The last or final URL where a user is ultimately taken, whether or not the click to final URL path included any redirects. This element is only supported for AppInstallAd, ExpandedTextAd, ResponsiveAd, ResponsiveSearchAd, and TextAd objects. It is not supported with the DynamicSearchAd and ProductAd objects.
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The mobile landing page URL. This element is only supported for ExpandedTextAd, ResponsiveAd, ResponsiveSearchAd, and TextAd objects. It is not supported with the AppInstallAd, DynamicSearchAd, and ProductAd objects.
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  description: For future use.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: destinationUrl
  name: destination url
  datatype: string
  max count: 1
property:
  path: title
  name: title
  datatype: string
  max count: 1
property:
  path: text
  name: text
  datatype: string
  max count: 1
property:
  path: displayUrl
  name: display url
  datatype: string
  max count: 1
property:
  path: promotionalText
  name: promotional text
  datatype: string
  max count: 1
property:
  path: appPlatform
  name: app platform
  datatype: string
  max count: 1
property:
  path: appStoreId
  name: app store id
  datatype: string
  max count: 1
property:
  path: titlePart1
  name: title part1
  datatype: string
  max count: 1
property:
  path: titlePart2
  name: title part2
  datatype: string
  max count: 1
property:
  path: path1
  name: path1
  datatype: string
  max count: 1
property:
  path: path2
  name: path2
  datatype: string
  max count: 1
property:
  path: domain
  name: domain
  datatype: string
  max count: 1
property:
  path: titlePart3
  name: title part3
  datatype: string
  max count: 1
property:
  path: textPart2
  name: text part2
  datatype: string
  max count: 1
property:
  path: headline
  name: headline
  datatype: string
  max count: 1
property:
  path: longHeadlineString
  name: long headline string
  datatype: string
  max count: 1
property:
  path: businessName
  name: business name
  datatype: string
  max count: 1
property:
  path: callToAction
  name: call to action
  datatype: string
  max count: 1
  in: Unknown
  in: ActNow
  in: ApplyNow
  in: BetNow
  in: BidNow
  in: BookACar
  in: BookHotel
  in: BookNow
  in: Browse
  in: BuyNow
  in: ChatNow
  in: Compare
  in: ContactUs
  in: Coupon
  in: Donate
  in: Download
  in: EmailNow
  in: EnrollNow
  in: Explore
  in: FileNow
  in: FindJob
  in: FreePlay
  in: FreeQuote
  in: FreeTrial
  in: GetDeals
  in: GetOffer
  in: GetQuote
  in: JoinNow
  in: LearnMore
  in: ListenNow
  in: LogIn
  in: Message
  in: NewCars
  in: OrderNow
  in: PlayGame
  in: PlayNow
  in: PostJob
  in: Register
  in: RentACar
  in: RentNow
  in: Reserve
  in: Sale
  in: SaveNow
  in: Schedule
  in: SeeMenu
  in: SeeMore
  in: SeeOffer
  in: SellNow
  in: ShopNow
  in: Showtimes
  in: SignIn
  in: SignUp
  in: StartFree
  in: StartNow
  in: Subscribe
  in: TestDrive
  in: TryNow
  in: UsedCars
  in: ViewCars
  in: ViewNow
  in: ViewPlans
  in: VisitSite
  in: VoteNow
  in: Watch
  in: WatchMore
  in: WatchNow
  in: Directions
  in: FindStore
  in: SwitchNow
  in: VisitStore
  in: RenewNow
  in: Reorder
  in: Default
  in: NoButton
  in: Install
  in: AddToCart

CampaignManagementAppUrlShape
type: NodeShape
target class: CampaignManagementAppUrl
property:
  path: osType
  name: os type
  description: Reserved for future use.
  datatype: string
  max count: 1
property:
  path: url
  name: url
  description: Reserved for future use.
  datatype: string
  max count: 1

CampaignManagementAssetLinkShape
type: NodeShape
target class: CampaignManagementAssetLink
property:
  path: asset
  name: asset
  description: The asset with a unique Microsoft Advertising identifier that can be reused across multiple ads. For asset links included in a responsive search ad's Headlines and Descriptions lists, the asset must be a TextAsset. Add: Required Update: Required
  or:
    node: CampaignManagementAssetShape
    class: CampaignManagementAsset
  or:
    node: CampaignManagementAssetBaseShape
    class: CampaignManagementAssetBase
  or:
    node: CampaignManagementImageAssetShape
    class: CampaignManagementImageAsset
  or:
    node: CampaignManagementTextAssetShape
    class: CampaignManagementTextAsset
  or:
    node: CampaignManagementVideoAssetShape
    class: CampaignManagementVideoAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: pinnedField
  name: pinned field
  description: Determines whether the asset should only be used for a specific ad component, or whether you want Bing AI to optimize the layout for this asset. Unless you have a specific requirement for an asset, don't pin it and let Bing AI optimize the placement. If the Asset is a TextAsset and included in the responsive search ad's Descriptions list, the valid pinned field values are Description1 and Description2. At least one eligible TextAsset must be available for each description position, so you cannot pin all of the assets to the same position. For example you can have 3 text assets pinned to Description1, so long as you have at least one text asset in the responsive search ad's Descriptions list that is either not pinned, or pinned to Description2. If the Asset is a TextAsset and included in the responsive search ad's Headlines list, the valid pinned field values are Headline1, Headline2, and Headline3. At least one eligible TextAsset must be available for each headline position, so you cannot pin all of the assets to the same position. For example you can have 3 text assets pinned to Headline1 and 3 text assets pinned to Headline2, so long as you have at least one text asset in the responsive search ad's Headlines list that is either not pinned, or pinned to Headline3. If you previously pinned an asset to an ad component and later want to remove the pin, you'll need to update the ad with the existing assets and leave the pinned field element empty for the asset or assets that you want to unpin. When you retrieve an asset that is not pinned, the string value is nil or empty. PinnedField shouldn't be set for Performance Max AssetGroup as it doesn't apply. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: assetPerformanceLabel
  name: asset performance label
  description: This lets you know how well the asset is performing. The possible ratings include: - Low: This asset's performance is low and we recommend you replace this asset to improve your ad performance. - Good: This asset is performing well. We recommend you keep this asset and add more assets to improve your ad performance. - Best: This asset's performance is among the best and we recommend that you add more similar assets. - Unrated: We don't have any performance rating for this asset. This can be due to the asset being inactive, not having enough information to determine its performance, or if there aren't enough similar assets to compare against it. - Learning: The asset's performance is being actively evaluated. Once the evaluation is complete, the asset rating will be Low, Good, Best, or Unrated. Add: Read-only. The service will ignore this value if set. Update: Read-only. The service will ignore this value if set.
  datatype: string
  max count: 1
property:
  path: editorialStatus
  name: editorial status
  description: The editorial review status of the asset link, which indicates whether the asset is pending review, has been approved, or has been disapproved. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Unknown
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited

CampaignManagementAssetShape
type: NodeShape
target class: CampaignManagementAsset
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the asset in a Microsoft Advertising account. The same asset can be used by multiple ads. For example if Seemless Integration is a text asset, it will have the same asset identifier across all ads in the same Microsoft Advertising account.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Reserved for future use.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the asset. For more information about asset types, see the Remarks.
  datatype: string
  max count: 1
property:
  path: text
  name: text
  datatype: string
  max count: 1
property:
  path: subType
  name: sub type
  datatype: string
  max count: 1
property:
  path: cropX
  name: crop x
  datatype: int
  max count: 1
property:
  path: cropY
  name: crop y
  datatype: int
  max count: 1
property:
  path: cropWidth
  name: crop width
  datatype: int
  max count: 1
property:
  path: cropHeight
  name: crop height
  datatype: int
  max count: 1
property:
  path: targetWidth
  name: target width
  datatype: int
  max count: 1
property:
  path: targetHeight
  name: target height
  datatype: int
  max count: 1
property:
  path: croppingType
  name: cropping type
  datatype: string
  max count: 1
  in: ManualCrop
  in: CenterCrop
  in: SmartCrop
  in: Unknown
property:
  path: thumbnailImage
  name: thumbnail image
  node: CampaignManagementImageAssetShape
  class: CampaignManagementImageAsset
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementImageAssetShape
type: NodeShape
target class: CampaignManagementImageAsset
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the asset in a Microsoft Advertising account. The same image asset identifier can be used multiple times in the same ad for different aspect ratios, and can also be used by multiple ads in the same Microsoft Advertising account. The identifier of image asset with SubType set to LandscapeImageMedia is used for all auto-generated image asset sub types within the same ad. Whether or not you let Microsoft Advertising automatically generate the cropped images, the Id does not need to be unique among the image assets linked to the same ad. You can create media for responsive ads via the AddMedia service operation. Then you can use the returned media identifier as the image asset ID. The aspect ratio of the image that you added must be supported for the image asset SubType. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Reserved for future use. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the asset. This value is ImageAsset when you retrieve an image asset. For more information about asset types, see the Asset Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: subType
  name: sub type
  description: Represents the aspect ratio for this image asset. The aspect ratio for the sub type must match the effective image asset dimensions. If CropHeight and CropWidth are not used then the aspect ratio for the sub type must match the aspect ratio of the stored image media. If CropHeight and CropWidth are used then the true aspect ratio of the media that is stored in the account level media library can differ, so long as CropHeight and CropWidth result in the correct aspect ratio. In either case the true aspect ratio of the media that is stored in the account level media library will remain unchanged. The sub type must be set to "Logo" if the image is associated with an ad as a "LandscapeLogoMedia" or "SquareLogoMedia". The possible sub type values include OriginalImage, LandscapeLogoMedia, SquareLogoMedia, LandscapeImageMedia, SquareImageMedia, ImageMedia169X100, ImageMedia201X100, ImageMedia120X100, ImageMedia200X100, ImageMedia124X100, ImageMedia153X100. For more details see ResponsiveAd Remarks. Note: As of now, the SubType OriginalImage replaces the role of LandscapeImageMedia as the default image for ResponsiveAd of Audience Campaign. New sub types might be added in the future, so you should not take any dependency on a fixed set of values. Add: Required Update: Read-only. You cannot update the sub type during update.
  datatype: string
  max count: 1
property:
  path: cropX
  name: crop x
  description: Starting from the lower left corner of image asset source, this is the number of pixels to skip to the right on the x-axis before applying the CropWidth. Add: Optional. If you do not set this element, the service will automatically crop according to the aspect ratio of the SubType. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: int
  max count: 1
property:
  path: cropY
  name: crop y
  description: Starting from the lower left corner of image asset source, this is the number of pixels to skip upwards on the y-axis before applying the CropHeight. Add: Optional. If you do not set this element, the service will automatically crop according to the aspect ratio of the SubType. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: int
  max count: 1
property:
  path: cropWidth
  name: crop width
  description: The number of pixels to use from the image asset source, starting from the CropX position and moving to the right. Add: Optional. If you do not set this element, the service will automatically crop according to the aspect ratio of the SubType. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: int
  max count: 1
property:
  path: cropHeight
  name: crop height
  description: The number of pixels to use from the image asset source, starting from the CropY position and moving upwards. Add: Optional. If you do not set this element, the service will automatically crop according to the aspect ratio of the SubType. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: int
  max count: 1
property:
  path: targetWidth
  name: target width
  description: The target width dimension of an image asset.
  datatype: int
  max count: 1
property:
  path: targetHeight
  name: target height
  description: The target height dimension of an image asset.
  datatype: int
  max count: 1
property:
  path: croppingType
  name: cropping type
  description: Defines the possible cropping types.
  datatype: string
  max count: 1
  in: ManualCrop
  in: CenterCrop
  in: SmartCrop
  in: Unknown

CampaignManagementVerifiedTrackingSettingShape
type: NodeShape
target class: CampaignManagementVerifiedTrackingSetting
property:
  path: type
  name: type
  description: The type of the setting. This value is VerifiedTracking when you retrieve a verified tracking setting. For more information about setting types, see the Setting Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: details
  name: details
  description: Key-value pairs for the VerifiedTrackingSetting object. VerifiedTrackingSetting relates third-party measurement settings. This allows you to track viewability, brand safety, and invalid traffic metrics via a third-party verification provider, such as Integral Ad Science. This feature is available for native, display, and online video ads using the CPM bid strategy. Note: Currently, IAS is the only supported vendor (vendorName), but other verification providers are coming soon. The example below pertains to IAS. There are 3 key-value pairs for IAS:"vendorName""advertiserEntityID" (client ID for your verification provider)"publisherEntityID" (reporting ID for your verification provider)Example (required for IAS): vendorName : "IAS"advertiserEntityID : "12345678"publisherEntityID : "12345678"
  node: ListLevel1Shape
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementAdApiErrorShape
type: NodeShape
target class: CampaignManagementAdApiError
property:
  path: code
  name: code
  description: A numeric error code that identifies the error.
  datatype: int
  max count: 1
property:
  path: message
  name: message
  description: A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.
  datatype: string
  max count: 1
property:
  path: detail
  name: detail
  description: A message that contains additional details about the error. This string can be empty.
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error. For example, UserIsNotAuthorized.
  datatype: string
  max count: 1

CampaignManagementAdApiFaultDetailShape
type: NodeShape
target class: CampaignManagementAdApiFaultDetail
property:
  path: trackingId
  name: tracking id
  description: The identifier of the log entry that contains the details of the API call.
  datatype: string
  max count: 1
property:
  path: errors
  name: errors
  description: An array of AdApiError objects that contains the details that explain why the service operation failed.
  node: CampaignManagementAdApiErrorShape
  class: CampaignManagementAdApiError
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementAdBaseShape
type: NodeShape
target class: CampaignManagementAdBase
property:
  path: id
  name: id
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
  in: Text
  in: Image
  in: Product
  in: AppInstall
  in: ExpandedText
  in: DynamicSearch
  in: ResponsiveAd
  in: ResponsiveSearch
  in: Hotel
property:
  path: status
  name: status
  datatype: string
  max count: 1
  in: Inactive
  in: Active
  in: Paused
  in: Deleted
property:
  path: editorialStatus
  name: editorial status
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: devicePreference
  name: device preference
  datatype: long
  max count: 1
property:
  path: adFormatPreference
  name: ad format preference
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementAdCenterAuthenticationFaultShape
type: NodeShape
target class: CampaignManagementAdCenterAuthenticationFault
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  datatype: string
  max count: 1
  in: NoCredential
  in: InvalidCustomerId
  in: InvalidSecurityTicket
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementAdCenterAuthorizationFaultShape
type: NodeShape
target class: CampaignManagementAdCenterAuthorizationFault
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementAdCenterFaultShape
type: NodeShape
target class: CampaignManagementAdCenterFault
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementAdCenterInternalErrorFaultShape
type: NodeShape
target class: CampaignManagementAdCenterInternalErrorFault
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementAdCenterSystemFaultShape
type: NodeShape
target class: CampaignManagementAdCenterSystemFault
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementAddAdExtensionsRequestShape
type: NodeShape
target class: CampaignManagementAddAdExtensionsRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account to add the extensions to.
  datatype: long
  max count: 1
property:
  path: adExtensions
  name: ad extensions
  description: The list of ad extensions of any type to add to the account. You can specify a maximum of 100 extensions per call.
  or:
    node: CampaignManagementActionAdExtensionShape
    class: CampaignManagementActionAdExtension
  or:
    node: CampaignManagementAdExtensionShape
    class: CampaignManagementAdExtension
  or:
    node: CampaignManagementAdExtensionBaseShape
    class: CampaignManagementAdExtensionBase
  or:
    node: CampaignManagementAppAdExtensionShape
    class: CampaignManagementAppAdExtension
  or:
    node: CampaignManagementCallAdExtensionShape
    class: CampaignManagementCallAdExtension
  or:
    node: CampaignManagementCalloutAdExtensionShape
    class: CampaignManagementCalloutAdExtension
  or:
    node: CampaignManagementDataTableAdExtensionShape
    class: CampaignManagementDataTableAdExtension
  or:
    node: CampaignManagementDisclaimerAdExtensionShape
    class: CampaignManagementDisclaimerAdExtension
  or:
    node: CampaignManagementFilterLinkAdExtensionShape
    class: CampaignManagementFilterLinkAdExtension
  or:
    node: CampaignManagementFlyerAdExtensionShape
    class: CampaignManagementFlyerAdExtension
  or:
    node: CampaignManagementImageAdExtensionShape
    class: CampaignManagementImageAdExtension
  or:
    node: CampaignManagementLeadFormAdExtensionShape
    class: CampaignManagementLeadFormAdExtension
  or:
    node: CampaignManagementLocationAdExtensionShape
    class: CampaignManagementLocationAdExtension
  or:
    node: CampaignManagementLogoAdExtensionShape
    class: CampaignManagementLogoAdExtension
  or:
    node: CampaignManagementNewsAdExtensionShape
    class: CampaignManagementNewsAdExtension
  or:
    node: CampaignManagementPriceAdExtensionShape
    class: CampaignManagementPriceAdExtension
  or:
    node: CampaignManagementPromotionAdExtensionShape
    class: CampaignManagementPromotionAdExtension
  or:
    node: CampaignManagementReviewAdExtensionShape
    class: CampaignManagementReviewAdExtension
  or:
    node: CampaignManagementSitelinkAdExtensionShape
    class: CampaignManagementSitelinkAdExtension
  or:
    node: CampaignManagementStructuredSnippetAdExtensionShape
    class: CampaignManagementStructuredSnippetAdExtension
  or:
    node: CampaignManagementVideoAdExtensionShape
    class: CampaignManagementVideoAdExtension
  node kind: BlankNodeOrIRI

CampaignManagementAdExtensionShape
type: NodeShape
target class: CampaignManagementAdExtension
property:
  path: status
  name: status
  description: The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions.
  datatype: string
  max count: 1
  in: Active
  in: Deleted
property:
  path: scheduling
  name: scheduling
  description: Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads.
  node: CampaignManagementScheduleShape
  class: CampaignManagementSchedule
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: devicePreference
  name: device preference
  description: This element determines whether the preference is for the ad extension to be displayed on mobile devices or all devices. To specify a preference for mobile devices, set this element to 30001. To specify all devices, set this element to 0 (zero) or leave the element nil. By default, this element will be nil. This element is only applicable for the AppAdExtension and SitelinkAdExtension types.
  datatype: long
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad extension.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of ad extension. For more information, see Remarks.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Tracks the number of times the ad extension has been updated. The version is set to 1 when the ad extension is created, and increments by one after each update.
  datatype: int
  max count: 1
property:
  path: address
  name: address
  node: CampaignManagementAddressShape
  class: CampaignManagementAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: geoPoint
  name: geo point
  node: CampaignManagementGeoPointShape
  class: CampaignManagementGeoPoint
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: geoCodeStatus
  name: geo code status
  datatype: string
  max count: 1
  in: Pending
  in: Complete
  in: Invalid
  in: Failed
property:
  path: companyName
  name: company name
  datatype: string
  max count: 1
property:
  path: phoneNumber
  name: phone number
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: countryCode
  name: country code
  datatype: string
  max count: 1
property:
  path: isCallOnly
  name: is call only
  datatype: boolean
  max count: 1
property:
  path: isCallTrackingEnabled
  name: is call tracking enabled
  datatype: boolean
  max count: 1
property:
  path: requireTollFreeTrackingNumber
  name: require toll free tracking number
  datatype: boolean
  max count: 1
property:
  path: alternativeText
  name: alternative text
  datatype: string
  max count: 1
property:
  path: description
  name: description
  datatype: string
  max count: 1
property:
  path: destinationUrl
  name: destination url
  datatype: string
  max count: 1
property:
  path: imageMediaIds
  name: image media ids
  datatype: long
property:
  path: trackingUrlTemplate
  name: tracking url template
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: images
  name: images
  node: CampaignManagementAssetLinkShape
  class: CampaignManagementAssetLink
  node kind: BlankNodeOrIRI
property:
  path: displayText
  name: display text
  datatype: string
  max count: 1
property:
  path: layouts
  name: layouts
  datatype: string
property:
  path: sourceType
  name: source type
  datatype: string
  max count: 1
property:
  path: appPlatform
  name: app platform
  datatype: string
  max count: 1
property:
  path: appStoreId
  name: app store id
  datatype: string
  max count: 1
property:
  path: name
  name: name
  datatype: string
  max count: 1
property:
  path: sourceUrl
  name: source url
  datatype: string
  max count: 1
property:
  path: filter
  name: filter
  datatype: string
  max count: 1
property:
  path: priority
  name: priority
  datatype: int
  max count: 1

CampaignManagementAddressShape
type: NodeShape
target class: CampaignManagementAddress
property:
  path: streetAddress
  name: street address
  description: The first line of the address. The first line can contain a maximum of 80 characters. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: streetAddress2
  name: street address2
  description: The second line of the address. The second line can contain a maximum of 80 characters. Add: Optional Update: Optional. If you set this element null, the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: cityName
  name: city name
  description: The name of the city where the street address is located. The name can contain a maximum of 80 characters. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: provinceCode
  name: province code
  description: A code that identifies the state or province where the street address is located. For example, WA. The code can contain a maximum of 50 characters. You must specify either ProvinceName or ProvinceCode. The ProvinceCode and ProvinceName are not required if the CountryCode element is set to either FR, IE, or SG. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: provinceName
  name: province name
  description: The name of the state or province where the street address is located. For example, Washington. The name can contain a maximum of 50 characters. You must specify either ProvinceName or ProvinceCode. TheProvinceCode and ProvinceName are not required if the CountryCode element is set to either FR, IE, or SG. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: postalCode
  name: postal code
  description: The postal or zip code. The postal code can contain a maximum of 80 characters. Add: Optional Update: Optional. If you set this element null, the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: countryCode
  name: country code
  description: The country where the street address is located. The country code must contain a 2 character country code. The supported country code values include AR, AT, AU, BR, CA, CH, CL, CO, DE, DK, ES, FI, FR, GB, HK, ID, IE, IN, IT, MX, MY, NL, NZ, NO, PE, PH, SE, SG, TH, TW, US, VE, and VN. Add: Required Update: Required
  datatype: string
  max count: 1

CampaignManagementGeoPointShape
type: NodeShape
target class: CampaignManagementGeoPoint
property:
  path: latitudeInMicroDegrees
  name: latitude in micro degrees
  description: The latitude specified in micro degrees. The latitude must be greater than or equal to -85000000 and less than or equal to +85000000.
  datatype: int
  max count: 1
property:
  path: longitudeInMicroDegrees
  name: longitude in micro degrees
  description: The longitude specified in micro degrees. The longitude must be greater than or equal to -180000000 and less than or equal to +180000000.
  datatype: int
  max count: 1

CampaignManagementPriceTableRowShape
type: NodeShape
target class: CampaignManagementPriceTableRow
property:
  path: header
  name: header
  description: The header that precedes the pricing data. The header can contain a maximum of 25 characters. The header must tie directly to the priceextensiontype that you defined for the PriceAdExtension. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description must provide further information about the header that is also defined in this object. The description can contain a maximum of 25 characters. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: The landing page URL. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 list items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 list items for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. - If the TrackingUrlTemplate or UrlCustomParameters elements are set, then at least one final URL is required. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The landing page URL for mobile devices. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 list items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 list items for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
property:
  path: price
  name: price
  description: The price that you are advertising. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: double
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: The currency code for the listed price. The supported currency codes are ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, DKK, EUR, GBP, HKD, INR, MXN, NZD, PEN, PHP, PLN, SEK, SGD, USD, TWD, and VEF. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: priceUnit
  name: price unit
  description: The price unit allows you to specify the cost in terms of hour, day, week, etc. The price qualifier for a given product or service e.g., starting from a specific price and up to a maximum price. Possible values include: PerDay, PerHour, PerMonth, PerNight, PerWeek, PerYear, None, and Unknown. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Unknown
  in: PerHour
  in: PerDay
  in: PerWeek
  in: PerMonth
  in: PerYear
  in: None
  in: PerNight
property:
  path: priceQualifier
  name: price qualifier
  description: The price qualifier for a given product or service e.g., starting from a specific price and up to a maximum price. Possible values include: Average, From, UpTo, None, and Unknown. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Unknown
  in: From
  in: UpTo
  in: None
  in: Average
property:
  path: termsAndConditions
  name: terms and conditions
  description: Reserved for future use.
  datatype: string
  max count: 1
property:
  path: termsAndConditionsUrl
  name: terms and conditions url
  description: Reserved for future use.
  datatype: string
  max count: 1

CampaignManagementLeadFormQuestionDefinitionShape
type: NodeShape
target class: CampaignManagementLeadFormQuestionDefinition
property:
  path: uniqueQuestionId
  name: unique question id
  datatype: int
  max count: 1
property:
  path: answers
  name: answers
  datatype: string

CampaignManagementAddAdExtensionsResponseShape
type: NodeShape
target class: CampaignManagementAddAdExtensionsResponse
property:
  path: adExtensionIdentities
  name: ad extension identities
  description: The identities of the extensions that were added. The list corresponds directly to the list of extensions specified in the request.
  node: CampaignManagementAdExtensionIdentityShape
  class: CampaignManagementAdExtensionIdentity
  node kind: BlankNodeOrIRI
property:
  path: nestedPartialErrors
  name: nested partial errors
  description: An array of BatchErrorCollection objects that contain details for any ad extensions that were not successfully added. The top level error within each BatchErrorCollection object corresponds to potential ad extension errors. The nested list of BatchError objects would include any errors specific to the list items within an ad extension (if applicable). The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorCollectionShape
    class: CampaignManagementBatchErrorCollection
  or:
    node: CampaignManagementBatchErrorCollectionBaseShape
    class: CampaignManagementBatchErrorCollectionBase
  or:
    node: CampaignManagementEditorialErrorCollectionShape
    class: CampaignManagementEditorialErrorCollection
  node kind: BlankNodeOrIRI

CampaignManagementAdExtensionIdentityShape
type: NodeShape
target class: CampaignManagementAdExtensionIdentity
property:
  path: id
  name: id
  description: The system-generated identifier of the ad extension.
  datatype: long
  max count: 1
property:
  path: version
  name: version
  description: The number of times the contents of the ad extension has been updated. The version is set to 1 when you add the extension and is incremented each time it's revised.
  datatype: int
  max count: 1

CampaignManagementBatchErrorCollectionShape
type: NodeShape
target class: CampaignManagementBatchErrorCollection
property:
  path: index
  name: index
  description: The zero-based top level list index in the request message that failed.
  datatype: int
  max count: 1
property:
  path: disapprovedText
  name: disapproved text
  datatype: string
  max count: 1
property:
  path: reasonCode
  name: reason code
  datatype: int
  max count: 1
property:
  path: location
  name: location
  datatype: string
  max count: 1
property:
  path: publisherCountry
  name: publisher country
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: fieldPath
  name: field path
  description: The name of the data object's element where the error occurred. This value is subject to change, so you should not take a dependency on the current string format. This element is not supported for all errors.
  datatype: string
  max count: 1
property:
  path: batchErrors
  name: batch errors
  description: A list of batch errors corresponding to the nested list index.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI
property:
  path: message
  name: message
  description: A message that describes the error for the top level list index.
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error for the top level list index.
  datatype: string
  max count: 1
property:
  path: code
  name: code
  description: A numeric error code that identifies the error for the top level list index.
  datatype: int
  max count: 1
property:
  path: details
  name: details
  description: A message that provides additional details about the batch error for the top level list index. This string can be empty.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Reserved for internal use.
  datatype: string
  max count: 1
property:
  path: appealable
  name: appealable
  datatype: boolean
  max count: 1

CampaignManagementBatchErrorShape
type: NodeShape
target class: CampaignManagementBatchError
property:
  path: index
  name: index
  description: The zero-based index of the item in the batch of items in the request message that failed.
  datatype: int
  max count: 1
property:
  path: disapprovedText
  name: disapproved text
  datatype: string
  max count: 1
property:
  path: reasonCode
  name: reason code
  datatype: int
  max count: 1
property:
  path: location
  name: location
  datatype: string
  max count: 1
property:
  path: publisherCountry
  name: publisher country
  datatype: string
  max count: 1
property:
  path: fieldPath
  name: field path
  description: The name of the data object's element where the error occurred. For example if the TrackingUrlTemplate of a Campaign contains invalid text, the value of this FieldPath element is TrackingUrlTemplate. This value is subject to change, so you should not take a dependency on the current string format. This element is not supported for all errors. The field path is supported for errors related to FinalMobileUrls, FinalUrls, TrackingUrlTemplate, and UrlCustomParameters elements of the respective Campaign, AdGroup, TextAd, ProductAd, BiddableAdGroupCriterion, and Keyword objects. It is also supported for errors related to all fields of the CalloutAdExtension and ReviewAdExtension objects.
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error. For example, UserIsNotAuthorized.
  datatype: string
  max count: 1
property:
  path: message
  name: message
  description: A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.
  datatype: string
  max count: 1
property:
  path: code
  name: code
  description: A numeric error code that identifies the error.
  datatype: int
  max count: 1
property:
  path: details
  name: details
  description: A message that provides additional details about the batch error. This string can be empty.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Reserved for internal use.
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: appealable
  name: appealable
  datatype: boolean
  max count: 1

CampaignManagementAddAdGroupCriterionsRequestShape
type: NodeShape
target class: CampaignManagementAddAdGroupCriterionsRequest
property:
  path: criterionType
  name: criterion type
  description: The type of criterion to add, for example Webpage. You can specify only one criterion type value per call. To add, delete, or update target criterions i.e., age, company name, day and time, device, gender, industry, job function, location, location intent, placement, radius, and topic criterions, you must specify the CriterionType value as Targets. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these target criterions via GetAdGroupCriterionsByIds you must request the specific type individually i.e., Age, CompanyName, DayTime, Device, Gender, Industry, JobFunction, Location, LocationIntent, Placement, Radius, and Topic. To add, delete, or update audience criterions i.e., custom audiences, in-market audiences, and remarketing lists, you must specify the CriterionType value as Audience. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these audience criterions via GetAdGroupCriterionsByIds you must request the specific type individually i.e., CustomAudience, InMarketAudience, ProductAudience, and RemarketingList. You cannot add a ProductPartition with this operation. Instead, you should use ApplyProductPartitionActions.
  datatype: string
  max count: 1
property:
  path: adGroupCriterions
  name: ad group criterions
  description: A list of ad group criterions. You can include up to 1,000 ad group criterions per request.
  or:
    node: CampaignManagementAdGroupCriterionShape
    class: CampaignManagementAdGroupCriterion
  or:
    node: CampaignManagementAdGroupCriterionBaseShape
    class: CampaignManagementAdGroupCriterionBase
  or:
    node: CampaignManagementBiddableAdGroupCriterionShape
    class: CampaignManagementBiddableAdGroupCriterion
  or:
    node: CampaignManagementNegativeAdGroupCriterionShape
    class: CampaignManagementNegativeAdGroupCriterion
  node kind: BlankNodeOrIRI

CampaignManagementAdGroupCriterionShape
type: NodeShape
target class: CampaignManagementAdGroupCriterion
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group to apply the criterion to.
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: A status value that determines whether to apply the criterion to the ad group.
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: criterion
  name: criterion
  description: The criterion to apply to the ad group. The criterion helps determine whether ads in the ad group are served. For a list of available criterion types, see AdGroupCriterionType.
  or:
    node: CampaignManagementAgeCriterionShape
    class: CampaignManagementAgeCriterion
  or:
    node: CampaignManagementAudienceCriterionShape
    class: CampaignManagementAudienceCriterion
  or:
    node: CampaignManagementChannelPlacementCriterionShape
    class: CampaignManagementChannelPlacementCriterion
  or:
    node: CampaignManagementCriterionShape
    class: CampaignManagementCriterion
  or:
    node: CampaignManagementCriterionBaseShape
    class: CampaignManagementCriterionBase
  or:
    node: CampaignManagementCustomLinkedInCriterionShape
    class: CampaignManagementCustomLinkedInCriterion
  or:
    node: CampaignManagementDayTimeCriterionShape
    class: CampaignManagementDayTimeCriterion
  or:
    node: CampaignManagementDealCriterionShape
    class: CampaignManagementDealCriterion
  or:
    node: CampaignManagementDeviceCriterionShape
    class: CampaignManagementDeviceCriterion
  or:
    node: CampaignManagementGenderCriterionShape
    class: CampaignManagementGenderCriterion
  or:
    node: CampaignManagementGenreCriterionShape
    class: CampaignManagementGenreCriterion
  or:
    node: CampaignManagementHotelAdvanceBookingWindowCriterionShape
    class: CampaignManagementHotelAdvanceBookingWindowCriterion
  or:
    node: CampaignManagementHotelCheckInDateCriterionShape
    class: CampaignManagementHotelCheckInDateCriterion
  or:
    node: CampaignManagementHotelCheckInDayCriterionShape
    class: CampaignManagementHotelCheckInDayCriterion
  or:
    node: CampaignManagementHotelDateSelectionTypeCriterionShape
    class: CampaignManagementHotelDateSelectionTypeCriterion
  or:
    node: CampaignManagementHotelGroupShape
    class: CampaignManagementHotelGroup
  or:
    node: CampaignManagementHotelLengthOfStayCriterionShape
    class: CampaignManagementHotelLengthOfStayCriterion
  or:
    node: CampaignManagementLocationCriterionShape
    class: CampaignManagementLocationCriterion
  or:
    node: CampaignManagementLocationIntentCriterionShape
    class: CampaignManagementLocationIntentCriterion
  or:
    node: CampaignManagementPlacementCriterionShape
    class: CampaignManagementPlacementCriterion
  or:
    node: CampaignManagementProductPartitionShape
    class: CampaignManagementProductPartition
  or:
    node: CampaignManagementProductScopeShape
    class: CampaignManagementProductScope
  or:
    node: CampaignManagementProfileCriterionShape
    class: CampaignManagementProfileCriterion
  or:
    node: CampaignManagementRadiusCriterionShape
    class: CampaignManagementRadiusCriterion
  or:
    node: CampaignManagementStoreCriterionShape
    class: CampaignManagementStoreCriterion
  or:
    node: CampaignManagementTopicCriterionShape
    class: CampaignManagementTopicCriterion
  or:
    node: CampaignManagementWebpageShape
    class: CampaignManagementWebpage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the ad group criterion.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of ad group criterion. For more information, see Remarks.
  datatype: string
  max count: 1
property:
  path: criterionBid
  name: criterion bid
  or:
    node: CampaignManagementBidMultiplierShape
    class: CampaignManagementBidMultiplier
  or:
    node: CampaignManagementCriterionBidShape
    class: CampaignManagementCriterionBid
  or:
    node: CampaignManagementCriterionBidBaseShape
    class: CampaignManagementCriterionBidBase
  or:
    node: CampaignManagementFixedBidShape
    class: CampaignManagementFixedBid
  or:
    node: CampaignManagementRateBidShape
    class: CampaignManagementRateBid
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: destinationUrl
  name: destination url
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: editorialStatus
  name: editorial status
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: criterionCashback
  name: criterion cashback
  or:
    node: CampaignManagementCashbackAdjustmentShape
    class: CampaignManagementCashbackAdjustment
  or:
    node: CampaignManagementCriterionCashbackShape
    class: CampaignManagementCriterionCashback
  or:
    node: CampaignManagementCriterionCashbackBaseShape
    class: CampaignManagementCriterionCashbackBase
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementCriterionShape
type: NodeShape
target class: CampaignManagementCriterion
property:
  path: type
  name: type
  description: The type of criterion. For more information, see Remarks.
  datatype: string
  max count: 1
property:
  path: parentCriterionId
  name: parent criterion id
  datatype: long
  max count: 1
property:
  path: condition
  name: condition
  node: CampaignManagementProductConditionShape
  class: CampaignManagementProductCondition
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: partitionType
  name: partition type
  datatype: string
  max count: 1
  in: Subdivision
  in: Unit
property:
  path: listing
  name: listing
  node: CampaignManagementHotelListingShape
  class: CampaignManagementHotelListing
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: listingType
  name: listing type
  datatype: string
  max count: 1
  in: Subdivision
  in: Unit
property:
  path: minDays
  name: min days
  datatype: int
  max count: 1
property:
  path: maxDays
  name: max days
  datatype: int
  max count: 1
property:
  path: startDate
  name: start date
  datatype: dateTime
  max count: 1
property:
  path: endDate
  name: end date
  datatype: dateTime
  max count: 1
property:
  path: checkInDay
  name: check in day
  datatype: string
  max count: 1
  in: Sunday
  in: Monday
  in: Tuesday
  in: Wednesday
  in: Thursday
  in: Friday
  in: Saturday
property:
  path: hotelDateSelectionType
  name: hotel date selection type
  datatype: string
  max count: 1
  in: Unknown
  in: DefaultSelection
  in: UserSelection
property:
  path: minNights
  name: min nights
  datatype: int
  max count: 1
property:
  path: maxNights
  name: max nights
  datatype: int
  max count: 1
property:
  path: conditions
  name: conditions
  node: CampaignManagementProductConditionShape
  class: CampaignManagementProductCondition
  node kind: BlankNodeOrIRI
property:
  path: parameter
  name: parameter
  node: CampaignManagementWebpageParameterShape
  class: CampaignManagementWebpageParameter
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: ageRange
  name: age range
  datatype: string
  max count: 1
  in: Unknown
  in: EighteenToTwentyFour
  in: TwentyFiveToThirtyFour
  in: ThirtyFiveToFourtyNine
  in: FiftyToSixtyFour
  in: SixtyFiveAndAbove
  in: ThirtyFiveToFiftyFour
  in: FiftyFiveAndAbove
property:
  path: deviceName
  name: device name
  datatype: string
  max count: 1
property:
  path: oSName
  name: o sname
  datatype: string
  max count: 1
property:
  path: day
  name: day
  datatype: string
  max count: 1
  in: Sunday
  in: Monday
  in: Tuesday
  in: Wednesday
  in: Thursday
  in: Friday
  in: Saturday
property:
  path: fromHour
  name: from hour
  datatype: int
  max count: 1
property:
  path: fromMinute
  name: from minute
  datatype: string
  max count: 1
  in: Zero
  in: Fifteen
  in: Thirty
  in: FortyFive
property:
  path: toHour
  name: to hour
  datatype: int
  max count: 1
property:
  path: toMinute
  name: to minute
  datatype: string
  max count: 1
  in: Zero
  in: Fifteen
  in: Thirty
  in: FortyFive
property:
  path: genderType
  name: gender type
  datatype: string
  max count: 1
  in: Unknown
  in: Male
  in: Female
property:
  path: name
  name: name
  datatype: string
  max count: 1
property:
  path: radius
  name: radius
  datatype: long
  max count: 1
property:
  path: radiusUnit
  name: radius unit
  datatype: string
  max count: 1
  in: Miles
  in: Kilometers
property:
  path: latitudeDegrees
  name: latitude degrees
  datatype: double
  max count: 1
property:
  path: longitudeDegrees
  name: longitude degrees
  datatype: double
  max count: 1

CampaignManagementProductConditionShape
type: NodeShape
target class: CampaignManagementProductCondition
property:
  path: operand
  name: operand
  description: The condition's operand. The operands implicitly include the equal operator. For example, read Brand as Brand=. Add or Apply: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: attribute
  name: attribute
  description: The condition's attribute value. An attribute's value must exactly match the value specified in the customer's Microsoft Merchant Center catalog file. The available Attribute and Operand values vary depending on the campaign type. For supported attribute and operand values, see Remarks below. Add or Apply: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: operator
  name: operator
  description: The rule item operator. Add: Required Update: Required
  datatype: string
  max count: 1

CampaignManagementHotelListingShape
type: NodeShape
target class: CampaignManagementHotelListing
property:
  path: operand
  name: operand
  description: The operand for the hotel listing.
  datatype: string
  max count: 1
property:
  path: attribute
  name: attribute
  description: The attribute for the hotel listing.
  datatype: string
  max count: 1

CampaignManagementWebpageParameterShape
type: NodeShape
target class: CampaignManagementWebpageParameter
property:
  path: criterionName
  name: criterion name
  description: The criterion name that you can use to identify the criteria, for example you can filter or sort alphabetically. The criterion name length must be between 1 to 2048, inclusive. Add: Optional. If you do not specify any name, by default the name will be set to a concatenated list of conditions. Each condition will be delimited by the and keyword. For example if the conditions are a) Url contains flower, b) Url contains book, and c) PageContent contains seattle, then the default criterion name will be Url contains flower and Url contains book and PageContent contains seattle. If you do not specify any name, and if no conditions are specified, then you are effectively targeting all webpages and the name will be set to All Webpages. Update: Optional. If you leave this element null or empty the criterion name will not be updated. If you specify an empty string i.e. "", then the criterion name will be updated to the default value i.e. either All Webpages or a concatenated list of criterions.
  datatype: string
  max count: 1
property:
  path: conditions
  name: conditions
  description: The webpage conditions or criteria. You may include up to 3 individual WebpageCondition objects in the list. Each WebpageCondition contains an Argument, Operand and Operator element. If you use Operand as URL and Operator as Equals you can only specify one condition. Add: Optional for biddable criterion; Required for negative criterion. If no conditions are specified, then you are effectively targeting all webpages. Update: Not allowed. You cannot update the webpage conditions. To update the conditions you must delete the criterion and add a new criterion.
  node: CampaignManagementWebpageConditionShape
  class: CampaignManagementWebpageCondition
  node kind: BlankNodeOrIRI

CampaignManagementWebpageConditionShape
type: NodeShape
target class: CampaignManagementWebpageCondition
property:
  path: operand
  name: operand
  description: The webpage condition operand. Add: Required Update: Not applicable. You cannot update the webpage conditions. To update the conditions you must delete the criterion and add a new criterion.
  datatype: string
  max count: 1
  in: Unknown
  in: Url
  in: Category
  in: PageTitle
  in: PageContent
  in: CustomLabel
property:
  path: operator
  name: operator
  description: The webpage condition operator. Add: Optional. Default operator is used when it is not defined. Operator is required only when you use Operand=URL and Operator = Equals Update: Not applicable. You cannot update the webpage conditions. To update the conditions you must delete the criterion and add a new criterion. Default values URL/PageTitle/PageContent - Contains, Category/CustomLabel - Equals. Supported values URL - Contains/Equals, PageTitle/PageContent - Contains, CustomLabel/Category - Equals
  datatype: string
  max count: 1
  in: Unknown
  in: Equals
  in: Contains
property:
  path: argument
  name: argument
  description: The webpage condition or criterion. The condition is met if the webpage property that is referenced by the operand contains or equals the argument's value. For example you can set this string to the URL, category, page title, or page content for your site. Note: For Performance Max campaigns, you can only set argument to the URL. Add: Required Update: Not applicable. You cannot update the webpage conditions. To update the conditions you must delete the criterion and add a new criterion.
  datatype: string
  max count: 1

CampaignManagementCriterionBidShape
type: NodeShape
target class: CampaignManagementCriterionBid
property:
  path: type
  name: type
  description: The type of criterion bid. For more information, see Remarks.
  datatype: string
  max count: 1
property:
  path: amount
  name: amount
  datatype: double
  max count: 1
property:
  path: multiplier
  name: multiplier
  datatype: double
  max count: 1
property:
  path: rateAmount
  name: rate amount
  node: CampaignManagementRateAmountShape
  class: CampaignManagementRateAmount
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementRateAmountShape
type: NodeShape
target class: CampaignManagementRateAmount
property:
  path: amount
  name: amount
  description: The rate amount in percentage form.
  datatype: double
  max count: 1

CampaignManagementCriterionCashbackShape
type: NodeShape
target class: CampaignManagementCriterionCashback
property:
  path: type
  name: type
  description: The type of criterion cashback.
  datatype: string
  max count: 1
property:
  path: cashbackPercent
  name: cashback percent
  datatype: double
  max count: 1

CampaignManagementAddAdGroupCriterionsResponseShape
type: NodeShape
target class: CampaignManagementAddAdGroupCriterionsResponse
property:
  path: adGroupCriterionIds
  name: ad group criterion ids
  description: A list of unique system identifiers corresponding to the criterion that were added. The list of identifiers corresponds directly to the list of criterion in the request. Items of the list may be returned as null. For each list index where a criterion was not added, the corresponding element will be null.
  datatype: long
property:
  path: nestedPartialErrors
  name: nested partial errors
  description: An array of BatchErrorCollection objects that contain details for any criterion that were not successfully added. The top level error within each BatchErrorCollection object corresponds to potential criterion errors. The nested list of BatchError objects would include any errors specific to the list of items a criterion can have. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorCollectionShape
    class: CampaignManagementBatchErrorCollection
  or:
    node: CampaignManagementBatchErrorCollectionBaseShape
    class: CampaignManagementBatchErrorCollectionBase
  or:
    node: CampaignManagementEditorialErrorCollectionShape
    class: CampaignManagementEditorialErrorCollection
  node kind: BlankNodeOrIRI

CampaignManagementAddAdGroupsRequestShape
type: NodeShape
target class: CampaignManagementAddAdGroupsRequest
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign to add the ad groups to.
  datatype: long
  max count: 1
property:
  path: adGroups
  name: ad groups
  description: An array of AdGroup objects to add to the specified campaign. You can add a maximum of 1,000 ad groups in a single call. Each campaign can have up to 20,000 ad groups.
  node: CampaignManagementAdGroupShape
  class: CampaignManagementAdGroup
  node kind: BlankNodeOrIRI
property:
  path: returnInheritedBidStrategyTypes
  name: return inherited bid strategy types
  description: Reserved for future use.
  datatype: boolean
  max count: 1

CampaignManagementAdGroupShape
type: NodeShape
target class: CampaignManagementAdGroup
property:
  path: id
  name: id
  description: The system-generated identifier of the ad group. Add: Not allowed. Update: Read-only and Required
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the ad group. The name must be unique among all active ad groups within the campaign. The name can contain a maximum of 256 characters. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: startDate
  name: start date
  description: The date that the ads in the ad group can begin serving; otherwise, the service can begin serving the ads in the ad group the day that the ad group becomes active. The start date is inclusive. For example, if you set the start date to 5/5/2021, the ads in the ad group will start at 12:00 AM on 5/5/2021. The time is based on the time zone that you specify at the campaign level. If the associated campaign is campaign managed, the startDate of the adGroup will be set to the Campaign startDate. Add: Optional. If you do not set the start date, then it will default to today's date and the service can begin serving the ads in the ad group as soon as the ad group status is active. Update: Optional. If no value is set for the update, this setting is not changed. The start date cannot be updated after the ad group is submitted i.e., once the start date has arrived.
  node: CampaignManagementDateShape
  class: CampaignManagementDate
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: The date that the ads in the ad group will expire. If you do not specify an end date, the ads will not expire. The end date can be extended to make an ad group's ads eligible for delivery, even after the ad group expires. The end date is inclusive. For example, if you set EndDate to 12/31/2020, the ads in the ad group will expire at 11:59 PM on 12/31/2020. The time is based on the time zone that you specify at the campaign level. Note: If the associated campaign is campaign managed, the endDate of the adGroup will be set to null. Add: Optional. To set no end date when adding an ad group, set this element to null. Update: Optional. If no value is set for the update, this setting is not changed. To delete the existing end date setting, and effectively set no end date when updating an ad group, set the end date equal to or later than January 2, 2050. When you retrieve the ad group next time, this element will be nil i.e. it will not be set to January 2, 2050.
  node: CampaignManagementDateShape
  class: CampaignManagementDate
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: language
  name: language
  description: Your ad language setting determines the language you will use when you write your ads and should be the language of your customers. IMPORTANT: If languages are set at both the ad group and campaign level, the ad group level language will override the campaign level language. The supported language strings for Search and Shopping campaigns are: Bulgarian, Croatian, Czech, Danish, Dutch, English, Estonian, Finnish, French, German, Greek, Hungarian, Italian, Latvian, Lithuanian, Maltese, Norwegian, Polish, Portuguese, Romanian, Slovak, Slovenian, Spanish, Swedish, and TraditionalChinese. NOTE: The following languages are not yet available for everyone: Bulgarian, Croatian, Czech, Estonian, Greek, Hungarian, Latvian, Lithuanian, Maltese, Polish, Romanian, Slovak, Slovenian. For Dynamic Search Ads campaigns, the campaign and ad group level language settings are ignored in favor of the website domain language. You should set campaign languages to "All" and leave the ad group level language empty. For ad groups in Audience campaigns, ad group level language is not supported, and you must set the Languages element of the ad group's campaign to "All". Add: Optional if the campaign has one or more languages set, and otherwise the language is required for most campaign types. You are not allowed to set this element for ad groups in Audience campaigns. Update: Optional. If no value is set for the update, this setting is not changed. To remove the language and defer to the campaign level languages, set this element to an empty string value ("").
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of the ad group. Possible values are Active, Expired, and Paused. The Expired status is read-only. Add: Optional. The default value is Paused. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Expired
  in: Deleted
property:
  path: privacyStatus
  name: privacy status
  description: Indicates whether or not your ad group target criteria e.g., ProfileCriterion are too narrow for ad groups in Audience campaigns. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Unknown
  in: Active
  in: TargetingTooNarrow
  in: Pending
property:
  path: cpcBid
  name: cpc bid
  description: The default bid to use when the user's query and the ad group's keywords match by using either a broad, exact, or phrase match comparison. The minimum and maximum bid range depends on the account's currency. For more information, see Currencies. Specifying a broad, exact, or phrase match bid at the keyword level overrides the ad group's Cpc bid value for the corresponding match type. Add: Optional. If you do not set a bid, it will be set to the minimum depending on your account's currency. Update: Optional. If no value is set for the update, this setting is not changed.
  node: CampaignManagementBidShape
  class: CampaignManagementBid
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: network
  name: network
  description: The search networks where you want your ads to display. Supported network values for ad groups within most campaign types are OwnedAndOperatedAndSyndicatedSearch and OwnedAndOperatedOnly. For ad groups in Audience campaigns, ad group level network is not supported. The ad groups are in the Microsoft Audience Network. For ad groups in smart shopping campaigns, you cannot set the network. The service will set the network to OwnedAndOperatedAndSyndicatedSearch. For ad groups in shopping campaigns for brands, the InHousePromotion network (Retailer Network only) is supported in addition to OwnedAndOperatedAndSyndicatedSearch and OwnedAndOperatedOnly. If you select one of the syndicated search options, you can call the SetNegativeSitesToAdGroups or SetNegativeSitesToCampaigns operation to prevent the ads from displaying on specific syndicated search websites. For more information about networks and ad distribution, see the About Ad Distribution help article. Add: Optional. The default is OwnedAndOperatedAndSyndicatedSearch. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: OwnedAndOperatedAndSyndicatedSearch
  in: OwnedAndOperatedOnly
  in: SyndicatedSearchOnly
  in: InHousePromotion
property:
  path: adRotation
  name: ad rotation
  description: Ad rotation sets how often Microsoft Advertising selects which ads to serve, if you have multiple ads within an ad group. Since no more than one ad from your account can show at a time, ad rotation prioritizes ads that appear statistically more likely to perform better. Note: Ad rotation does not apply to Product Ads. Possible values for the ad rotation Type are OptimizeForClicks and RotateAdsEvenly. If set to OptimizeForClicks, Microsoft Advertising prioritizes the ad from the ad group that appears to have the best chance of performing well, based on auction characteristics or factors, such as keyword, search term, device or location. Better-performing ads will show more frequently, and others will be served less often, if at all. If set to RotateAdsEvenly, Microsoft Advertising provides more balance in rotation between your ads. That is, the ads in a particular ad group have a similar chance of being displayed in response to a searcher's query. Ads are prioritized lower if they have lower ad quality, and therefore might display less often, or not at all. - The RotateAdsEvenly setting can allow lower-performing ads to display as often as better-performing ads. This might impact ad group performance. - The RotateAdsEvenly setting will be ignored if you use an automated bid strategy i.e., MaxClicks, MaxConversions, TargetCpa, or TargetRoas, as these bid strategies prioritize better-performing ads. Add: Optional. The default value is OptimizeForClicks. Update: Optional. If no value is set for the update, this setting is not changed.
  node: CampaignManagementAdRotationShape
  class: CampaignManagementAdRotation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: audienceAdsBidAdjustment
  name: audience ads bid adjustment
  description: The percent amount by which to adjust your bid for audience ads above or below the base ad group or keyword bid. This property is available in Search campaigns if the customer is enabled for the Microsoft Audience Network. This property is not available with smart shopping campaigns. Supported values are negative one hundred (-100) through positive nine hundred (900). Setting the bid adjustment to -100 percent will prevent audience ads from showing for this ad group. Set this element to zero (0) if you do not want any bid adjustment for audience ads. If this element is null you will inherit the AudienceAdsBidAdjustment setting of the ad group's Campaign. Add: Optional Update: Optional. This property will only be updated if you also set the UpdateAudienceAdsBidAdjustment element to true, and otherwise this property will be ignored. If the ad group already has a native bid adjustment, and you want to remove it to effectively inherit the AudienceAdsBidAdjustment setting of the ad group's Campaign, set this element to null.
  datatype: int
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all URLs in your ad group. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: biddingScheme
  name: bidding scheme
  description: The bid strategy type for how you want to manage your bids. NOTE: As of April 2021, you cannot set any bid strategies for ad groups or keywords. If you attempt to set bid strategies for ad groups or keywords, the request will be ignored without error. Ad groups and keywords will inherit their campaign's bid strategy. Add: Optional. If you do not set this element, then InheritFromParentBiddingScheme is used by default. Update: Optional. If no value is set for the update, this setting is not changed.
  or:
    node: CampaignManagementBiddingSchemeShape
    class: CampaignManagementBiddingScheme
  or:
    node: CampaignManagementBiddingSchemeBaseShape
    class: CampaignManagementBiddingSchemeBase
  or:
    node: CampaignManagementCommissionBiddingSchemeShape
    class: CampaignManagementCommissionBiddingScheme
  or:
    node: CampaignManagementCostPerSaleBiddingSchemeShape
    class: CampaignManagementCostPerSaleBiddingScheme
  or:
    node: CampaignManagementEnhancedCpcBiddingSchemeShape
    class: CampaignManagementEnhancedCpcBiddingScheme
  or:
    node: CampaignManagementInheritFromParentBiddingSchemeShape
    class: CampaignManagementInheritFromParentBiddingScheme
  or:
    node: CampaignManagementManualCpaBiddingSchemeShape
    class: CampaignManagementManualCpaBiddingScheme
  or:
    node: CampaignManagementManualCpcBiddingSchemeShape
    class: CampaignManagementManualCpcBiddingScheme
  or:
    node: CampaignManagementManualCpmBiddingSchemeShape
    class: CampaignManagementManualCpmBiddingScheme
  or:
    node: CampaignManagementManualCpvBiddingSchemeShape
    class: CampaignManagementManualCpvBiddingScheme
  or:
    node: CampaignManagementMaxClicksBiddingSchemeShape
    class: CampaignManagementMaxClicksBiddingScheme
  or:
    node: CampaignManagementMaxConversionValueBiddingSchemeShape
    class: CampaignManagementMaxConversionValueBiddingScheme
  or:
    node: CampaignManagementMaxConversionsBiddingSchemeShape
    class: CampaignManagementMaxConversionsBiddingScheme
  or:
    node: CampaignManagementMaxRoasBiddingSchemeShape
    class: CampaignManagementMaxRoasBiddingScheme
  or:
    node: CampaignManagementPercentCpcBiddingSchemeShape
    class: CampaignManagementPercentCpcBiddingScheme
  or:
    node: CampaignManagementTargetCpaBiddingSchemeShape
    class: CampaignManagementTargetCpaBiddingScheme
  or:
    node: CampaignManagementTargetImpressionShareBiddingSchemeShape
    class: CampaignManagementTargetImpressionShareBiddingScheme
  or:
    node: CampaignManagementTargetRoasBiddingSchemeShape
    class: CampaignManagementTargetRoasBiddingScheme
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: settings
  name: settings
  description: The ad group settings that typically vary by campaign type. You can include a maximum of one object per setting type in the list of settings e.g., one TargetSetting. The TargetSetting can be used with any campaign type, and determines whether the Age, Audience, CompanyName, Gender, Industry, and JobFunction criterions associated with this ad group use the "target and bid" option or the "bid only" target option. Within the TargetSetting you can have multiple TargetSettingDetail objects i.e., one per CriterionTypeGroup. Add: Optional. If this element does not include a TargetSetting object, the default bid option for all criterion type groups is effectively "bid only". Update: Optional. If no value is set for the update, this setting is not changed.
  or:
    node: CampaignManagementAISearchSettingShape
    class: CampaignManagementAISearchSetting
  or:
    node: CampaignManagementAppSettingShape
    class: CampaignManagementAppSetting
  or:
    node: CampaignManagementBaseDomainSettingShape
    class: CampaignManagementBaseDomainSetting
  or:
    node: CampaignManagementCallToActionSettingShape
    class: CampaignManagementCallToActionSetting
  or:
    node: CampaignManagementCampaignFrequencyCapSettingShape
    class: CampaignManagementCampaignFrequencyCapSetting
  or:
    node: CampaignManagementCoOpSettingShape
    class: CampaignManagementCoOpSetting
  or:
    node: CampaignManagementDisclaimerSettingShape
    class: CampaignManagementDisclaimerSetting
  or:
    node: CampaignManagementDynamicFeedSettingShape
    class: CampaignManagementDynamicFeedSetting
  or:
    node: CampaignManagementDynamicSearchAdsSettingShape
    class: CampaignManagementDynamicSearchAdsSetting
  or:
    node: CampaignManagementHotelSettingShape
    class: CampaignManagementHotelSetting
  node kind: BlankNodeOrIRI

CampaignManagementBidShape
type: NodeShape
target class: CampaignManagementBid
property:
  path: amount
  name: amount
  description: The bid value. For details about the valid bid range for your market, see Currencies.
  datatype: double
  max count: 1

CampaignManagementAdRotationShape
type: NodeShape
target class: CampaignManagementAdRotation
property:
  path: type
  name: type
  description: The type of ad rotation to apply to the ad group. Ad rotation sets how often Microsoft Advertising selects which ads to serve, if you have multiple ads within an ad group. Since no more than one ad from your account can show at a time, ad rotation prioritizes ads that appear statistically more likely to perform better. Note: Ad rotation does not apply to Product Ads. Possible values are OptimizeForClicks and RotateAdsEvenly. If set to OptimizeForClicks, Microsoft Advertising prioritizes the ad from the ad group that appears to have the best chance of performing well, based on auction characteristics or factors, such as keyword, search term, device or location. Better-performing ads will show more frequently, and others will be served less often, if at all. If set to RotateAdsEvenly, Microsoft Advertising provides more balance in rotation between your ads. That is, the ads in a particular ad group have a similar chance of being displayed in response to a searcher's query. Ads are prioritized lower if they have lower ad quality, and therefore might display less often, or not at all. - The RotateAdsEvenly setting can allow lower-performing ads to display as often as better-performing ads. This might impact ad group performance. - The RotateAdsEvenly setting will be ignored if you use an automated bid strategy i.e., MaxClicks, MaxConversions, TargetCpa, or TargetRoas, as these bid strategies prioritize better-performing ads. Add: Optional. If not specified, the default value is OptimizeForClicks. Update: Optional
  datatype: string
  max count: 1
  in: OptimizeForClicks
  in: RotateAdsEvenly
property:
  path: startDate
  name: start date
  description: Reserved for future use only. Must be null.
  datatype: dateTime
  max count: 1
property:
  path: endDate
  name: end date
  description: Reserved for future use only. Must be null.
  datatype: dateTime
  max count: 1

CampaignManagementBiddingSchemeShape
type: NodeShape
target class: CampaignManagementBiddingScheme
property:
  path: type
  name: type
  description: The type of bidding scheme that is set for this campaign, ad group, or keyword. For more information about bidding scheme types, see the Remarks.
  datatype: string
  max count: 1
property:
  path: maxCpc
  name: max cpc
  node: CampaignManagementBidShape
  class: CampaignManagementBid
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: targetCpa
  name: target cpa
  datatype: double
  max count: 1
property:
  path: manualCpc
  name: manual cpc
  datatype: double
  max count: 1
property:
  path: inheritedBidStrategyType
  name: inherited bid strategy type
  datatype: string
  max count: 1
property:
  path: targetRoas
  name: target roas
  datatype: double
  max count: 1
property:
  path: targetImpressionShare
  name: target impression share
  datatype: double
  max count: 1
property:
  path: targetAdPosition
  name: target ad position
  datatype: string
  max count: 1
property:
  path: maxPercentCpc
  name: max percent cpc
  datatype: double
  max count: 1
property:
  path: commissionRate
  name: commission rate
  datatype: double
  max count: 1
property:
  path: manualCpi
  name: manual cpi
  datatype: double
  max count: 1
property:
  path: targetCostPerSale
  name: target cost per sale
  datatype: double
  max count: 1

CampaignManagementSettingShape
type: NodeShape
target class: CampaignManagementSetting
property:
  path: type
  name: type
  description: The type of setting. For more information, see Remarks.
  datatype: string
  max count: 1
property:
  path: priority
  name: priority
  datatype: int
  max count: 1
property:
  path: salesCountryCode
  name: sales country code
  datatype: string
  max count: 1
property:
  path: storeId
  name: store id
  datatype: long
  max count: 1
property:
  path: localInventoryAdsEnabled
  name: local inventory ads enabled
  datatype: boolean
  max count: 1
property:
  path: shoppableAdsEnabled
  name: shoppable ads enabled
  datatype: boolean
  max count: 1
property:
  path: feedLabel
  name: feed label
  datatype: string
  max count: 1
property:
  path: feedId
  name: feed id
  datatype: long
  max count: 1
property:
  path: domainName
  name: domain name
  datatype: string
  max count: 1
property:
  path: language
  name: language
  datatype: string
  max count: 1
property:
  path: source
  name: source
  datatype: string
  max count: 1
  in: All
  in: SystemIndex
  in: AdvertiserSuppliedUrls
property:
  path: pageFeedIds
  name: page feed ids
  datatype: long
property:
  path: dynamicDescriptionEnabled
  name: dynamic description enabled
  datatype: boolean
  max count: 1
property:
  path: details
  name: details
  node: ListLevel1Shape
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: bidOption
  name: bid option
  datatype: string
  max count: 1
  in: BidValue
  in: BidBoost
property:
  path: bidBoostValue
  name: bid boost value
  datatype: double
  max count: 1
property:
  path: bidMaxValue
  name: bid max value
  datatype: double
  max count: 1
property:
  path: disclaimerAdsEnabled
  name: disclaimer ads enabled
  datatype: boolean
  max count: 1
property:
  path: hotelAdGroupType
  name: hotel ad group type
  datatype: string
  max count: 1
property:
  path: autoGeneratedAssetsEnabled
  name: auto generated assets enabled
  datatype: boolean
  max count: 1
property:
  path: finalUrlExpansionOptOut
  name: final url expansion opt out
  datatype: boolean
  max count: 1
property:
  path: autoGeneratedTextOptOut
  name: auto generated text opt out
  datatype: boolean
  max count: 1
property:
  path: autoGeneratedImageOptOut
  name: auto generated image opt out
  datatype: boolean
  max count: 1
property:
  path: costPerSaleOptOut
  name: cost per sale opt out
  datatype: boolean
  max count: 1
property:
  path: automatedCallToActionOptOut
  name: automated call to action opt out
  datatype: boolean
  max count: 1
property:
  path: callToActionOptOut
  name: call to action opt out
  datatype: boolean
  max count: 1
property:
  path: displayUrlMode
  name: display url mode
  datatype: string
  max count: 1
  in: ManufacturerWebsiteUrl
  in: WebsiteDescription
property:
  path: websiteDescription
  name: website description
  datatype: string
  max count: 1
  in: Unspecified
  in: PrescriptionTreatmentWebsite_En
  in: PrescriptionTreatmentWebsite_Es
  in: PrescriptionDeviceWebsite_En
  in: PrescriptionDeviceWebsite_Es
  in: MedicalDeviceWebsite_En
  in: MedicalDeviceWebsite_Es
  in: PreventativeTreatmentWebsite_En
  in: PreventativeTreatmentWebsite_Es
  in: PrescriptionContraceptionWebsite_En
  in: PrescriptionContraceptionWebsite_Es
  in: PrescriptionVaccineWebsite_En
  in: PrescriptionVaccineWebsite_Es
property:
  path: appStore
  name: app store
  datatype: string
  max count: 1
property:
  path: appId
  name: app id
  datatype: string
  max count: 1
property:
  path: newCustomerAcquisitionGoalId
  name: new customer acquisition goal id
  datatype: long
  max count: 1
property:
  path: newCustomerAcquisitionBidOnlyMode
  name: new customer acquisition bid only mode
  datatype: boolean
  max count: 1
property:
  path: additionalConversionValue
  name: additional conversion value
  datatype: double
  max count: 1
property:
  path: baseDomain
  name: base domain
  datatype: string
  max count: 1
property:
  path: searchTermMatchingOptOut
  name: search term matching opt out
  datatype: boolean
  max count: 1
property:
  path: aISearchEnabled
  name: a isearch enabled
  datatype: boolean
  max count: 1

CampaignManagementRateBidShape
type: NodeShape
target class: CampaignManagementRateBid
property:
  path: type
  name: type
  description: The type of criterion bid. For more information, see Remarks.
  datatype: string
  max count: 1
property:
  path: rateAmount
  name: rate amount
  description: Defines an object that represents the rate amount.
  node: CampaignManagementRateAmountShape
  class: CampaignManagementRateAmount
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementFrequencyCapSettingsShape
type: NodeShape
target class: CampaignManagementFrequencyCapSettings
property:
  path: timeGranularity
  name: time granularity
  description: The smallest time interval to limit ad serves. Values are Hour, Day, Week.
  datatype: string
  max count: 1
  in: HOUR
  in: DAY
  in: WEEK
property:
  path: capValue
  name: cap value
  description: A limit to the number of times an ad is shown.
  datatype: int
  max count: 1

CampaignManagementAddAdGroupsResponseShape
type: NodeShape
target class: CampaignManagementAddAdGroupsResponse
property:
  path: adGroupIds
  name: ad group ids
  description: A list of unique system identifiers corresponding to the ad groups that were added. The list of identifiers corresponds directly to the list of ad groups in the request. Items of the list may be returned as null. For each list index where an ad group was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI
property:
  path: inheritedBidStrategyTypes
  name: inherited bid strategy types
  description: Reserved for future use.
  datatype: string

CampaignManagementAddAdsRequestShape
type: NodeShape
target class: CampaignManagementAddAdsRequest
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group to add the ads to.
  datatype: long
  max count: 1
property:
  path: ads
  name: ads
  description: An array of up to 50 ads that you want added to the ad group.
  or:
    node: CampaignManagementAdShape
    class: CampaignManagementAd
  or:
    node: CampaignManagementAdBaseShape
    class: CampaignManagementAdBase
  or:
    node: CampaignManagementAppInstallAdShape
    class: CampaignManagementAppInstallAd
  or:
    node: CampaignManagementDynamicSearchAdShape
    class: CampaignManagementDynamicSearchAd
  or:
    node: CampaignManagementExpandedTextAdShape
    class: CampaignManagementExpandedTextAd
  or:
    node: CampaignManagementHotelAdShape
    class: CampaignManagementHotelAd
  or:
    node: CampaignManagementProductAdShape
    class: CampaignManagementProductAd
  or:
    node: CampaignManagementResponsiveAdShape
    class: CampaignManagementResponsiveAd
  or:
    node: CampaignManagementResponsiveSearchAdShape
    class: CampaignManagementResponsiveSearchAd
  or:
    node: CampaignManagementTextAdShape
    class: CampaignManagementTextAd
  node kind: BlankNodeOrIRI

CampaignManagementAddAdsResponseShape
type: NodeShape
target class: CampaignManagementAddAdsResponse
property:
  path: adIds
  name: ad ids
  description: A list of unique system identifiers corresponding to the ads that were added. The list of identifiers corresponds directly to the list of ads in the request. Items of the list may be returned as null. For each list index where an ad was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddAssetGroupsRequestShape
type: NodeShape
target class: CampaignManagementAddAssetGroupsRequest
property:
  path: campaignId
  name: campaign id
  description: The ID of the Performace Max campaign.
  datatype: long
  max count: 1
property:
  path: assetGroups
  name: asset groups
  description: Array of asset groups to add to the specified campaign. A maximum of 100 asset groups can be specified in a single call.
  node: CampaignManagementAssetGroupShape
  class: CampaignManagementAssetGroup
  node kind: BlankNodeOrIRI

CampaignManagementAssetGroupShape
type: NodeShape
target class: CampaignManagementAssetGroup
property:
  path: name
  name: name
  description: The name of the asset group. Names should be unique in a campaign and are case sensitive. The length cannot exceed 256 characters. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of the Asset group. Possible values are Active, Expired and Paused. The Expired status is read-only. Add: Optional. Default is Paused. Update: Optional
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
  in: Expired
property:
  path: startDate
  name: start date
  description: The date that the asset group can begin serving; otherwise, the service can begin serving ads the day that the asset group becomes active. The start date is inclusive. For example, if you set the start date to 5/5/2021, the ads created from the asset group will start at 12:00 AM on 5/5/2021. The time is based on the time zone that you specify at the campaign level. Add: Optional. If you do not set the start date, then it will default to today's date and the service can begin serving ads as soon as the asset group status is active. Update: Optional. If no value is set for the update, this setting is not changed. The start date cannot be updated after the asset group is submitted i.e., once the start date has arrived.
  node: CampaignManagementDateShape
  class: CampaignManagementDate
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: The date that the asset group will expire. If you do not specify an end date, the asset group will not expire. The end date can be extended to make an asset group eligible for delivery, even after the asset group expires. The end date is inclusive. For example, if you set EndDate to 12/31/2020, the ads in the asset group will expire at 11:59 PM on 12/31/2020. The time is based on the time zone that you specify at the campaign level. Add: Optional. To set no end date when adding an asset group, set this element to null. Update: Optional. If no value is set for the update, this setting is not changed. To delete the existing end date setting, and effectively set no end date when updating an asset group, set the end date equal to or later than January 2, 2050. When you retrieve the asset group next time, this element will be nil i.e. it will not be set to January 2, 2050.
  node: CampaignManagementDateShape
  class: CampaignManagementDate
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: path1
  name: path1
  description: The first part of the optional path that will be appended to the domain portion of your display URL. The domain portion of your display URL e.g. https://www.contoso.com will be generated from the domain of your Final URL (FinalUrls element). Then if you have specified a value for Path1 it will be appended to the display URL. If you have also specified a value for Path2, then it will also be appended to the display URL after Path1. For example if your FinalUrls contains https://www.contoso.com, Path1 is set to subdirectory1, and Path2 is set to subdirectory2, then the URL displayed will be https://www.contoso.com/subdirectory1/subdirectory2. No more than 15 characters can be input. The ad will fail to display if the length of the final URL domain and the paths combined exceed 67 characters. For languages with double-width characters e.g. Traditional Chinese no more than 7 final characters can be input. The ad will fail to display if the length of the final URL domain and the paths combined exceed 33 characters. The double-width characters are determined by the characters you use instead of the character set of the campaign language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The path cannot contain the forward slash (/) or newline (\n) characters. If the path includes a space, it will be replaced with an underscore (_) when the ad is shown. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: path2
  name: path2
  description: The second part of the optional path that will be appended to the domain portion of your display URL. The domain portion of your display URL e.g. https://www.contoso.com will be generated from the domain of your Final URL (FinalUrls element). Then if you have specified a value for Path1 it will be appended to the display URL. If you have also specified a value for Path2, then it will also be appended to the display URL after Path1. For example if your FinalUrls contains https://www.contoso.com, Path1 is set to subdirectory1, and Path2 is set to subdirectory2, then the URL displayed will be https://www.contoso.com/subdirectory1/subdirectory2. You can only specify Path2 if Path1 is also set. No more than 15 characters can be input. The ad will fail to display if the length of the final URL domain and the paths combined exceed 67 characters. For languages with double-width characters e.g. Traditional Chinese no more than 7 final characters can be input. The ad will fail to display if the length of the final URL domain and the paths combined exceed 33 characters. The double-width characters are determined by the characters you use instead of the character set of the campaign language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The path cannot contain the forward slash (/) or newline (\n) characters. If the path includes a space, it will be replaced with an underscore (_) when the ad is shown. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: businessName
  name: business name
  description: The name of the business. Your business's name may appear in your ad, depending on the ad placement. The length of the string is limited to 25 characters. Add: Required. If not provided and parent campaign associates to a store, the store name will be used as the business name. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: headlines
  name: headlines
  description: Headlines are the most prominent text that appears in your ad, so you should make the most out of the available characters. We require multiple headlines so the ad can flexibly display across a variety of publishers and placements. From a data model perspective the descriptions and headlines are each stored as text assets i.e., one TextAsset per AssetLink. The same asset can be used by multiple ads. For example if "Seamless Integration" is a text asset, it will have the same asset identifier across all ads in the same Microsoft Advertising account. You must set between 3-15 headlines. Each headline's Text must contain at least one word. The Text cannot contain the newline (\n) character. If the parent campaign associates to a store and you specify Headlines, you must also specify LongHeadlines, Descriptions, and Images. Add: Optional if its parent campaign associates to a store, required if its parent campaign does not associate to a store. Update: Optional. To retain all of the existing asset links, set or leave this element nil. If you set a value for this element, any headlines that were previously linked to this asset group will be replaced. If the parent campaign associates to a store and you set this element to an empty list, the previous setting will be deleted.
  node: CampaignManagementAssetLinkShape
  class: CampaignManagementAssetLink
  node kind: BlankNodeOrIRI
property:
  path: longHeadlines
  name: long headlines
  description: You must set between 1-5 long headlines. Each headline's Text must contain at least one word. The Text cannot contain the newline (\n) character. If the parent campaign associates to a store and you specify LongHeadlines, you must also specify Headlines, Descriptions, and Images. Add: Optional if the parent campaign associates to a store, required if its parent campaign does not associate to a store. Update: Optional. To retain all of the existing asset links, set or leave this element nil. If you set a value for this element, any headlines that were previously linked to this asset group will be replaced. If the parent campaign associates to a store and you set this element to an empty list, the previous setting will be deleted.
  node: CampaignManagementAssetLinkShape
  class: CampaignManagementAssetLink
  node kind: BlankNodeOrIRI
property:
  path: descriptions
  name: descriptions
  description: The descriptions that are shown below the path in your ad. You must set between 2-5 descriptions. Each description's Text must contain at least one word. The Text cannot contain the newline (\n) character. If the parent campaign associates to a store and you specify Descriptions, you must also specify Headlines, LongHeadlines, and Images. Add: Optional if the parent campaign associates to a store, required if its parent campaign does not associate to a store. Update: Optional. To retain all of the existing asset links, set or leave this element nil. If you set a value for this element, any descriptions that were previously linked to this asset group will be replaced. If the parent campaign associates to a store and you set this element to an empty list, the previous setting will be deleted.
  node: CampaignManagementAssetLinkShape
  class: CampaignManagementAssetLink
  node kind: BlankNodeOrIRI
property:
  path: images
  name: images
  description: Image assets with different sizes and aspect ratios so they can flexibly display across a variety of publishers and placements. Include one or more AssetLink objects that each contain an ImageAsset with SubType and crop settings that match the desired aspect ratio. The ImageAsset contains the CropHeight, CropWidth, CropX, CropY and SubType fields. The possible sub type values include LandscapeImageMedia, SquareImageMedia, LandscapeLogoMedia, SquareLogoMedia, ImageMedia1x2, ImageMedia4x1, ImageMedia201X100, ImageMedia169X100, ImageMedia153X100, and ImageMedia124X100. You must provide at least 1 LandscapeImageMedia and 1 SquareImageMedia. A total of up to 20 images and a total of up to 5 logos can be saved. If the parent campaign associates to a store and you specify Images, you must also specify Headlines, LongHeadlines, and Descriptions. Add: Optional if the parent campaign associates to a store, required if its parent campaign does not associate to a store. Update: Optional. If no value is set for the update, this setting is not changed. If you include images during update, any previously set images will be replaced. If the parent campaign associates to a store and you set this element to an empty list, the previous setting will be deleted.
  node: CampaignManagementAssetLinkShape
  class: CampaignManagementAssetLink
  node kind: BlankNodeOrIRI
property:
  path: videos
  name: videos
  description: Reserved.
  node: CampaignManagementAssetLinkShape
  class: CampaignManagementAssetLink
  node kind: BlankNodeOrIRI
property:
  path: callToAction
  name: call to action
  description: A brief, punchy reason for customers to click your ad right now. This is displayed on your call to action button. Add: Required. If not provided and parent campaign associates to a store, it will default to LearnMore. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Unknown
  in: ActNow
  in: ApplyNow
  in: BetNow
  in: BidNow
  in: BookACar
  in: BookHotel
  in: BookNow
  in: Browse
  in: BuyNow
  in: ChatNow
  in: Compare
  in: ContactUs
  in: Coupon
  in: Donate
  in: Download
  in: EmailNow
  in: EnrollNow
  in: Explore
  in: FileNow
  in: FindJob
  in: FreePlay
  in: FreeQuote
  in: FreeTrial
  in: GetDeals
  in: GetOffer
  in: GetQuote
  in: JoinNow
  in: LearnMore
  in: ListenNow
  in: LogIn
  in: Message
  in: NewCars
  in: OrderNow
  in: PlayGame
  in: PlayNow
  in: PostJob
  in: Register
  in: RentACar
  in: RentNow
  in: Reserve
  in: Sale
  in: SaveNow
  in: Schedule
  in: SeeMenu
  in: SeeMore
  in: SeeOffer
  in: SellNow
  in: ShopNow
  in: Showtimes
  in: SignIn
  in: SignUp
  in: StartFree
  in: StartNow
  in: Subscribe
  in: TestDrive
  in: TryNow
  in: UsedCars
  in: ViewCars
  in: ViewNow
  in: ViewPlans
  in: VisitSite
  in: VoteNow
  in: Watch
  in: WatchMore
  in: WatchNow
  in: Directions
  in: FindStore
  in: SwitchNow
  in: VisitStore
  in: RenewNow
  in: Reorder
  in: Default
  in: NoButton
  in: Install
property:
  path: finalUrls
  name: final urls
  description: The landing page URL. The domain portion of the URL in combination with the path 1 and path 2 strings cannot exceed 67 characters. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. For retail campaigns, the final url must match the domain from the store associated with the campaign. Add: Required. If not provided and parent campaign associates to a store, the store URL will be used as the final URL. Update: Optional
  datatype: string
property:
  path: assetGroupSearchThemes
  name: asset group search themes
  description: A list of asset group search themes.
  node: CampaignManagementAssetGroupSearchThemeShape
  class: CampaignManagementAssetGroupSearchTheme
  node kind: BlankNodeOrIRI
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The mobile landing page URL. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specifiy up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. Add: Optional Update: Optional
  datatype: string
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all URLs in your asset group. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, asset group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementAssetGroupSearchThemeShape
type: NodeShape
target class: CampaignManagementAssetGroupSearchTheme
property:
  path: id
  name: id
  description: The system generated asset group ID. Add: Read-only Update: Read-only
  datatype: long
  max count: 1
property:
  path: searchTheme
  name: search theme
  description: The type of search theme.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Reserved.
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Disapproved
  in: Inactive
  in: Deleted

CampaignManagementAssetGroupUrlTargetShape
type: NodeShape
target class: CampaignManagementAssetGroupUrlTarget
property:
  path: id
  name: id
  description: Reserved.
  datatype: long
  max count: 1
property:
  path: targetCondition1
  name: target condition1
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: targetConditionOperator1
  name: target condition operator1
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: targetValue1
  name: target value1
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: targetCondition2
  name: target condition2
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: targetConditionOperator2
  name: target condition operator2
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: targetValue2
  name: target value2
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: targetCondition3
  name: target condition3
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: targetConditionOperator3
  name: target condition operator3
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: targetValue3
  name: target value3
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Reserved.
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Disapproved
  in: Inactive
  in: Deleted

CampaignManagementAddAssetGroupsResponseShape
type: NodeShape
target class: CampaignManagementAddAssetGroupsResponse
property:
  path: assetGroupIds
  name: asset group ids
  description: Array of asset group IDs to update for the specified campaign. A maximum of 100 asset groups can be specified in a single call.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that weren't successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddAudienceGroupsRequestShape
type: NodeShape
target class: CampaignManagementAddAudienceGroupsRequest
property:
  path: audienceGroups
  name: audience groups
  description: Array of audience groups. The maximum size of the list is 100 items per service request. You can add a maximum of 10,000 audience groups per account.
  node: CampaignManagementAudienceGroupShape
  class: CampaignManagementAudienceGroup
  node kind: BlankNodeOrIRI

CampaignManagementAudienceGroupShape
type: NodeShape
target class: CampaignManagementAudienceGroup
property:
  path: name
  name: name
  description: The name of the audience signal, the name must be unique among all audience groups within the account. The name can contain a maximum of 256 characters. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description of the audience. Use a description to help you remember what audience you are using. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: dimensions
  name: dimensions
  description: Positive dimensions that specifying the audience composition. It should have at least one dimension. Add: Required, at least one dimension is needed. Update: Optional. For each dimension type (age, gender, audience): - If not present in the array, it's not changed. - If it's present in the array, take Age dimension type as an example: - If AgeRanges is set to null or empty, it'll remove existing values for this dimension type. - If AgeRanges has data, it simply replaces existing values. Note: You can't remove all dimension types. An error will be returned and no changes will be made.
  or:
    node: CampaignManagementAgeDimensionShape
    class: CampaignManagementAgeDimension
  or:
    node: CampaignManagementAudienceDimensionShape
    class: CampaignManagementAudienceDimension
  or:
    node: CampaignManagementAudienceGroupDimensionShape
    class: CampaignManagementAudienceGroupDimension
  or:
    node: CampaignManagementAudienceGroupDimensionBaseShape
    class: CampaignManagementAudienceGroupDimensionBase
  or:
    node: CampaignManagementGenderDimensionShape
    class: CampaignManagementGenderDimension
  or:
    node: CampaignManagementProfileDimensionShape
    class: CampaignManagementProfileDimension
  node kind: BlankNodeOrIRI
property:
  path: associationCount
  name: association count
  description: The number of asset groups that associate with this audience group. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: The system-generated ID. Add: Read-only Update: Required
  datatype: long
  max count: 1

CampaignManagementAudienceGroupDimensionShape
type: NodeShape
target class: CampaignManagementAudienceGroupDimension
property:
  path: type
  name: type
  description: The type of audience dimensions, the following dimension types are supported as of now: Age, Gender, Audience. Add: For more information about audience types, see the Remarks. Update: For more information about audience types, see the Remarks.
  datatype: string
  max count: 1
  in: Age
  in: Gender
  in: Audience
  in: Profile
property:
  path: ageRanges
  name: age ranges
  datatype: string
  in: Unknown
  in: EighteenToTwentyFour
  in: TwentyFiveToThirtyFour
  in: ThirtyFiveToFourtyNine
  in: FiftyToSixtyFour
  in: SixtyFiveAndAbove
  in: ThirtyFiveToFiftyFour
  in: FiftyFiveAndAbove
property:
  path: genderTypes
  name: gender types
  datatype: string
  in: Unknown
  in: Male
  in: Female
property:
  path: audiences
  name: audiences
  node: CampaignManagementAudienceInfoShape
  class: CampaignManagementAudienceInfo
  node kind: BlankNodeOrIRI
property:
  path: profiles
  name: profiles
  node: CampaignManagementProfileInfoShape
  class: CampaignManagementProfileInfo
  node kind: BlankNodeOrIRI

CampaignManagementAudienceInfoShape
type: NodeShape
target class: CampaignManagementAudienceInfo
property:
  path: id
  name: id
  description: The ID of the audience.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the audience. Add: Read-only Update: Read-only
  datatype: string
  max count: 1

CampaignManagementProfileInfoShape
type: NodeShape
target class: CampaignManagementProfileInfo
property:
  path: id
  name: id
  description: Reserved.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: Reserved.
  datatype: string
  max count: 1

CampaignManagementAddAudienceGroupsResponseShape
type: NodeShape
target class: CampaignManagementAddAudienceGroupsResponse
property:
  path: audienceGroupIds
  name: audience group ids
  description: Array of audience group ids to be added. The maximum size of the list is 100 items per service request.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that weren't successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddAudiencesRequestShape
type: NodeShape
target class: CampaignManagementAddAudiencesRequest
property:
  path: audiences
  name: audiences
  description: The list of audiences to add. The maximum size of the list is 100. You cannot add CustomAudience, InMarketAudience, or SimilarRemarketingList objects.
  or:
    node: CampaignManagementAudienceShape
    class: CampaignManagementAudience
  or:
    node: CampaignManagementAudienceBaseShape
    class: CampaignManagementAudienceBase
  or:
    node: CampaignManagementCombinedListShape
    class: CampaignManagementCombinedList
  or:
    node: CampaignManagementCustomAudienceShape
    class: CampaignManagementCustomAudience
  or:
    node: CampaignManagementCustomSegmentShape
    class: CampaignManagementCustomSegment
  or:
    node: CampaignManagementCustomerListShape
    class: CampaignManagementCustomerList
  or:
    node: CampaignManagementImpressionBasedRemarketingListShape
    class: CampaignManagementImpressionBasedRemarketingList
  or:
    node: CampaignManagementInMarketAudienceShape
    class: CampaignManagementInMarketAudience
  or:
    node: CampaignManagementProductAudienceShape
    class: CampaignManagementProductAudience
  or:
    node: CampaignManagementRemarketingListShape
    class: CampaignManagementRemarketingList
  or:
    node: CampaignManagementSimilarRemarketingListShape
    class: CampaignManagementSimilarRemarketingList
  node kind: BlankNodeOrIRI

CampaignManagementAudienceShape
type: NodeShape
target class: CampaignManagementAudience
property:
  path: scope
  name: scope
  description: Scope defines what accounts can use this audience. If scope is set to Account, the audience can only be associated with campaigns and ad groups in one account i.e., via the ParentId. If scope is set to Customer, the audience can be associated with campaigns and ad groups in all of the customer's accounts.
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: membershipDuration
  name: membership duration
  description: When you create an audience, you can specify how far back in time Microsoft Advertising should look for actions that match your audience definition. The minimum duration is 1 day and the maximum duration allowed is 180 days.
  datatype: int
  max count: 1
property:
  path: searchSize
  name: search size
  description: The total number of people who are active members of this audience in the Search network. This gives you an idea of how many search users you can target. Please see more details in documentation for the objects that inherit this element e.g., RemarketingList.
  datatype: long
  max count: 1
property:
  path: audienceNetworkSize
  name: audience network size
  description: The total number of people who are active members of this audience in the Audience network. This gives you an idea of how many Audience network users you can target. Please see more details in documentation for the objects that inherit this element e.g., RemarketingList.
  datatype: long
  max count: 1
property:
  path: supportedCampaignTypes
  name: supported campaign types
  description: The list of campaign types that support this audience. Supported values are Audience, DynamicSearchAds, Search, and Shopping. New campaign types might be added in the future, so you should not take any dependency on a fixed set of values.
  datatype: string
property:
  path: customerShare
  name: customer share
  description: Determines the list of customers and accounts that share the audience. Details include audience association counts. This element is only supported with a RemarketingList. Audiences of other types cannot be shared in the customer hierarchy.
  node: CampaignManagementCustomerShareShape
  class: CampaignManagementCustomerShare
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: The Microsoft Advertising identifier of the audience.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the audience. The name can contain a maximum of 128 characters.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description of the audience. Use a description to help you remember what audience you are targeting. The description can contain a maximum of 1,024 characters.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the audience. For more information about audience types, see the Remarks.
  datatype: string
  max count: 1
property:
  path: parentId
  name: parent id
  description: The Microsoft Advertising identifier of the account or customer. If the Scope is set to Account, this is the account ID, and otherwise it is the customer ID.
  datatype: long
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: rule
  name: rule
  or:
    node: CampaignManagementCustomEventsRuleShape
    class: CampaignManagementCustomEventsRule
  or:
    node: CampaignManagementPageVisitorsRuleShape
    class: CampaignManagementPageVisitorsRule
  or:
    node: CampaignManagementPageVisitorsWhoDidNotVisitAnotherPageRuleShape
    class: CampaignManagementPageVisitorsWhoDidNotVisitAnotherPageRule
  or:
    node: CampaignManagementPageVisitorsWhoVisitedAnotherPageRuleShape
    class: CampaignManagementPageVisitorsWhoVisitedAnotherPageRule
  or:
    node: CampaignManagementRemarketingRuleShape
    class: CampaignManagementRemarketingRule
  or:
    node: CampaignManagementRemarketingRuleBaseShape
    class: CampaignManagementRemarketingRuleBase
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: tagId
  name: tag id
  datatype: long
  max count: 1
property:
  path: productAudienceType
  name: product audience type
  datatype: string
  max count: 1
property:
  path: sourceId
  name: source id
  datatype: long
  max count: 1
property:
  path: combinationRules
  name: combination rules
  node: CampaignManagementCombinationRuleShape
  class: CampaignManagementCombinationRule
  node kind: BlankNodeOrIRI
property:
  path: customSegmentCatalogList
  name: custom segment catalog list
  node: CampaignManagementCustomSegmentCatalogShape
  class: CampaignManagementCustomSegmentCatalog
  node kind: BlankNodeOrIRI
property:
  path: editorialStatus
  name: editorial status
  datatype: string
  max count: 1
  in: Unknown
  in: Rejected
  in: Pending
  in: PartialApproved
  in: Approved
property:
  path: entityType
  name: entity type
  datatype: string
  max count: 1
  in: None
  in: Campaign
  in: AdGroup
property:
  path: campaignId
  name: campaign id
  datatype: long
  max count: 1
property:
  path: adGroupId
  name: ad group id
  datatype: long
  max count: 1
property:
  path: campaignIds
  name: campaign ids
  datatype: long
property:
  path: adGroupIds
  name: ad group ids
  datatype: long

CampaignManagementCustomerShareShape
type: NodeShape
target class: CampaignManagementCustomerShare
property:
  path: ownerCustomerId
  name: owner customer id
  description: The customer who owns the share. Add: Read-only Update: Read-only
  datatype: long
  max count: 1
property:
  path: customerAccountShares
  name: customer account shares
  description: Determines the list of customers and accounts that share the audience or UET tag. Details include audience association counts. When the audience or UET tag has not yet been shared, this element will be nil or empty. Once an audience or UET tag is shared, a CustomerAccountShare object is returned for each customer that can use the share, including one list item for the owner. Add: Required Update: Optional. Once you create this CustomerShare object, the existing CustomerAccountShare list will be removed or replaced. To remove all existing customer account shares create this CustomerShare object and set the CustomerAccountShares element to nil. To replace or append to the list of customer account shares, create this CustomerShare object and assign to the CustomerAccountShares element a new list of CustomerAccountShare objects, including any previous customer account shares that you want to retain. To retain all of the existing customer account shares, set the element that uses this CustomerShare object to nil. For example set the CustomerShare element of a RemarketingList to nil if you do not want to update any of the customer account shares.
  node: CampaignManagementCustomerAccountShareShape
  class: CampaignManagementCustomerAccountShare
  node kind: BlankNodeOrIRI

CampaignManagementCustomerAccountShareShape
type: NodeShape
target class: CampaignManagementCustomerAccountShare
property:
  path: customerId
  name: customer id
  description: The identifier of a customer that can use the shared audience or UET tag. If this element is not set, then the audience is only shared with a subset of advertiser accounts under this customer. Please see AccountId for details about sharing audiences with advertiser accounts. Add: Optional. You must set the AccountId or CustomerId, but you cannot set both. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: long
  max count: 1
property:
  path: accountId
  name: account id
  description: The identifier of an advertiser account that can use the shared audience. This element is not applicable for UET tags since you cannot restrict UET tags to a subset of advertiser accounts. You can only create and share UET tags at the CustomerId level. If this element is not set, then all accounts under the CustomerId can use the shared audience or UET tag. One CustomerAccountShare object per advertiser account must be present in the CustomerShare for an audience that is shared with a subset of advertiser accounts, whether or not the advertiser accounts are under the same customer. Add: Optional. You must set the AccountId or CustomerId, but you cannot set both. Update: Optional. You must set the AccountId or CustomerId, but you cannot set both. If no value is set for the update, this setting is not changed.
  datatype: long
  max count: 1
property:
  path: associations
  name: associations
  description: Provides details about whether and how the shared audience or UET tag is being used. Each list item contains the association count for the corresponding usage type. Add: Read-only Update: Read-only
  node: CampaignManagementCustomerAccountShareAssociationShape
  class: CampaignManagementCustomerAccountShareAssociation
  node kind: BlankNodeOrIRI

CampaignManagementCustomerAccountShareAssociationShape
type: NodeShape
target class: CampaignManagementCustomerAccountShareAssociation
property:
  path: usageType
  name: usage type
  description: Indicates how the customer account share is used e.g., via audience association. The possible values include RemarketingListAssociateToAdGroup, RemarketingListAssociateToCampaign, and UETTagAssociateToRemarketingList. New values be added in the future, so you should not take any dependency on a fixed set of strings. - RemarketingListAssociateToAdGroup - The remarketing list is associated with or excluded by one or more ad groups. - RemarketingListAssociateToCampaign - The remarketing list is associated with or excluded by one or more campaigns. - UETTagAssociateToConversionGoal - The UET tag is used by one or more conversion goals. - UETTagAssociateToProductAudience - The UET tag is used by one or more product audiences. - UETTagAssociateToRemarketingList - The UET tag is used by one or more remarketing lists. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: associationCount
  name: association count
  description: The association count for the corresponding usage type. Add: Read-only Update: Read-only
  datatype: long
  max count: 1

CampaignManagementRemarketingRuleShape
type: NodeShape
target class: CampaignManagementRemarketingRule
property:
  path: type
  name: type
  description: The type of the remarketing rule. For more information about remarketing rule types, see the Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: ruleItemGroups
  name: rule item groups
  node: CampaignManagementRuleItemGroupShape
  class: CampaignManagementRuleItemGroup
  node kind: BlankNodeOrIRI
property:
  path: normalForm
  name: normal form
  datatype: string
  max count: 1
  in: Conjunctive
  in: Disjunctive
property:
  path: anotherRuleItemGroups
  name: another rule item groups
  node: CampaignManagementRuleItemGroupShape
  class: CampaignManagementRuleItemGroup
  node kind: BlankNodeOrIRI
property:
  path: includeRuleItemGroups
  name: include rule item groups
  node: CampaignManagementRuleItemGroupShape
  class: CampaignManagementRuleItemGroup
  node kind: BlankNodeOrIRI
property:
  path: excludeRuleItemGroups
  name: exclude rule item groups
  node: CampaignManagementRuleItemGroupShape
  class: CampaignManagementRuleItemGroup
  node kind: BlankNodeOrIRI
property:
  path: categoryOperator
  name: category operator
  datatype: string
  max count: 1
  in: None
  in: Equals
  in: Contains
  in: BeginsWith
  in: EndsWith
  in: NotEquals
  in: DoesNotContain
  in: DoesNotBeginWith
  in: DoesNotEndWith
property:
  path: category
  name: category
  datatype: string
  max count: 1
property:
  path: actionOperator
  name: action operator
  datatype: string
  max count: 1
  in: None
  in: Equals
  in: Contains
  in: BeginsWith
  in: EndsWith
  in: NotEquals
  in: DoesNotContain
  in: DoesNotBeginWith
  in: DoesNotEndWith
property:
  path: action
  name: action
  datatype: string
  max count: 1
property:
  path: labelOperator
  name: label operator
  datatype: string
  max count: 1
  in: None
  in: Equals
  in: Contains
  in: BeginsWith
  in: EndsWith
  in: NotEquals
  in: DoesNotContain
  in: DoesNotBeginWith
  in: DoesNotEndWith
property:
  path: label
  name: label
  datatype: string
  max count: 1
property:
  path: valueOperator
  name: value operator
  datatype: string
  max count: 1
  in: None
  in: Equals
  in: GreaterThan
  in: LessThan
  in: GreaterThanEqualTo
  in: LessThanEqualTo
  in: NotEquals
property:
  path: value
  name: value
  datatype: double
  max count: 1

CampaignManagementRuleItemGroupShape
type: NodeShape
target class: CampaignManagementRuleItemGroup
property:
  path: items
  name: items
  description: The list of rule items. The maximum number of rule items in a rule item group is 100. The rule items must all be of the same concrete type derived from the RuleItem base class. Currently only a list of StringRuleItem objects are supported. The list of StringRuleItem objects apply to same visited page, and the rule conditions are joined using the logical AND operator. In other words to add a visitor to the remarketing list, one page must meet all of the conditions in this rule item list. To create a list of rules for another page, you must add a separate RuleItemGroup. Add: Required Update: Optional. If you want to keep any of the previous rule items, then you must explicitly set them again during update.
  or:
    node: CampaignManagementNumberRuleItemShape
    class: CampaignManagementNumberRuleItem
  or:
    node: CampaignManagementRuleItemShape
    class: CampaignManagementRuleItem
  or:
    node: CampaignManagementRuleItemBaseShape
    class: CampaignManagementRuleItemBase
  or:
    node: CampaignManagementStringRuleItemShape
    class: CampaignManagementStringRuleItem
  node kind: BlankNodeOrIRI

CampaignManagementRuleItemShape
type: NodeShape
target class: CampaignManagementRuleItem
property:
  path: type
  name: type
  description: The type of rule item. For more information, see Remarks.
  datatype: string
  max count: 1
property:
  path: operand
  name: operand
  datatype: string
  max count: 1
property:
  path: operator
  name: operator
  datatype: string
  max count: 1
  in: None
  in: Equals
  in: GreaterThan
  in: LessThan
  in: GreaterThanEqualTo
  in: LessThanEqualTo
  in: NotEquals
property:
  path: value
  name: value
  datatype: string
  max count: 1

CampaignManagementCombinationRuleShape
type: NodeShape
target class: CampaignManagementCombinationRule
property:
  path: audienceIds
  name: audience ids
  description: The list of audience identifiers to combine in a logical set. You can combine custom audiences, customer lists, product audiences, similar audiences, and remarketing lists. You cannot include other combined lists or in-market audiences in a combined list. For details, please see the remarks section below. Each combination rule set can contain up to 100 audience IDs.
  datatype: long
property:
  path: operator
  name: operator
  description: Determines whether to include or exclude any or all of the AudienceIds.
  datatype: string
  max count: 1
  in: And
  in: Or
  in: Not

CampaignManagementCustomSegmentCatalogShape
type: NodeShape
target class: CampaignManagementCustomSegmentCatalog
property:
  path: catalogId
  name: catalog id
  description: The catalog ID.
  datatype: long
  max count: 1
property:
  path: catalogName
  name: catalog name
  description: The catalog name.
  datatype: string
  max count: 1
property:
  path: effectiveEditorialStatus
  name: effective editorial status
  description: The effective editorial status.
  datatype: string
  max count: 1
  in: Unknown
  in: Approved
  in: Rejected
  in: Pending

CampaignManagementAddAudiencesResponseShape
type: NodeShape
target class: CampaignManagementAddAudiencesResponse
property:
  path: audienceIds
  name: audience ids
  description: A list of unique system identifiers corresponding to the audiences that were added. The list of identifiers corresponds directly to the list of audiences in the request. Items of the list may be returned as null. For each list index where an audience was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddBidStrategiesRequestShape
type: NodeShape
target class: CampaignManagementAddBidStrategiesRequest
property:
  path: bidStrategies
  name: bid strategies
  description: An array of BidStrategy objects to add to the account's portfolio bid strategy library. You can include a maximum of 100 bid strategies in a single call. Each account can have up to 11,000 portfolio bid strategies. The account is determined by the required CustomerAccountId header element.
  node: CampaignManagementBidStrategyShape
  class: CampaignManagementBidStrategy
  node kind: BlankNodeOrIRI

CampaignManagementBidStrategyShape
type: NodeShape
target class: CampaignManagementBidStrategy
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the bid strategy. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the bid strategy. The name must be unique among all bid strategies within the account. The name can contain a maximum of 255 characters. The service performs a case-insensitive comparison when it compares the name to existing bid strategy names. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: associatedCampaignType
  name: associated campaign type
  description: The type of ad campaign that can be included the portfolio bid strategy. The supported campaign types are "Search" and "Shopping" (except smart shopping campaigns). Once you choose a campaign type, the portfolio can only include campaigns of that type. Add: Optional. The default campaign type is Search. Update: Read-only
  datatype: string
  max count: 1
property:
  path: biddingScheme
  name: bidding scheme
  description: The portfolio bid strategy type and settings. If the AssociatedCampaignType is "Search", the supported bid strategies are MaxClicksBiddingScheme, MaxConversionsBiddingScheme TargetCpaBiddingScheme, TargetImpressionShareBiddingScheme, and TargetRoasBiddingScheme. If the AssociatedCampaignType is "Shopping", the supported bid strategies are MaxClicksBiddingScheme and TargetRoasBiddingScheme. Once you choose a bid strategy type it cannot be updated. Add: Required Update: Optional. You can update properties of a bidding scheme, but you cannot change the type.
  or:
    node: CampaignManagementBiddingSchemeShape
    class: CampaignManagementBiddingScheme
  or:
    node: CampaignManagementBiddingSchemeBaseShape
    class: CampaignManagementBiddingSchemeBase
  or:
    node: CampaignManagementCommissionBiddingSchemeShape
    class: CampaignManagementCommissionBiddingScheme
  or:
    node: CampaignManagementCostPerSaleBiddingSchemeShape
    class: CampaignManagementCostPerSaleBiddingScheme
  or:
    node: CampaignManagementEnhancedCpcBiddingSchemeShape
    class: CampaignManagementEnhancedCpcBiddingScheme
  or:
    node: CampaignManagementInheritFromParentBiddingSchemeShape
    class: CampaignManagementInheritFromParentBiddingScheme
  or:
    node: CampaignManagementManualCpaBiddingSchemeShape
    class: CampaignManagementManualCpaBiddingScheme
  or:
    node: CampaignManagementManualCpcBiddingSchemeShape
    class: CampaignManagementManualCpcBiddingScheme
  or:
    node: CampaignManagementManualCpmBiddingSchemeShape
    class: CampaignManagementManualCpmBiddingScheme
  or:
    node: CampaignManagementManualCpvBiddingSchemeShape
    class: CampaignManagementManualCpvBiddingScheme
  or:
    node: CampaignManagementMaxClicksBiddingSchemeShape
    class: CampaignManagementMaxClicksBiddingScheme
  or:
    node: CampaignManagementMaxConversionValueBiddingSchemeShape
    class: CampaignManagementMaxConversionValueBiddingScheme
  or:
    node: CampaignManagementMaxConversionsBiddingSchemeShape
    class: CampaignManagementMaxConversionsBiddingScheme
  or:
    node: CampaignManagementMaxRoasBiddingSchemeShape
    class: CampaignManagementMaxRoasBiddingScheme
  or:
    node: CampaignManagementPercentCpcBiddingSchemeShape
    class: CampaignManagementPercentCpcBiddingScheme
  or:
    node: CampaignManagementTargetCpaBiddingSchemeShape
    class: CampaignManagementTargetCpaBiddingScheme
  or:
    node: CampaignManagementTargetImpressionShareBiddingSchemeShape
    class: CampaignManagementTargetImpressionShareBiddingScheme
  or:
    node: CampaignManagementTargetRoasBiddingSchemeShape
    class: CampaignManagementTargetRoasBiddingScheme
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: associationCount
  name: association count
  description: The number of Campaign objects that currently share this bid strategy. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: scope
  name: scope
  description: A nullable field that indicates whether the bid strategy is created at the customer level or the account level. If no value is provided, the default scope is Account.
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: currencyCode
  name: currency code
  description: The currency for the cross-account poortfolio. It must match the account currency provided. If null, it defaults to the account's currency. This field can't be updated.
  datatype: string
  max count: 1
property:
  path: reportingTimeZone
  name: reporting time zone
  description: Specifies the reporting timezone for the campaign. If no value is provided, it defaults to the account's timezone. This field can be updated.
  datatype: string
  max count: 1

CampaignManagementAddBidStrategiesResponseShape
type: NodeShape
target class: CampaignManagementAddBidStrategiesResponse
property:
  path: bidStrategyIds
  name: bid strategy ids
  description: A list of unique system identifiers corresponding to the bid strategies that were added. The list of identifiers corresponds directly to the list of bid strategies in the request. Items of the list may be returned as null. For each list index where a bid strategy was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddBrandKitsRequestShape
type: NodeShape
target class: CampaignManagementAddBrandKitsRequest
property:
  path: accountId
  name: account id
  description: The Microsoft Advertising identifier of the account.
  datatype: long
  max count: 1
property:
  path: brandKits
  name: brand kits
  description: A list of BrandKits to be created for the specified account.
  node: CampaignManagementBrandKitShape
  class: CampaignManagementBrandKit
  node kind: BlankNodeOrIRI

CampaignManagementBrandKitShape
type: NodeShape
target class: CampaignManagementBrandKit
property:
  path: id
  name: id
  description: The identifier of the brand kit.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The brand kit's name.
  datatype: string
  max count: 1
property:
  path: businessName
  name: business name
  description: The name of the business.
  datatype: string
  max count: 1
property:
  path: images
  name: images
  description: The brand kit's images.
  node: CampaignManagementBrandKitImageShape
  class: CampaignManagementBrandKitImage
  node kind: BlankNodeOrIRI
property:
  path: squareLogos
  name: square logos
  description: The brand kit's square logos.
  node: CampaignManagementBrandKitImageShape
  class: CampaignManagementBrandKitImage
  node kind: BlankNodeOrIRI
property:
  path: landscapeLogos
  name: landscape logos
  description: The brand kit's landscape logos.
  node: CampaignManagementBrandKitImageShape
  class: CampaignManagementBrandKitImage
  node kind: BlankNodeOrIRI
property:
  path: palettes
  name: palettes
  description: The brand kit's palettes.
  node: CampaignManagementBrandKitPaletteShape
  class: CampaignManagementBrandKitPalette
  node kind: BlankNodeOrIRI
property:
  path: fonts
  name: fonts
  description: The brand kit's fonts.
  node: CampaignManagementBrandKitFontShape
  class: CampaignManagementBrandKitFont
  node kind: BlankNodeOrIRI
property:
  path: brandVoice
  name: brand voice
  description: The brand's personality and tone.
  node: CampaignManagementBrandVoiceShape
  class: CampaignManagementBrandVoice
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: termExclusions
  name: term exclusions
  description: The term exclusions to use with your brand kit.
  datatype: string
property:
  path: messagingRestrictions
  name: messaging restrictions
  description: The messaging restrictions to use with your brand kit.
  datatype: string

CampaignManagementBrandKitImageShape
type: NodeShape
target class: CampaignManagementBrandKitImage
property:
  path: cropX
  name: crop x
  description: Where to crop along the x-axis in pixels.
  datatype: int
  max count: 1
property:
  path: cropY
  name: crop y
  description: Where to crop along the y-axis in pixels.
  datatype: int
  max count: 1
property:
  path: cropWidth
  name: crop width
  description: The crop wdith in pixels.
  datatype: int
  max count: 1
property:
  path: cropHeight
  name: crop height
  description: The crop height in pixels.
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: The identifier of the brand kit image.
  datatype: long
  max count: 1
property:
  path: url
  name: url
  description: The URL for the image.
  datatype: string
  max count: 1
property:
  path: thumbnailUrl
  name: thumbnail url
  description: The URL for the image thumbnail.
  datatype: string
  max count: 1

CampaignManagementBrandKitPaletteShape
type: NodeShape
target class: CampaignManagementBrandKitPalette
property:
  path: colors
  name: colors
  description: The brand kit's color palettes.
  node: CampaignManagementBrandKitColorShape
  class: CampaignManagementBrandKitColor
  node kind: BlankNodeOrIRI
property:
  path: colorType
  name: color type
  description: The color type.
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: The name of the brand kit palette.
  datatype: string
  max count: 1

CampaignManagementBrandKitColorShape
type: NodeShape
target class: CampaignManagementBrandKitColor
property:
  path: name
  name: name
  description: The name of the brand kit color.
  datatype: string
  max count: 1
property:
  path: hexCode
  name: hex code
  description: The hex code for the brand kit color.
  datatype: string
  max count: 1

CampaignManagementBrandKitFontShape
type: NodeShape
target class: CampaignManagementBrandKitFont
property:
  path: typeface
  name: typeface
  description: The font typeface.
  datatype: string
  max count: 1
property:
  path: weight
  name: weight
  description: The font weight.
  datatype: string
  max count: 1
property:
  path: textAssetType
  name: text asset type
  description: The font text assset type.
  datatype: string
  max count: 1

CampaignManagementBrandVoiceShape
type: NodeShape
target class: CampaignManagementBrandVoice
property:
  path: personality
  name: personality
  description: The brand personality.
  datatype: string
  max count: 1
property:
  path: tones
  name: tones
  description: The brand tone.
  datatype: string

CampaignManagementAddBrandKitsResponseShape
type: NodeShape
target class: CampaignManagementAddBrandKitsResponse
property:
  path: brandKitIds
  name: brand kit ids
  description: A list of the created BrandKits.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddBudgetsRequestShape
type: NodeShape
target class: CampaignManagementAddBudgetsRequest
property:
  path: budgets
  name: budgets
  description: An array of Budget objects to add to the account's shared budget library. You can add a maximum of 100 budgets in a single call. Each account can have up to 11,000 shared budgets. The account is determined by the required CustomerAccountId header element.
  node: CampaignManagementBudgetShape
  class: CampaignManagementBudget
  node kind: BlankNodeOrIRI

CampaignManagementBudgetShape
type: NodeShape
target class: CampaignManagementBudget
property:
  path: name
  name: name
  description: The name of the budget. The name must be unique among all budgets within the account. The name can contain a maximum of 255 characters. The service performs a case-insensitive comparison when it compares the name to existing budget names. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: amount
  name: amount
  description: The amount to spend daily across all campaigns that share the budget. Add: Required Update: Optional
  datatype: double
  max count: 1
property:
  path: budgetType
  name: budget type
  description: The budget type determines the pace at which the budget is spent throughout the day. The only valid budget type that you can set is DailyBudgetStandard. Add: Required Update: Optional
  datatype: string
  max count: 1
  in: DailyBudgetAccelerated
  in: DailyBudgetStandard
  in: LifetimeBudgetStandard
property:
  path: associationCount
  name: association count
  description: The number of Campaign objects that currently share this budget. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the budget. Add: Read-only Update: Required
  datatype: long
  max count: 1

CampaignManagementAddBudgetsResponseShape
type: NodeShape
target class: CampaignManagementAddBudgetsResponse
property:
  path: budgetIds
  name: budget ids
  description: A list of unique system identifiers corresponding to the budgets that were added. The list of identifiers corresponds directly to the list of budgets in the request. Items of the list may be returned as null. For each list index where a budget was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddCampaignConversionGoalsRequestShape
type: NodeShape
target class: CampaignManagementAddCampaignConversionGoalsRequest
property:
  path: campaignConversionGoal
  name: campaign conversion goal
  description: An array of the base object of a campaign conversion goal.
  node: CampaignManagementCampaignConversionGoalShape
  class: CampaignManagementCampaignConversionGoal
  node kind: BlankNodeOrIRI

CampaignManagementCampaignConversionGoalShape
type: NodeShape
target class: CampaignManagementCampaignConversionGoal
property:
  path: campaignId
  name: campaign id
  description: The Microsoft Advertising assigned identifier of a campaign.
  datatype: long
  max count: 1
property:
  path: goalId
  name: goal id
  description: The Microsoft Advertising assigned identifier of a conversion goal.
  datatype: long
  max count: 1

CampaignManagementAddCampaignConversionGoalsResponseShape
type: NodeShape
target class: CampaignManagementAddCampaignConversionGoalsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddCampaignCriterionsRequestShape
type: NodeShape
target class: CampaignManagementAddCampaignCriterionsRequest
property:
  path: criterionType
  name: criterion type
  description: The type of criterion to add, for example Webpage. You can specify only one criterion type value per call. To add, delete, or update target criterions i.e., age, day and time, device, gender, location, location intent, and radius criterions, you must specify the CriterionType value as Targets. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these target criterions via GetCampaignCriterionsByIds you must request the specific type individually i.e., Age, DayTime, Device, Gender, Location, LocationIntent, and Radius. To add, delete, or update audience criterions i.e., custom audiences, in-market audiences, and remarketing lists, you must specify the CriterionType value as Audience. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these audience criterions via GetCampaignCriterionsByIds you must request the specific type individually i.e., CustomAudience, InMarketAudience, ProductAudience, and RemarketingList.
  datatype: string
  max count: 1
property:
  path: campaignCriterions
  name: campaign criterions
  description: A list of criterions that help determine whether ads in each campaign get served. You can include up to 100 campaign criterions per request.
  or:
    node: CampaignManagementBiddableCampaignCriterionShape
    class: CampaignManagementBiddableCampaignCriterion
  or:
    node: CampaignManagementCampaignCriterionShape
    class: CampaignManagementCampaignCriterion
  or:
    node: CampaignManagementCampaignCriterionBaseShape
    class: CampaignManagementCampaignCriterionBase
  or:
    node: CampaignManagementNegativeCampaignCriterionShape
    class: CampaignManagementNegativeCampaignCriterion
  node kind: BlankNodeOrIRI

CampaignManagementCampaignCriterionShape
type: NodeShape
target class: CampaignManagementCampaignCriterion
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign to apply the criterion to.
  datatype: long
  max count: 1
property:
  path: criterion
  name: criterion
  description: The criterion to apply to the campaign. The criterion helps determine whether ads in the campaign are served. For a list of available criterion types, see CampaignCriterionType.
  or:
    node: CampaignManagementAgeCriterionShape
    class: CampaignManagementAgeCriterion
  or:
    node: CampaignManagementAudienceCriterionShape
    class: CampaignManagementAudienceCriterion
  or:
    node: CampaignManagementChannelPlacementCriterionShape
    class: CampaignManagementChannelPlacementCriterion
  or:
    node: CampaignManagementCriterionShape
    class: CampaignManagementCriterion
  or:
    node: CampaignManagementCriterionBaseShape
    class: CampaignManagementCriterionBase
  or:
    node: CampaignManagementCustomLinkedInCriterionShape
    class: CampaignManagementCustomLinkedInCriterion
  or:
    node: CampaignManagementDayTimeCriterionShape
    class: CampaignManagementDayTimeCriterion
  or:
    node: CampaignManagementDealCriterionShape
    class: CampaignManagementDealCriterion
  or:
    node: CampaignManagementDeviceCriterionShape
    class: CampaignManagementDeviceCriterion
  or:
    node: CampaignManagementGenderCriterionShape
    class: CampaignManagementGenderCriterion
  or:
    node: CampaignManagementGenreCriterionShape
    class: CampaignManagementGenreCriterion
  or:
    node: CampaignManagementHotelAdvanceBookingWindowCriterionShape
    class: CampaignManagementHotelAdvanceBookingWindowCriterion
  or:
    node: CampaignManagementHotelCheckInDateCriterionShape
    class: CampaignManagementHotelCheckInDateCriterion
  or:
    node: CampaignManagementHotelCheckInDayCriterionShape
    class: CampaignManagementHotelCheckInDayCriterion
  or:
    node: CampaignManagementHotelDateSelectionTypeCriterionShape
    class: CampaignManagementHotelDateSelectionTypeCriterion
  or:
    node: CampaignManagementHotelGroupShape
    class: CampaignManagementHotelGroup
  or:
    node: CampaignManagementHotelLengthOfStayCriterionShape
    class: CampaignManagementHotelLengthOfStayCriterion
  or:
    node: CampaignManagementLocationCriterionShape
    class: CampaignManagementLocationCriterion
  or:
    node: CampaignManagementLocationIntentCriterionShape
    class: CampaignManagementLocationIntentCriterion
  or:
    node: CampaignManagementPlacementCriterionShape
    class: CampaignManagementPlacementCriterion
  or:
    node: CampaignManagementProductPartitionShape
    class: CampaignManagementProductPartition
  or:
    node: CampaignManagementProductScopeShape
    class: CampaignManagementProductScope
  or:
    node: CampaignManagementProfileCriterionShape
    class: CampaignManagementProfileCriterion
  or:
    node: CampaignManagementRadiusCriterionShape
    class: CampaignManagementRadiusCriterion
  or:
    node: CampaignManagementStoreCriterionShape
    class: CampaignManagementStoreCriterion
  or:
    node: CampaignManagementTopicCriterionShape
    class: CampaignManagementTopicCriterion
  or:
    node: CampaignManagementWebpageShape
    class: CampaignManagementWebpage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: status
  name: status
  description: A status value that determines whether to apply the criterion to the campaign.
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the campaign criterion.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of campaign criterion. For more information, see Remarks.
  datatype: string
  max count: 1
property:
  path: criterionBid
  name: criterion bid
  or:
    node: CampaignManagementBidMultiplierShape
    class: CampaignManagementBidMultiplier
  or:
    node: CampaignManagementCriterionBidShape
    class: CampaignManagementCriterionBid
  or:
    node: CampaignManagementCriterionBidBaseShape
    class: CampaignManagementCriterionBidBase
  or:
    node: CampaignManagementFixedBidShape
    class: CampaignManagementFixedBid
  or:
    node: CampaignManagementRateBidShape
    class: CampaignManagementRateBid
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: criterionCashback
  name: criterion cashback
  or:
    node: CampaignManagementCashbackAdjustmentShape
    class: CampaignManagementCashbackAdjustment
  or:
    node: CampaignManagementCriterionCashbackShape
    class: CampaignManagementCriterionCashback
  or:
    node: CampaignManagementCriterionCashbackBaseShape
    class: CampaignManagementCriterionCashbackBase
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementAddCampaignCriterionsResponseShape
type: NodeShape
target class: CampaignManagementAddCampaignCriterionsResponse
property:
  path: campaignCriterionIds
  name: campaign criterion ids
  description: A list of unique system identifiers corresponding to the criterion that were added. The list of identifiers corresponds directly to the list of criterion in the request. Items of the list may be returned as null. For each list index where a criterion was not added, the corresponding element will be null.
  datatype: long
property:
  path: nestedPartialErrors
  name: nested partial errors
  description: An array of BatchErrorCollection objects that contain details for any criterion that were not successfully added. The top level error within each BatchErrorCollection object corresponds to potential criterion errors. The nested list of BatchError objects would include any errors specific to the list of items a criterion can have. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorCollectionShape
    class: CampaignManagementBatchErrorCollection
  or:
    node: CampaignManagementBatchErrorCollectionBaseShape
    class: CampaignManagementBatchErrorCollectionBase
  or:
    node: CampaignManagementEditorialErrorCollectionShape
    class: CampaignManagementEditorialErrorCollection
  node kind: BlankNodeOrIRI

CampaignManagementAddCampaignsRequestShape
type: NodeShape
target class: CampaignManagementAddCampaignsRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account to add the campaigns to.
  datatype: long
  max count: 1
property:
  path: campaigns
  name: campaigns
  description: The list of campaigns to add to the specified account. You can add 100 campaigns per service request.
  node: CampaignManagementCampaignShape
  class: CampaignManagementCampaign
  node kind: BlankNodeOrIRI

CampaignManagementCampaignShape
type: NodeShape
target class: CampaignManagementCampaign
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the campaign. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the campaign. The name must be unique among all active or paused campaigns within the account. The name can contain a maximum of 128 characters. The service performs a case-insensitive comparison when it compares the name to existing campaign names. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of the campaign. Possible values are Active and Paused. The service will automatically pause the campaign if the budget is depleted. With experiment campaigns you cannot set the Budget, BudgetType, or Status The budget, and status of an experiment campaign are always inherited from the base campaign settings. Add: Optional. The default value is Paused. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: BudgetPaused
  in: BudgetAndManualPaused
  in: Deleted
  in: Suspended
property:
  path: dailyBudget
  name: daily budget
  description: The amount to spend daily on the campaign. You must set the daily budget amount if BudgetId is not set. Your budget is a target; your actual spend might be higher or lower. Variations are caused by a number of factors, such as different traffic volumes in different days of the week, or automatic detection and refunding of fraud clicks that can give money back to a campaign within a few hours of the click. Microsoft Advertising anticipates and automatically compensates for the fluctuations, and usually keeps overspend to less than 100% above your daily limit. Also note that Microsoft Advertising does not require your campaign budget to be higher than the ad group and keyword bids. In other words ad group and keyword bids are validated independently of the campaign budget. In the context of shared budgets, the budget amount is a read-only property that is always returned regardless of whether or not the campaign uses a shared budget. When a campaign is associated to a shared budget the amount returned is that of the shared budget. To determine whether the campaign uses a shared budget, check the value of the BudgetId element as described above. With experiment campaigns you cannot set the Budget, BudgetType, or Status. The budget, and status of an experiment campaign are always inherited from the base campaign settings. Note: This field is currently used to set the lifetime budget amount when the budget type is set to LifetimeBudgetStandard. Add: Required if the BudgetId is not set. Read-only if the campaign uses a shared budget. Update: Optional if the BudgetId is not set. If no value is set for the update, this setting is not changed. Not allowed if the campaign uses a shared budget. If you try to update the budget amount of a campaign that has a shared budget, the service will return the CampaignServiceCannotUpdateSharedBudget error code.
  datatype: double
  max count: 1
property:
  path: budgetType
  name: budget type
  description: The budget type determines how the budget is spent. The possible values are DailyBudgetAccelerated, DailyBudgetStandard, and LifetimeBudgetStandard. Both DailyBudgetAccelerated and LifetimeBudgetStandard budget types are only available for Audience campaigns that use unshared campaign-level budgets. In the context of shared budgets, the budget type is a read-only property that is always returned regardless of whether or not the campaign uses a shared budget. To determine whether the campaign uses a shared budget, check the value of the BudgetId element as described above. With experiment campaigns you cannot set the Budget, BudgetType, or Status. The budget, and status of an experiment campaign are always inherited from the base campaign settings. Add: Required if the BudgetId is not set. Read-only if the campaign uses a shared budget. Update: Optional if the BudgetId is not set. If no value is set for the update, this setting is not changed. Not allowed if the campaign uses a shared budget. If you try to update the budget type of a campaign that has a shared budget, the service will return the CampaignServiceCannotUpdateSharedBudget error code.
  datatype: string
  max count: 1
  in: DailyBudgetAccelerated
  in: DailyBudgetStandard
  in: LifetimeBudgetStandard
property:
  path: timeZone
  name: time zone
  description: This column is deprecated. The time zone where the campaign operates. The time zone is used for reporting and applying the start and end date of an ad group. For possible values, see Time Zones. With experiment campaigns you cannot set the Budget, BudgetType, Status, or TimeZone. The budget, status, and time zone of an experiment campaign are always inherited from the base campaign settings. Add: Required Update: Optional. If no value is set for the update, this setting is not changed. You may not update the time zone if the campaign contains or has ever contained ad groups in the Active or Paused state.
  datatype: string
  max count: 1
property:
  path: settings
  name: settings
  description: The supported settings that vary by campaign type. Note: VerifiedTrackingSetting is not currently available. You can include a maximum of one object per setting type in the list of settings e.g., one TargetSetting. If the CampaignType is set to Search and if the ExperimentId element is not set, this list can optionally include a DynamicSearchAdsSetting object. Experiment campaigns and base campaigns of experiments cannot include dynamic search ads settings. If you intend to use this campaign for experiments, do not include dynamic search ads settings. If an existing experiment is already based on this campaign, you cannot update the campaign to include dynamic search ads settings. If the CampaignType is set to Shopping, this list must include a ShoppingSetting object. If the CampaignType is set to Audience, this list may or may not include a ShoppingSetting object, depending on whether or not the Audience campaign supports product ads. If the CampaignType is set to DynamicSearchAds, this list must include a DynamicSearchAdsSetting object. If the CampaignType is set to Hotel, this list must include a HotelSetting object. If the CampaignType is set to PerformanceMax, this list must include a PerformanceMaxSetting object. If the Performance Max campaign associates to a store, it also supports a ShoppingSetting. The TargetSetting can be used with any campaign type except Performace Max, and determines whether the Audience criterions associated with this campaign use the "target and bid" option or the "bid only" target option. Within the TargetSetting you can have one TargetSettingDetail objects i.e., one per supported CriterionTypeGroup. The only criterion type value currently supported for the campaign level target setting is "Audience". The TargetSetting object is not returned by default. To get this object, include the TargetSetting value in the ReturnAdditionalFields element when you call the GetCampaignsByAccountId and GetCampaignsByIds service operations. Add: Req…
  or:
    node: CampaignManagementAISearchSettingShape
    class: CampaignManagementAISearchSetting
  or:
    node: CampaignManagementAppSettingShape
    class: CampaignManagementAppSetting
  or:
    node: CampaignManagementBaseDomainSettingShape
    class: CampaignManagementBaseDomainSetting
  or:
    node: CampaignManagementCallToActionSettingShape
    class: CampaignManagementCallToActionSetting
  or:
    node: CampaignManagementCampaignFrequencyCapSettingShape
    class: CampaignManagementCampaignFrequencyCapSetting
  or:
    node: CampaignManagementCoOpSettingShape
    class: CampaignManagementCoOpSetting
  or:
    node: CampaignManagementDisclaimerSettingShape
    class: CampaignManagementDisclaimerSetting
  or:
    node: CampaignManagementDynamicFeedSettingShape
    class: CampaignManagementDynamicFeedSetting
  or:
    node: CampaignManagementDynamicSearchAdsSettingShape
    class: CampaignManagementDynamicSearchAdsSetting
  or:
    node: CampaignManagementHotelSettingShape
    class: CampaignManagementHotelSetting
  or:
    node: CampaignManagementImpressionTrackingSettingShape
    class: CampaignManagementImpressionTrackingSetting
  or:
    node: CampaignManagementNetworkDistributionSettingShape
    class: CampaignManagementNetworkDistributionSetting
  or:
    node: CampaignManagementNewCustomerAcquisitionGoalSettingShape
    class: CampaignManagementNewCustomerAcquisitionGoalSetting
  or:
    node: CampaignManagementPerformanceMaxSettingShape
    class: CampaignManagementPerformanceMaxSetting
  or:
    node: CampaignManagementReachOptimizationGoalSettingShape
    class: CampaignManagementReachOptimizationGoalSetting
  or:
    node: CampaignManagementResponsiveSearchAdsSettingShape
    class: CampaignManagementResponsiveSearchAdsSetting
  or:
    node: CampaignManagementSettingShape
    class: CampaignManagementSetting
  or:
    node: CampaignManagementSettingBaseShape
    class: CampaignManagementSettingBase
  or:
    node: CampaignManagementShoppingSettingShape
    class: CampaignManagementShoppingSetting
  or:
    node: CampaignManagementTargetSettingShape
    class: CampaignManagementTargetSetting
  or:
    node: CampaignManagementThirdPartyMeasurementSettingShape
    class: CampaignManagementThirdPartyMeasurementSetting
  or:
    node: CampaignManagementUnifiedAutomationSettingShape
    class: CampaignManagementUnifiedAutomationSetting
  or:
    node: CampaignManagementVanityPharmaSettingShape
    class: CampaignManagementVanityPharmaSetting
  or:
    node: CampaignManagementVerifiedTrackingSettingShape
    class: CampaignManagementVerifiedTrackingSetting
  node kind: BlankNodeOrIRI
property:
  path: campaignType
  name: campaign type
  description: The campaign type determines whether the campaign is an Audience, Dynamic Search Ads, Search, Shopping campaign, Hotel Ads, or Performance Max. Add: Optional. If not specified, then default value of Search is used. Update: Not allowed.
  datatype: string
  max count: 1
property:
  path: subType
  name: sub type
  description: The campaign sub type. If the sub type is not set, the campaign is created according to the campaign type. If the sub type is set to AudienceVideoAds and the campaign type is Audience, the campaign is a video audience campaign. If the sub type is set to ShoppingSmartAds, the campaign is a Microsoft Smart Shopping campaign. If the sub type is set to ShoppingSponsoredProductAd, the campaign is a Microsoft shopping campaigns for brands. Add: Optional and not applicable for most campaign types. For Microsoft smart shopping campaigns you must set the sub type to ShoppingSmartAds. For Microsoft shopping campaigns for brands you must set the sub type to ShoppingSponsoredProductAd. Update: Read-only
  datatype: string
  max count: 1
property:
  path: audienceAdsBidAdjustment
  name: audience ads bid adjustment
  description: The percent amount by which to adjust your bid for audience ads above or below the base ad group or keyword bid. This property is available in Search campaigns if the customer is enabled for the Microsoft Audience Network. This property is not available with smart shopping campaigns. Supported values are negative one hundred (-100) through positive nine hundred (900). Setting the bid adjustment to -100 will prevent audience ads from showing for this campaign. Set this element to zero (0) if you want to use the base ad group or keyword bid instead of specifying any bid adjustment for audience ads. As a best practice you should always specify a bid adjustment value. If you set this element to null the system default bid adjustment will be used. The system default bid adjustment is currently zero (0), and is subject to change. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: int
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all URLs in your campaign. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: biddingScheme
  name: bidding scheme
  description: The bid strategy type for how you want to manage your bids. For details about supported bid strategies per campaign type, see Budget and Bid Strategies. IMPORTANT: For some bid strategy types your bid and ad rotation settings are ignored and conversion tracking (via Universal Event Tracking tag and a conversion goal) is required. For more information including supported locations, see Let Microsoft Advertising manage your bids with bid strategies. This element will be nil or empty by default if the campaign uses the MaxConversionValueBiddingScheme or TargetImpressionShareBiddingScheme bid strategy. To get the MaxConversionValueBiddingScheme or TargetImpressionShareBiddingScheme objects, include the respective MaxConversionValueBiddingScheme and TargetImpressionShareBiddingScheme values in the ReturnAdditionalFields element when you call the GetCampaignsByAccountId and GetCampaignsByIds service operations. Note: Starting August 4, 2025, the BiddingScheme will no longer support TargetCpaBiddingScheme and TargetRoasBiddingScheme. Any bid strategy set to Target CPA will be silently converted to Maximize Conversions using the Target CPA value. Any bid strategy set to Target ROAS will be silently converted to Maximize Conversion Value using the Target ROAS value. Existing campaigns that use the Target CPA and Target ROAS bid strategies will remain unaffected. Add: Optional. The default bid strategy type for Search and DynamicSearchAds campaigns is EnhancedCpcBiddingScheme. The default bid strategy type for most Shopping campaigns is EnhancedCpcBiddingScheme; however, the only supported bid strategy types for smart shopping campaigns are MaxConversionsBiddingScheme and MaxConversionValueBiddingScheme. The supported bid strategy types for Audience campaigns are EnhancedCpcBiddingScheme, ManualCpcBiddingScheme, ManualCpmBiddingScheme, and TargetCpaBiddingScheme. The supported bid strategy types for lodging campaigns are CommissionBiddingScheme, ManualCpcBiddingScheme, and Pe…
  or:
    node: CampaignManagementBiddingSchemeShape
    class: CampaignManagementBiddingScheme
  or:
    node: CampaignManagementBiddingSchemeBaseShape
    class: CampaignManagementBiddingSchemeBase
  or:
    node: CampaignManagementCommissionBiddingSchemeShape
    class: CampaignManagementCommissionBiddingScheme
  or:
    node: CampaignManagementCostPerSaleBiddingSchemeShape
    class: CampaignManagementCostPerSaleBiddingScheme
  or:
    node: CampaignManagementEnhancedCpcBiddingSchemeShape
    class: CampaignManagementEnhancedCpcBiddingScheme
  or:
    node: CampaignManagementInheritFromParentBiddingSchemeShape
    class: CampaignManagementInheritFromParentBiddingScheme
  or:
    node: CampaignManagementManualCpaBiddingSchemeShape
    class: CampaignManagementManualCpaBiddingScheme
  or:
    node: CampaignManagementManualCpcBiddingSchemeShape
    class: CampaignManagementManualCpcBiddingScheme
  or:
    node: CampaignManagementManualCpmBiddingSchemeShape
    class: CampaignManagementManualCpmBiddingScheme
  or:
    node: CampaignManagementManualCpvBiddingSchemeShape
    class: CampaignManagementManualCpvBiddingScheme
  or:
    node: CampaignManagementMaxClicksBiddingSchemeShape
    class: CampaignManagementMaxClicksBiddingScheme
  or:
    node: CampaignManagementMaxConversionValueBiddingSchemeShape
    class: CampaignManagementMaxConversionValueBiddingScheme
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementAddCampaignsResponseShape
type: NodeShape
target class: CampaignManagementAddCampaignsResponse
property:
  path: campaignIds
  name: campaign ids
  description: A list of unique system identifiers corresponding to the campaigns that were added. The list of identifiers corresponds directly to the list of campaigns in the request. Items of the list may be returned as null. For each list index where a campaign was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddConversionGoalsRequestShape
type: NodeShape
target class: CampaignManagementAddConversionGoalsRequest
property:
  path: conversionGoals
  name: conversion goals
  description: The list of conversion goals to add to the account's shared conversion goal library. You can add a maximum of 100 conversion goals per service request. The account is determined by the required CustomerAccountId header element.
  or:
    node: CampaignManagementAppDownloadGoalShape
    class: CampaignManagementAppDownloadGoal
  or:
    node: CampaignManagementAppInstallGoalShape
    class: CampaignManagementAppInstallGoal
  or:
    node: CampaignManagementConversionGoalShape
    class: CampaignManagementConversionGoal
  or:
    node: CampaignManagementConversionGoalBaseShape
    class: CampaignManagementConversionGoalBase
  or:
    node: CampaignManagementDurationGoalShape
    class: CampaignManagementDurationGoal
  or:
    node: CampaignManagementEventGoalShape
    class: CampaignManagementEventGoal
  or:
    node: CampaignManagementInStoreTransactionGoalShape
    class: CampaignManagementInStoreTransactionGoal
  or:
    node: CampaignManagementOfflineConversionGoalShape
    class: CampaignManagementOfflineConversionGoal
  or:
    node: CampaignManagementPagesViewedPerVisitGoalShape
    class: CampaignManagementPagesViewedPerVisitGoal
  or:
    node: CampaignManagementUrlGoalShape
    class: CampaignManagementUrlGoal
  node kind: BlankNodeOrIRI

CampaignManagementConversionGoalShape
type: NodeShape
target class: CampaignManagementConversionGoal
property:
  path: name
  name: name
  description: The conversion goal name. The maximum length of the name is 100, and the name must be unique among all conversion goals belonging to the same customer.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Defines the possible user-determined status values of a conversion goal. These are the status values that a user can decide to set, for example a goal can be set to Paused if you no longer wish to track conversions for that goal. For status values that can be set by the system, for example whether or not the UET tag is verified, see the TrackingStatus element.
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: scope
  name: scope
  description: Determines if the goal applies to all accounts or only the account specified in the required CustomerAccountId header element. If you have multiple Microsoft Advertising accounts, you can track conversions across all of those accounts. If you associate a goal with one account, conversions will be tracked for that account only. Possible values are Account and Customer. Once you set scope, you can't change it. If you want to change the scope, you need to create a new conversion goal and pause the old one. Only the Customer scope is supported for the AppInstallGoal.
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: countType
  name: count type
  description: This determines how your conversions are recorded within your chosen conversion window. There are two choices, and if you do not set a value the default is All: - All: All conversions that happen after an ad click will be counted. This is a common choice for sales. - Unique: Only one conversion that happens after an ad click will be counted. This is a common choice for leads. For example: You track two conversions: leads and sales. You pick Unique for leads and All for sales. When one ad click turns into two leads and two sales, it's counted as three conversions: one for the unique lead, and two for all the sales. This element is not applicable for the AppInstallGoal.
  datatype: string
  max count: 1
  in: All
  in: Unique
property:
  path: revenue
  name: revenue
  description: Determines how much each conversion is worth to your business. When adding a conversion goal if you do not specify any revenue tracking preferences, then each ConversionGoalRevenue will be set to their respective default values. When updating a conversion goal, if the Revenue element is nil or empty then none of the nested properties will be updated. However, if this element is not nil or empty then you are effectively replacing any existing revenue properties. The VariableValue option is not available for the AppInstallGoal, DurationGoal, or PagesViewedPerVisitGoal.
  node: CampaignManagementConversionGoalRevenueShape
  class: CampaignManagementConversionGoalRevenue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: conversionWindowInMinutes
  name: conversion window in minutes
  description: The conversion window is the length of time in minutes after a click that you want to track conversions. If you set this value to 43200 minutes (30 days), then conversions that happen within 30 days after a click are tracked. Past conversions aren't affected. The minimum value supported is 1 minute, although keep in mind that a shorter conversion window will reduce the number of conversions your account records. The maximum value supported is 129600 minutes (90 days).
  datatype: int
  max count: 1
property:
  path: tagId
  name: tag id
  description: The unique Microsoft Advertising identifier of the UET tag that you added to your website to allow Microsoft Advertising to collect actions people take on your website. Before you take a dependency on the tag ID, please note that the UET tag can be shared with or from another customer. Shared UET tags and audiences are only available for pilot customers. For an overview of sharing audiences and UET tags in a customer hierarchy, see the Share Audiences and UET Tags technical guide. This element is not applicable for the AppInstallGoal, InStoreTransactionGoal, and OfflineConversionGoal.
  datatype: long
  max count: 1
property:
  path: trackingStatus
  name: tracking status
  description: Defines the possible system-determined status values of a conversion goal. These are the status values that can be set by the system, for example the system sets the status to TagUnverified if the UET tag has not yet been verified. For status values that a user can decide to set, for example setting the status to Paused if you no longer wish to track conversions for that goal, see the Status element. Only the NoRecentConversions and RecordingConversions statuses are applicable for the AppInstallGoal and OfflineConversionGoal.
  datatype: string
  max count: 1
  in: TagUnverified
  in: NoRecentConversions
  in: RecordingConversions
  in: TagInactive
  in: InactiveDueToTagUnavailable
property:
  path: excludeFromBidding
  name: exclude from bidding
  description: Determines whether or not to exclude data otherwise related to this conversion goal from a subset of performance report columns. This element is only available for customers who are enabled for the Include in Conversions feature (GetCustomerPilotFeatures returns 574). If this element is set to true, data otherwise related to this conversion goal will be excluded from the Conversions, ConversionRate, CostPerConversion, ReturnOnAdSpend, RevenuePerConversion, and Revenue report columns. Also, if you use an automated bidding bid strategy, setting this property true will result in the goal's conversions no longer factoring into automated bidding calculations. Setting this property "true" is effectively the same as unchecking "Include in Conversions" in the Microsoft Advertising web application. Regardless of this element value, the AllConversions, AllConversionRate, AllCostPerConversion, AllReturnOnAdSpend, AllRevenuePerConversion, and AllRevenue report columns will include data for all conversion goals. By default this element is false, and data related to this conversion goal are included in all report columns. For more information, see Report Attributes and Performance Statistics and the help article Conversion goals: "Conversions" versus "All conversions".
  datatype: boolean
  max count: 1
property:
  path: viewThroughConversionWindowInMinutes
  name: view through conversion window in minutes
  description: The view-through conversion window is the length of time in minutes after a click that you want to track view-through conversions. If you set this value to 43200 minutes (30 days), then view-through conversions that happen within 30 days after a click are tracked. Past conversions aren't affected. The minimum value supported is 1 minute, although keep in mind that a shorter conversion window will reduce the number of conversions your account records. The maximum value supported is 43200 minutes (30 days). The IncludeViewThroughConversions account property must also be set to true for view-through conversions to be tracked. This element is not returned by default. To get this element, include the ViewThroughConversionWindowInMinutes value in the ReturnAdditionalFields element when you call the GetConversionGoalsByIds and GetConversionGoalsByTagIds service operations. This element is not applicable for the AppInstallGoal, InStoreTransactionGoal, and OfflineConversionGoal.
  datatype: int
  max count: 1
property:
  path: goalCategory
  name: goal category
  description: The category used to segment the conversion goal. Categorize your conversion goals however makes sense for your business. Goal categories don't affect performance - they are here to help you segment your goals and their performance metrics. The supported category values vary by conversion goal type, so please refer to the corresponding reference page for detailed requirements.
  datatype: string
  max count: 1
  in: Unknown
  in: None
  in: Purchase
  in: AddToCart
  in: BeginCheckout
  in: Subscribe
  in: SubmitLeadForm
  in: BookAppointment
  in: Signup
  in: RequestQuote
  in: GetDirections
  in: OutboundClick
  in: Contact
  in: PageView
  in: Download
  in: Other
property:
  path: attributionModelType
  name: attribution model type
  description: Determines which attribution model, _DataDriven_, _LastTouch_ or _LastClick_, is used with a conversion goal. This element is not returned by default. To get this element, include the AttributionModelType value in the ReturnAdditionalFields element when you call the GetConversionGoalsByIds and GetConversionGoalsByTagIds service operations. This element is not applicable for the AppInstallGoal, InStoreTransactionGoal, and OfflineConversionGoal.
  datatype: string
  max count: 1
  in: LastClick
  in: LastTouch
  in: DataDriven
property:
  path: isEnhancedConversionsEnabled
  name: is enhanced conversions enabled
  description: Determines whether enhanced conversions are enabled for a conversion goal.
  datatype: boolean
  max count: 1
property:
  path: isAutoGoal
  name: is auto goal
  description: Determines whether a conversion goal is a simplified conversion goal. Only the EventGoal type is supported.
  datatype: boolean
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the conversion goal.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the conversion goal. For more information about conversion goal types, see the Remarks.
  datatype: string
  max count: 1
property:
  path: urlOperator
  name: url operator
  datatype: string
  max count: 1
  in: Equals
  in: BeginsWith
  in: RegularExpression
  in: Contains
property:
  path: urlExpression
  name: url expression
  datatype: string
  max count: 1
property:
  path: minimumDurationInSeconds
  name: minimum duration in seconds
  datatype: int
  max count: 1
property:
  path: minimumPagesViewed
  name: minimum pages viewed
  datatype: int
  max count: 1
property:
  path: categoryExpression
  name: category expression
  datatype: string
  max count: 1
property:
  path: categoryOperator
  name: category operator
  datatype: string
  max count: 1
  in: Equals
  in: BeginsWith
  in: RegularExpression
  in: Contains
property:
  path: actionExpression
  name: action expression
  datatype: string
  max count: 1
property:
  path: actionOperator
  name: action operator
  datatype: string
  max count: 1
  in: Equals
  in: BeginsWith
  in: RegularExpression
  in: Contains
property:
  path: labelExpression
  name: label expression
  datatype: string
  max count: 1
property:
  path: labelOperator
  name: label operator
  datatype: string
  max count: 1
  in: Equals
  in: BeginsWith
  in: RegularExpression
  in: Contains
property:
  path: valueOperator
  name: value operator
  datatype: string
  max count: 1
  in: Equals
  in: LessThan
  in: GreaterThan

CampaignManagementConversionGoalRevenueShape
type: NodeShape
target class: CampaignManagementConversionGoalRevenue
property:
  path: type
  name: type
  description: Determines how revenue is tracked. The possible types are FixedValue, NoValue (the default type), and VariableValue. If the type is FixedValue then you must specify the Value element. If the type is NoValue then you must not specify the Value element. If the type is VariableValue then you can optionally specify a default value with the Value element. Add: Optional. If not specified, the default type is NoValue. Update: Optional. If not specified, the default type is NoValue.
  datatype: string
  max count: 1
  in: FixedValue
  in: VariableValue
  in: NoValue
property:
  path: value
  name: value
  description: The revenue value or amount. If you assign values to your conversions, you'll be able to see the total value driven by your advertising across different conversions, rather than simply the number of conversions that have happened. The default value is effectively 0, and possible values range from 0 to 999,9999. Accepted values depend on the revenue type, so please see the Type element for details. For the OfflineConversionGoal, the ConversionValue element of the applied OfflineConversion data takes precedence over this currency value. Add: Optional. If not specified, the default type is effectively 0. Update: Optional. If not specified, the default type is effectively 0.
  datatype: double
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: The currency type that you want the conversion goal revenue to be reported. For a list of possible string values see Microsoft Advertising Currencies. For the EventGoal, InStoreTransactionGoal, OfflineConversionGoal, and UrlGoal objects, if their Scope element is set to Customer and if the Type is FixedValue or VariableValue, this property is required. For the OfflineConversionGoal, the ConversionCurrencyCode element of the applied OfflineConversion data takes precedence over this currency code. For the other supported conversion goals if you modify your UET tag tracking code to pass back both a revenue value and a currency, then the UET tag currency value takes precedence over this currency code. For more information on modifying your UET tag tracking code for variable revenue reporting, see How to report variable revenue with UET. If the Scope element of any ConversionGoal is set to Account and you do not specify the CurrencyCode, then by default the account level billing currency will be used to report conversion goal revenue. This element is not available for the AppInstallGoal, DurationGoal, or PagesViewedPerVisitGoal. You cannot set this property for those goal types. Add: Optional unless otherwise noted above. Update: Optional unless otherwise noted above.
  datatype: string
  max count: 1

CampaignManagementAddConversionGoalsResponseShape
type: NodeShape
target class: CampaignManagementAddConversionGoalsResponse
property:
  path: conversionGoalIds
  name: conversion goal ids
  description: A list of unique system identifiers corresponding to the conversion goals that were added. The list of identifiers corresponds directly to the list of conversion goals in the request. Items of the list may be returned as null. For each list index where a conversion goal was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddConversionValueRulesRequestShape
type: NodeShape
target class: CampaignManagementAddConversionValueRulesRequest
property:
  path: conversionValueRules
  name: conversion value rules
  description: The conversion value rules to be created.
  node: CampaignManagementConversionValueRuleShape
  class: CampaignManagementConversionValueRule
  node kind: BlankNodeOrIRI
property:
  path: lcid
  name: lcid
  description: The locale identifier (LCID) for the request. The default value is 1033 for EnglishUS. For more LCID values, see LCID Value Set.
  datatype: int
  max count: 1

CampaignManagementConversionValueRuleShape
type: NodeShape
target class: CampaignManagementConversionValueRule
property:
  path: name
  name: name
  description: The name of the conversion value rule.
  datatype: string
  max count: 1
property:
  path: locationCondition
  name: location condition
  description: The location condition associated with the conversion value rule. Each conversion value rule can have up to 2 conditions.
  node: CampaignManagementLocationConditionShape
  class: CampaignManagementLocationCondition
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: audienceCondition
  name: audience condition
  description: The audience condition associated with the conversion value rule. Each conversion value rule can have up to 2 conditions.
  node: CampaignManagementAudienceConditionShape
  class: CampaignManagementAudienceCondition
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: deviceCondition
  name: device condition
  description: The device condition associated with the conversion value rule. Each conversion value rule can have up to 2 conditions.
  node: CampaignManagementDeviceConditionShape
  class: CampaignManagementDeviceCondition
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: value
  name: value
  description: The value of the conversion value rule. It should be greater than 0. Add: Required Update: Optional
  datatype: double
  max count: 1
property:
  path: operation
  name: operation
  description: The operation type of the conversion value rule.
  datatype: string
  max count: 1
  in: Add
  in: Multiply
property:
  path: currencyCode
  name: currency code
  description: The currency code for the conversion value rule.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of the conversion value rule.
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
  in: Invalid
property:
  path: id
  name: id
  description: The unique identifier of the conversion value rule. Add: Optional Update: Required
  datatype: long
  max count: 1

CampaignManagementLocationConditionShape
type: NodeShape
target class: CampaignManagementLocationCondition
property:
  path: includedLocations
  name: included locations
  description: The locations included in the condition.
  node: CampaignManagementLocationConditionItemShape
  class: CampaignManagementLocationConditionItem
  node kind: BlankNodeOrIRI
property:
  path: excludedLocations
  name: excluded locations
  description: The locations excluded from the condition.
  node: CampaignManagementLocationConditionItemShape
  class: CampaignManagementLocationConditionItem
  node kind: BlankNodeOrIRI
property:
  path: includedLocationIntent
  name: included location intent
  description: The intent option for included locations.
  datatype: string
  max count: 1
  in: PeopleInOrSearchingForOrViewingPages
  in: PeopleIn
  in: PeopleSearchingForOrViewingPages
property:
  path: excludedLocationIntent
  name: excluded location intent
  description: The intent option for excluded locations.
  datatype: string
  max count: 1
  in: PeopleInOrSearchingForOrViewingPages
  in: PeopleIn
  in: PeopleSearchingForOrViewingPages
property:
  path: isPrimary
  name: is primary
  description: Indicates if this is the primary condition. Only 1 primary condition is allowed in a conversion value rule.
  datatype: boolean
  max count: 1

CampaignManagementLocationConditionItemShape
type: NodeShape
target class: CampaignManagementLocationConditionItem
property:
  path: id
  name: id
  description: The unique identifier of the location condition item. Required.
  datatype: int
  max count: 1
property:
  path: name
  name: name
  description: The name of the location condition item.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the location condition item. Required.
  datatype: string
  max count: 1
  in: Country
  in: SubGeography
  in: MetroArea
  in: City
  in: PostalCode
  in: County
  in: Neighborhood

CampaignManagementAudienceConditionShape
type: NodeShape
target class: CampaignManagementAudienceCondition
property:
  path: audiences
  name: audiences
  description: The audiences included in the condition.
  node: CampaignManagementAudienceConditionItemShape
  class: CampaignManagementAudienceConditionItem
  node kind: BlankNodeOrIRI
property:
  path: isPrimary
  name: is primary
  description: Indicates if this is the primary condition. Only 1 primary condition is allowed in a conversion value rule.
  datatype: boolean
  max count: 1

CampaignManagementAudienceConditionItemShape
type: NodeShape
target class: CampaignManagementAudienceConditionItem
property:
  path: id
  name: id
  description: The unique identifier of the audience condition item. Required.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the audience condition item.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the audience condition item. Required.
  datatype: string
  max count: 1

CampaignManagementDeviceConditionShape
type: NodeShape
target class: CampaignManagementDeviceCondition
property:
  path: deviceTypes
  name: device types
  description: The device types included in the condition.
  datatype: string
  max count: 1
property:
  path: isPrimary
  name: is primary
  description: Indicates if this is the primary condition. Only 1 primary condition is allowed in a conversion value rule.
  datatype: boolean
  max count: 1

CampaignManagementAddConversionValueRulesResponseShape
type: NodeShape
target class: CampaignManagementAddConversionValueRulesResponse
property:
  path: conversionValueRuleIds
  name: conversion value rule ids
  description: The IDs of the conversion value rules that were successfully created.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddDataExclusionsRequestShape
type: NodeShape
target class: CampaignManagementAddDataExclusionsRequest
property:
  path: accountId
  name: account id
  description: The account ID.
  datatype: long
  max count: 1
property:
  path: dataExclusions
  name: data exclusions
  description: The data exclusions to add.
  node: CampaignManagementDataExclusionShape
  class: CampaignManagementDataExclusion
  node kind: BlankNodeOrIRI

CampaignManagementDataExclusionShape
type: NodeShape
target class: CampaignManagementDataExclusion
property:
  path: id
  name: id
  description: The data exclusion ID.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The data exclusion name.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: A description for the data exclusion.
  datatype: string
  max count: 1
property:
  path: startDate
  name: start date
  description: The start date. Important: The value must be in your account time zone. This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.
  datatype: dateTime
  max count: 1
property:
  path: endDate
  name: end date
  description: The end date. Important: The value must be in your account time zone. This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.
  datatype: dateTime
  max count: 1
property:
  path: deviceTypeFilter
  name: device type filter
  description: Which devices types to include for the data exclusion.
  datatype: string
  max count: 1
property:
  path: campaignTypeFilter
  name: campaign type filter
  description: Which campaign types to include for the data exclusion.
  datatype: string
  max count: 1
property:
  path: campaignAssociations
  name: campaign associations
  description: Which campaigns to include for the data exclusion.
  node: CampaignManagementCampaignAssociationShape
  class: CampaignManagementCampaignAssociation
  node kind: BlankNodeOrIRI

CampaignManagementCampaignAssociationShape
type: NodeShape
target class: CampaignManagementCampaignAssociation
property:
  path: campaignId
  name: campaign id
  description: The campaign ID.
  datatype: long
  max count: 1

CampaignManagementAddDataExclusionsResponseShape
type: NodeShape
target class: CampaignManagementAddDataExclusionsResponse
property:
  path: dataExclusionIds
  name: data exclusion ids
  description: The data exclusion IDs.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddExperimentsRequestShape
type: NodeShape
target class: CampaignManagementAddExperimentsRequest
property:
  path: experiments
  name: experiments
  description: The list of experiments to add. You can add 100 experiments per service request. You can create up to 10 nonconcurrent experiments per base campaign, whether they are added at the same time or across multiple service requests. Each base campaign must be in the same account, and the account is determined by the required CustomerAccountId header element.
  node: CampaignManagementExperimentShape
  class: CampaignManagementExperiment
  node kind: BlankNodeOrIRI

CampaignManagementExperimentShape
type: NodeShape
target class: CampaignManagementExperiment
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the experiment. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the experiment. The name of the experiment campaign that is created from the base campaign will match the experiment name, and vice versa. If the experiment name is updated, the experiment campaign's name will automatically be updated to match, and vice versa. The name must be unique (case-insensitive) among all campaigns and experiments within the account. The name can contain a maximum of 128 characters. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: baseCampaignId
  name: base campaign id
  description: The Microsoft Advertising identifier of the campaign used as the base for the experiment campaign. You can create up to 10 nonconcurrent experiments per base campaign. In other words multiple experiments for the same base campaign cannot have overlapping time intervals. Experiments are available for Audience, Search, Shopping, and Performance Max campaigns. If the campaign uses a shared budget, then you cannot use it as the base campaign for an experiment. Add: Read-only and Required. Update: Read-only. You cannot change the base campaign of an experiment.
  datatype: long
  max count: 1
property:
  path: experimentCampaignId
  name: experiment campaign id
  description: The Microsoft Advertising identifier of the campaign that is created as a copy of the base campaign. All base campaign settings, including ad groups, ads, ad extension associations, and target settings are copied to the new experiment campaign. After the experiment campaign is created you can update all of its settings except for the campaign Budget, BudgetType, and TimeZone. The budget and time zone of an experiment campaign are always inherited from the base campaign settings. Add: Read-only Update: Read-only
  datatype: long
  max count: 1
property:
  path: trafficSplitPercent
  name: traffic split percent
  description: The percentage of the base campaign's budget and ad traffic that you want to allocate for this experiment. Ad traffic is split between the experiment and the base campaign based on individual searches. Relevant searches will randomly bring up either ads from your experiment or ads from your base campaign. This means that individual customers could see ads from both sources if they search multiple times. Possible values range from 1 to 99. Add: Required Update: Read-only. You cannot change the split while an experiment is running.
  datatype: int
  max count: 1
property:
  path: experimentArms
  name: experiment arms
  description: Defines an array of the experiment arm data object.
  node: CampaignManagementExperimentArmShape
  class: CampaignManagementExperimentArm
  node kind: BlankNodeOrIRI
property:
  path: startDate
  name: start date
  description: The date that the experiment campaign can begin serving ads. The start date cannot be updated after the experiment has begun i.e., once the start date has arrived. The start date is inclusive. For example, if you set start date to 5/5/2020, the experiment will start at 12:00 AM on 5/5/2020. The time is relative to the base campaign time zone. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  node: CampaignManagementDateShape
  class: CampaignManagementDate
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: The date that the experiment will expire. If you do not specify an end date, the ads will not expire. Once the end date has passed, the end date cannot be extended. The end date is inclusive. For example, if you set the end date to 12/31/2020, the experiment will end at 11:59 PM on 12/31/2020. The time is relative to the base campaign time zone. Add: Optional. If you leave this element nil or empty the experiment will not expire until you take further action e.g., set the experiment status to Ended. Update: Optional. If no value is set for the update, this setting is not changed. To delete the current end date and effectively set no end date, set the Day, Month, and Year each to '0' (zero). When you retrieve the experiment next time, this element will not be set.
  node: CampaignManagementDateShape
  class: CampaignManagementDate
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: experimentStatus
  name: experiment status
  description: The status of the experiment. Possible status values are described in the remarks below. Add: Required. You must set the status to Active; however, the status will be set automatically by Microsoft Advertising to Creating, and the next time you retrieve the experiment its status will be either Active, Creating, CreationFailed, Paused, or Scheduled. Update: Read-only
  datatype: string
  max count: 1
property:
  path: experimentType
  name: experiment type
  description: Determines whether to show individual customers ads from the experiment and the original campaign randomly, or only from one or the other. The possible values include TrafficBased and CookieBased. TrafficBased: This is also known as the search-based option. Every time customers search, they are randomly shown either ads from your experiment or ads from your original campaign. This means that individual customers could see ads from both sources if they search multiple times. CookieBased: When individual customers search, we show ads from either your experiment or your original campaign, and use a cookie to ensure that, going forward, they will only see ads from this source. The cookie-based option has an important trade-off to consider: On one hand, you may get more accurate data, since you're ensuring that an individual customer is only responding to one source or the other. On the other hand, it may take you longer to build up statistically significant comparison data than with the search-based option. Add: Optional. The default is TrafficBased. Update: Read-only. You cannot update the experiment type.
  datatype: string
  max count: 1
property:
  path: experimentSubType
  name: experiment sub type
  description: The experiment sub type.
  datatype: string
  max count: 1

CampaignManagementExperimentArmShape
type: NodeShape
target class: CampaignManagementExperimentArm
property:
  path: id
  name: id
  description: The experiment arm ID.
  datatype: long
  max count: 1
property:
  path: campaignIds
  name: campaign ids
  description: The campaign IDs.
  datatype: long
property:
  path: trafficSplit
  name: traffic split
  description: The traffic split number.
  datatype: int
  max count: 1
property:
  path: isControlArm
  name: is control arm
  description: The experiment arm is a control arm.
  datatype: boolean
  max count: 1

CampaignManagementAddExperimentsResponseShape
type: NodeShape
target class: CampaignManagementAddExperimentsResponse
property:
  path: experimentIds
  name: experiment ids
  description: A list of unique system identifiers corresponding to the experiments that were added. The list of identifiers corresponds directly to the list of experiments in the request. Items of the list may be returned as null. For each list index where an experiment was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddHTML5sRequestShape
type: NodeShape
target class: CampaignManagementAddHTML5sRequest
property:
  path: hTML5Assets
  name: h tml5assets
  description: Array of HTML5 assets to add to the specified campaign.
  node: CampaignManagementHTML5Shape
  class: CampaignManagementHTML5
  node kind: BlankNodeOrIRI

CampaignManagementHTML5Shape
type: NodeShape
target class: CampaignManagementHTML5
property:
  path: name
  name: name
  description: The name of the HTML5 asset.
  datatype: string
  max count: 1
property:
  path: url
  name: url
  description: The URL of the HTML5 asset.
  datatype: string
  max count: 1
property:
  path: text
  name: text
  description: Descriptive text for the HTML5 asset.
  datatype: string
  max count: 1
property:
  path: destinationUrl
  name: destination url
  description: The URL of the webpage that the user is taken to when they click the ad.
  datatype: string
  max count: 1
property:
  path: thumbnailUrl
  name: thumbnail url
  description: The URL of the thumbnail used for the HTML5 asset.
  datatype: string
  max count: 1
property:
  path: width
  name: width
  description: The width of the HTML5 asset.
  datatype: int
  max count: 1
property:
  path: height
  name: height
  description: The height of the HTML5 asset.
  datatype: int
  max count: 1
property:
  path: status
  name: status
  description: The status of the HTML5 asset.
  datatype: string
  max count: 1
property:
  path: createdDateTimeInUTC
  name: created date time in utc
  description: The date and time the HTML5 asset was created in UTC.
  datatype: dateTime
  max count: 1
property:
  path: modifiedDateTimeInUTC
  name: modified date time in utc
  description: The date and time the HTML5 asset was modified in UTC.
  datatype: dateTime
  max count: 1
property:
  path: failureCode
  name: failure code
  description: A descriptive error code for any issues with the HTML5 asset.
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: The HTML5 asset's ID.
  datatype: long
  max count: 1

https://relay.inferal.com/ontology/microsoftads/CampaignManagementAddHTML5sResponseShape
type: NodeShape
target class: CampaignManagementAddHTML5sResponse
property:
  path: hTML5AssetIds
  name: h tml5asset ids
  description: The HTML5 asset IDs.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that weren't successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddImportJobsRequestShape
type: NodeShape
target class: CampaignManagementAddImportJobsRequest
property:
  path: importJobs
  name: import jobs
  description: The import jobs to create. Although this element is an array, you can include a maximum of one GoogleImportJob object per call. You can set the Google account that you want to import from via the GoogleAccountId element in the GoogleImportJob object. The Microsoft Advertising ad account that you want to import to is determined by the required CustomerAccountId header element of this AddImportJobs service operation.
  or:
    node: CampaignManagementFileImportJobShape
    class: CampaignManagementFileImportJob
  or:
    node: CampaignManagementGoogleImportJobShape
    class: CampaignManagementGoogleImportJob
  or:
    node: CampaignManagementImportJobShape
    class: CampaignManagementImportJob
  or:
    node: CampaignManagementImportJobBaseShape
    class: CampaignManagementImportJobBase
  node kind: BlankNodeOrIRI

CampaignManagementImportJobShape
type: NodeShape
target class: CampaignManagementImportJob
property:
  path: name
  name: name
  description: The name of the import job
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the import job.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the import job. For more information about import job types, see the Remarks.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of the import job. The possible values are Active, Pause and Deleted. Scheduled imports will have an Active status, whether the job is scheduled once or on a recurring basis in the future. Paused import jobs will have a Pause status. The status of import jobs that only run once will be set to Deleted after the import. Add: Read-only Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: notificationType
  name: notification type
  description: Determines whether and how often you want to receive email notifications about the import job results.
  datatype: string
  max count: 1
property:
  path: createdByUserId
  name: created by user id
  description: The unique identifier of the Microsoft Advertising user who created the import job.
  datatype: long
  max count: 1
property:
  path: createdByUserName
  name: created by user name
  description: The login user name of the Microsoft Advertising user who created the import job.
  datatype: string
  max count: 1
property:
  path: frequency
  name: frequency
  description: Determines whether the import job should be run once or scheduled on a recurring basis. To run the import job now, this element should be nil or empty.
  node: CampaignManagementFrequencyShape
  class: CampaignManagementFrequency
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: lastRunTimeInUTC
  name: last run time in utc
  description: The most recent import date and time for this job. The date and time is expressed in Coordinated Universal Time (UTC).
  datatype: dateTime
  max count: 1
property:
  path: createdDateTimeInUTC
  name: created date time in utc
  description: The date and time when the import job was created. The date and time is expressed in Coordinated Universal Time (UTC).
  datatype: dateTime
  max count: 1
property:
  path: importOption
  name: import option
  description: The import options that are available via API.
  or:
    node: CampaignManagementFileImportOptionShape
    class: CampaignManagementFileImportOption
  or:
    node: CampaignManagementGoogleImportOptionShape
    class: CampaignManagementGoogleImportOption
  or:
    node: CampaignManagementImportOptionShape
    class: CampaignManagementImportOption
  or:
    node: CampaignManagementImportOptionBaseShape
    class: CampaignManagementImportOptionBase
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: notificationEmail
  name: notification email
  description: The email address where import results should be sent. This element is not returned by default. To get this element, include the NotificationEmail value in the ReturnAdditionalFields element when you call the GetImportJobsByIds and GetImportResults service operations.
  datatype: string
  max count: 1
property:
  path: credentialId
  name: credential id
  datatype: string
  max count: 1
property:
  path: googleAccountId
  name: google account id
  datatype: long
  max count: 1
property:
  path: campaignAdGroupIds
  name: campaign ad group ids
  node: CampaignManagementCampaignAdGroupIdsShape
  class: CampaignManagementCampaignAdGroupIds
  node kind: BlankNodeOrIRI
property:
  path: campaignTypes
  name: campaign types
  datatype: string
property:
  path: googleUserName
  name: google user name
  datatype: string
  max count: 1
property:
  path: fileUrl
  name: file url
  datatype: string
  max count: 1
property:
  path: fileSource
  name: file source
  datatype: string
  max count: 1

CampaignManagementFrequencyShape
type: NodeShape
target class: CampaignManagementFrequency
property:
  path: type
  name: type
  description: The scheduling frequency type. Set this element to "Scheduling" if you want to choose a specific Cron value, whether the import job should run once or on a recurring basis. Set this element to "Auto" if you want Microsoft Advertising to run imports on a varying schedule that will best optimize your campaigns. If you want the import to run now, you can either set this element to "RunNow" or do not set the Google import job Frequency element at all. Add: Required
  datatype: string
  max count: 1
property:
  path: timeZone
  name: time zone
  description: The time zone used for the import schedule. For possible values, see Time Zones. Add: Optional. If you do not set this element, then "GreenwichMeanTimeDublinEdinburghLisbonLondon" (UTC+0) will be used by default.
  datatype: string
  max count: 1
property:
  path: cron
  name: cron
  description: Represents a simplified implementation of Cron frequency. For example, set the string to "0 16 3 *" if you want the import to run weekly, every Wednesday at 4:00 PM. For details about supported frequency values, see the Remarks. Add: Required if the Type is set to "Scheduling", and otherwise the cron value is ignored.
  datatype: string
  max count: 1

CampaignManagementImportOptionShape
type: NodeShape
target class: CampaignManagementImportOption
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  description: The type of import option. For more information, see Remarks.
  datatype: string
  max count: 1
property:
  path: newEntities
  name: new entities
  datatype: boolean
  max count: 1
property:
  path: newPausedCampaignsAndChildEntities
  name: new paused campaigns and child entities
  datatype: boolean
  max count: 1
property:
  path: newActiveCampaignsAndChildEntities
  name: new active campaigns and child entities
  datatype: boolean
  max count: 1
property:
  path: newAdGroupsAndChildEntitiesForExistingCampaigns
  name: new ad groups and child entities for existing campaigns
  datatype: boolean
  max count: 1
property:
  path: newActiveAdsForExistingAdGroups
  name: new active ads for existing ad groups
  datatype: boolean
  max count: 1
property:
  path: newKeywordsForExistingAdGroups
  name: new keywords for existing ad groups
  datatype: boolean
  max count: 1
property:
  path: newNegativeKeywordsForExistingParents
  name: new negative keywords for existing parents
  datatype: boolean
  max count: 1
property:
  path: newNegativeKeywordLists
  name: new negative keyword lists
  datatype: boolean
  max count: 1
property:
  path: newAccountNegativeKeywords
  name: new account negative keywords
  datatype: boolean
  max count: 1
property:
  path: pauseNewCampaigns
  name: pause new campaigns
  datatype: boolean
  max count: 1
property:
  path: newKeywordUrls
  name: new keyword urls
  datatype: boolean
  max count: 1
property:
  path: newUrlOptions
  name: new url options
  datatype: boolean
  max count: 1
property:
  path: newNegativeSites
  name: new negative sites
  datatype: boolean
  max count: 1
property:
  path: newPausedAdsForExistingAdGroups
  name: new paused ads for existing ad groups
  datatype: boolean
  max count: 1
property:
  path: newLabels
  name: new labels
  datatype: boolean
  max count: 1
property:
  path: newProductFilters
  name: new product filters
  datatype: boolean
  max count: 1
property:
  path: newLocationTargets
  name: new location targets
  datatype: boolean
  max count: 1
property:
  path: newAdSchedules
  name: new ad schedules
  datatype: boolean
  max count: 1
property:
  path: newDeviceTargets
  name: new device targets
  datatype: boolean
  max count: 1
property:
  path: newDemographicTargets
  name: new demographic targets
  datatype: boolean
  max count: 1
property:
  path: newAudienceTargets
  name: new audience targets
  datatype: boolean
  max count: 1
property:
  path: newTopicTargets
  name: new topic targets
  datatype: boolean
  max count: 1
property:
  path: newAppAdExtensions
  name: new app ad extensions
  datatype: boolean
  max count: 1
property:
  path: newCallAdExtensions
  name: new call ad extensions
  datatype: boolean
  max count: 1
property:
  path: newCalloutAdExtensions
  name: new callout ad extensions
  datatype: boolean
  max count: 1
property:
  path: newPriceAdExtensions
  name: new price ad extensions
  datatype: boolean
  max count: 1
property:
  path: newLocationAdExtensions
  name: new location ad extensions
  datatype: boolean
  max count: 1
property:
  path: newReviewAdExtensions
  name: new review ad extensions
  datatype: boolean
  max count: 1
property:
  path: newSitelinkAdExtensions
  name: new sitelink ad extensions
  datatype: boolean
  max count: 1
property:
  path: newStructuredSnippetAdExtensions
  name: new structured snippet ad extensions
  datatype: boolean
  max count: 1
property:
  path: newPromotionAdExtensions
  name: new promotion ad extensions
  datatype: boolean
  max count: 1
property:
  path: newImageAdExtensions
  name: new image ad extensions
  datatype: boolean
  max count: 1
property:
  path: newLogoAdExtensions
  name: new logo ad extensions
  datatype: boolean
  max count: 1
property:
  path: newLeadFormAdExtensions
  name: new lead form ad extensions
  datatype: boolean
  max count: 1
property:
  path: newPageFeeds
  name: new page feeds
  datatype: boolean
  max count: 1
property:
  path: newAdCustomizerFeeds
  name: new ad customizer feeds
  datatype: boolean
  max count: 1
property:
  path: newBrandSuitability
  name: new brand suitability
  datatype: boolean
  max count: 1

CampaignManagementImportSearchAndReplaceForStringPropertyShape
type: NodeShape
target class: CampaignManagementImportSearchAndReplaceForStringProperty
property:
  path: searchString
  name: search string
  description: The string to find. The case-insensitive search string does not support regular expressions.
  datatype: string
  max count: 1
property:
  path: replaceString
  name: replace string
  description: The replacement string to use in place of the search string.
  datatype: string
  max count: 1

CampaignManagementCampaignAdGroupIdsShape
type: NodeShape
target class: CampaignManagementCampaignAdGroupIds
property:
  path: campaignId
  name: campaign id
  description: Identifies the campaign to import.
  datatype: long
  max count: 1
property:
  path: adGroupIds
  name: ad group ids
  description: Identifies the list of specific ad groups to import within the campaign. If this element is nil or empty, include all ad groups of the campaign. The ActiveAdGroupsOnly element determines whether to include paused ad groups or only import active ad groups.
  datatype: long
property:
  path: activeAdGroupsOnly
  name: active ad groups only
  description: Determines whether to include paused ad groups or only import active ad groups. This element is not returned by default. To get this element, include the ActiveAdGroupsOnly value in the ReturnAdditionalFields element when you call the GetImportJobsByIds and GetImportResults service operations. If this element is true and if the AdGroupIds is not set, then only active ad groups from the campaign will be imported. Paused ad groups will not be imported. If this element is false or empty, then all of the campaign's ad groups will be imported. This element is ignored if specific ad groups are selected in the AdGroupIds element.
  datatype: boolean
  max count: 1

CampaignManagementAddImportJobsResponseShape
type: NodeShape
target class: CampaignManagementAddImportJobsResponse
property:
  path: importJobIds
  name: import job ids
  description: A list of unique system identifiers corresponding to the import jobs that were added. The list of identifiers corresponds directly to the list of import jobs in the request. Items of the list may be returned as null. For each list index where an import job was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: A list of BatchError objects that contain details for any list item requests that were not successful. The list of errors do not correspond directly to the list of items in the request. The list will be empty if there were no errors.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddKeywordsRequestShape
type: NodeShape
target class: CampaignManagementAddKeywordsRequest
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group to add the keywords to.
  datatype: long
  max count: 1
property:
  path: keywords
  name: keywords
  description: The list of keywords to add to the ad group. You can add a maximum of 1,000 keywords to an ad group per service request.
  node: CampaignManagementKeywordShape
  class: CampaignManagementKeyword
  node kind: BlankNodeOrIRI
property:
  path: returnInheritedBidStrategyTypes
  name: return inherited bid strategy types
  description: Determines whether or not the service should return the bid strategy type that is inherited from the parent campaign or ad group. The default value is false, and the InheritedBidStrategyTypes element will only be returned if you set this element true.
  datatype: boolean
  max count: 1
property:
  path: assetGroupId
  name: asset group id
  description: The identifier of the asset group to add the keywords to.
  datatype: long
  max count: 1

CampaignManagementKeywordShape
type: NodeShape
target class: CampaignManagementKeyword
property:
  path: id
  name: id
  description: The system-generated identifier of the keyword. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: bid
  name: bid
  description: The maximum amount that you want to pay each time someone clicks your ad. You bid against other advertisers using the same keyword, so in general, higher bids help get your ad to display in more desirable locations on the search results page. Instead of using the default ad group level bid, you can set custom bids for each keyword. Custom bids for keywords override the ad group default bid for those specific keywords. With custom bids, you can focus your time and money on the most profitable keywords but will need to spend more time on managing the individual bids. If the keyword level bid is not set, the Ad Group CpcBid is used. For more information, see Budget and Bid Strategies. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. To delete the keyword bid and use the AdGroup default match type bid, set the Amount element of the Bid object to null.
  node: CampaignManagementBidShape
  class: CampaignManagementBid
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: matchType
  name: match type
  description: The type of match to compare the keyword and the user's search term. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Exact
  in: Phrase
  in: Broad
property:
  path: param1
  name: param1
  description: The string to use as the substitution value in an ad if the ad's title, text, display URL, or destination URL contains the {Param1} dynamic substitution string. Although you can use {Param1} to specify an ad's destination URL, you are encouraged not to. Instead, you should set the keyword's DestinationUrl element. The string can contain a maximum of 1,022 characters. The actual limit depends on the length of the element that references the substitution string. For example, the length of a text ad's title can contain a maximum of 25 characters. When implementing dynamic text in your ad copy you should provide a default string e.g. {Param1:default} that the system will use if Param1 for a keyword is null or empty, or if including the Param1 substitution value will cause the expanded string to exceed the element's limit; otherwise the ad will not serve with this keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. Also note that if the ad group only has one ad, and if that ad uses {Param1} but does not provide a default string e.g. {Param1:default}, then you must supply a valid Param1 value for that substitution. Otherwise this keyword cannot be added or updated. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: param2
  name: param2
  description: The string to use as the substitution value in an ad if the title, text, display URL, or destination URL contains the {Param2} dynamic substitution string. Typically, you use the {Param2} substitution string in the title or text (ad copy description) elements of an ad. The string can contain a maximum of 70 characters. The actual limit depends on the length of the element that references the substitution string. For example, the length of a text ad's title can contain a maximum of 25 characters. When implementing dynamic text in your ad copy you should provide a default string e.g. {Param2:default} that the system will use if Param2 for a keyword is null or empty, or if including the Param2 substitution value will cause the expanded string to exceed the element's limit; otherwise the ad will not serve with this keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. Also note that if the ad group only has one ad, and if that ad uses {Param2} but does not provide a default string e.g. {Param2:default}, then you must supply a valid Param2 value for that substitution. Otherwise this keyword cannot be added or updated. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: param3
  name: param3
  description: The string to use as the substitution value in an ad if the title, text, display URL, or destination URL contains the {Param3} dynamic substitution string. Typically, you use the {Param3} substitution string in the title or text (ad copy description) elements of an ad. The string can contain a maximum of 70 characters. The actual limit depends on the length of the element that references the substitution string. For example, the length of a text ad's title can contain a maximum of 25 characters. When implementing dynamic text in your ad copy you should provide a default string e.g. {Param3:default} that the system will use if Param3 for a keyword is null or empty, or if including the Param3 substitution value will cause the expanded string to exceed the element's limit; otherwise the ad will not serve with this keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. Also note that if the ad group only has one ad, and if that ad uses {Param3} but does not provide a default string e.g. {Param3:default}, then you must supply a valid Param3 value for that substitution. Otherwise this keyword cannot be added or updated. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: text
  name: text
  description: The keyword text. The text can contain a maximum of 100 characters. You should specify the keyword in the locale of the Language value that you specified for the ad group to which the keyword belongs. Add: Required Update: Read-only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The keyword's status. By default, the status is set to Active. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
  in: Inactive
property:
  path: editorialStatus
  name: editorial status
  description: The editorial review status of the keyword, which indicates whether the keyword is pending review, has been approved, or has been disapproved. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: destinationUrl
  name: destination url
  description: The URL of the webpage to take the user to when they click the ad. The keyword's destination URL is used if specified; otherwise, the ad's destination URL is used. Important: As of November 2018 the keyword destination URL cannot be added or updated. You can use Final URLs instead. For more details see Migrating your keyword destination URLs to final URLs. Add: Not allowed Update: Not allowed
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all FinalUrls and FinalMobileUrls. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: The landing page URL. The keyword's final URL is used if specified; otherwise, the ad's final URL is used. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. - You may not specify FinalMobileUrls if the device preference is set to mobile. Also note that if the TrackingUrlTemplate or UrlCustomParameters elements are set, then at least one final URL is required. For more information, see URL Tracking with Upgraded URLs. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The mobile landing page URL. The keyword's final mobile URL is used if specified; otherwise, the ad's final mobile URL is used. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  description: For future use.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: biddingScheme
  name: bidding scheme
  description: The bid strategy type for how you want to manage your bids. For details about supported bid strategies per campaign type, see Budget and Bid Strategies. NOTE: As of April 2021, you cannot set any bid strategies for ad groups or keywords. If you attempt to set bid strategies for ad groups or keywords, the request will be ignored without error. Ad groups and keywords will inherit their campaign's bid strategy. Add: Optional. If you do not set this element, then InheritFromParentBiddingScheme is used by default. Update: Optional. If no value is set for the update, this setting is not changed.
  or:
    node: CampaignManagementBiddingSchemeShape
    class: CampaignManagementBiddingScheme
  or:
    node: CampaignManagementBiddingSchemeBaseShape
    class: CampaignManagementBiddingSchemeBase
  or:
    node: CampaignManagementCommissionBiddingSchemeShape
    class: CampaignManagementCommissionBiddingScheme
  or:
    node: CampaignManagementCostPerSaleBiddingSchemeShape
    class: CampaignManagementCostPerSaleBiddingScheme
  or:
    node: CampaignManagementEnhancedCpcBiddingSchemeShape
    class: CampaignManagementEnhancedCpcBiddingScheme
  or:
    node: CampaignManagementInheritFromParentBiddingSchemeShape
    class: CampaignManagementInheritFromParentBiddingScheme
  or:
    node: CampaignManagementManualCpaBiddingSchemeShape
    class: CampaignManagementManualCpaBiddingScheme
  or:
    node: CampaignManagementManualCpcBiddingSchemeShape
    class: CampaignManagementManualCpcBiddingScheme
  or:
    node: CampaignManagementManualCpmBiddingSchemeShape
    class: CampaignManagementManualCpmBiddingScheme
  or:
    node: CampaignManagementManualCpvBiddingSchemeShape
    class: CampaignManagementManualCpvBiddingScheme
  or:
    node: CampaignManagementMaxClicksBiddingSchemeShape
    class: CampaignManagementMaxClicksBiddingScheme
  or:
    node: CampaignManagementMaxConversionValueBiddingSchemeShape
    class: CampaignManagementMaxConversionValueBiddingScheme
  or:
    node: CampaignManagementMaxConversionsBiddingSchemeShape
    class: CampaignManagementMaxConversionsBiddingScheme
  or:
    node: CampaignManagementMaxRoasBiddingSchemeShape
    class: CampaignManagementMaxRoasBiddingScheme
  or:
    node: CampaignManagementPercentCpcBiddingSchemeShape
    class: CampaignManagementPercentCpcBiddingScheme
  or:
    node: CampaignManagementTargetCpaBiddingSchemeShape
    class: CampaignManagementTargetCpaBiddingScheme
  or:
    node: CampaignManagementTargetImpressionShareBiddingSchemeShape
    class: CampaignManagementTargetImpressionShareBiddingScheme
  or:
    node: CampaignManagementTargetRoasBiddingSchemeShape
    class: CampaignManagementTargetRoasBiddingScheme
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementAddKeywordsResponseShape
type: NodeShape
target class: CampaignManagementAddKeywordsResponse
property:
  path: keywordIds
  name: keyword ids
  description: A list of unique system identifiers corresponding to the keywords that were added. The list of identifiers corresponds directly to the list of keywords in the request. Items of the list may be returned as null. For each list index where a keyword was not added, the corresponding element will be null.
  datatype: long
property:
  path: inheritedBidStrategyTypes
  name: inherited bid strategy types
  description: The value of each string represents the type of bidding scheme or bid strategy type that is inherited from the parent campaign or ad group. Each string in the list is returned in the same order and corresponds to the keywords in the request message. If a keyword does not inherit from the ad group or campaign, the corresponding item in the list will be nil. This element is not returned by default. You must set ReturnInheritedBidStrategyTypes true in the request.
  datatype: string
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddLabelsRequestShape
type: NodeShape
target class: CampaignManagementAddLabelsRequest
property:
  path: labels
  name: labels
  description: The list of labels to add to the account. The maximum size of the list is 100 items per service request.
  node: CampaignManagementLabelShape
  class: CampaignManagementLabel
  node kind: BlankNodeOrIRI

CampaignManagementLabelShape
type: NodeShape
target class: CampaignManagementLabel
property:
  path: name
  name: name
  description: The label name. The case-sensitive label name can be between 1 to 80 characters in length, and must be unique across all labels in the account. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The label description. The label description can be between 1 to 200 characters in length. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: colorCode
  name: color code
  description: The label color as a hexadecimal code. The hexadecimal value must have the '#' prefix. For example you can use the value of #FFFFFF for a white label. The color can be viewed in the Microsoft Advertising web application. Your application can display the color or utilize the hexadecimal value to categorize a set of labels. Add: Optional. If you do not specify any color, the value will be assigned at random for each label. Update: Optional. If no value is set for the update, this setting is not changed. You can update the color code but cannot remove it.
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: The system-generated identifier of the label. Add: Read-only Update: Required
  datatype: long
  max count: 1

CampaignManagementAddLabelsResponseShape
type: NodeShape
target class: CampaignManagementAddLabelsResponse
property:
  path: labelIds
  name: label ids
  description: A list of unique system identifiers corresponding to the labels that were added. The list of identifiers corresponds directly to the list of labels in the request. Items of the list may be returned as null. For each list index where a label was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddLinkedInSegmentsRequestShape
type: NodeShape
target class: CampaignManagementAddLinkedInSegmentsRequest
property:
  path: linkedInSegments
  name: linked in segments
  description: Array of LinkedIn segments to add to the specified campaign.
  or:
    node: CampaignManagementCompanyListShape
    class: CampaignManagementCompanyList
  or:
    node: CampaignManagementLinkedInSegmentShape
    class: CampaignManagementLinkedInSegment
  or:
    node: CampaignManagementLinkedInSegmentBaseShape
    class: CampaignManagementLinkedInSegmentBase
  node kind: BlankNodeOrIRI

CampaignManagementLinkedInSegmentShape
type: NodeShape
target class: CampaignManagementLinkedInSegment
property:
  path: id
  name: id
  description: The LinkedIn segment ID.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the LinkedIn segment.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the LinkedIn segment.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of hte LinkedIn segment.
  datatype: string
  max count: 1
  in: Building
  in: Ready
  in: ReachTooSmall
property:
  path: reach
  name: reach
  description: The reach of the LinkedIn segment.
  datatype: long
  max count: 1
property:
  path: companyNames
  name: company names
  node: CampaignManagementCompanyNameShape
  class: CampaignManagementCompanyName
  node kind: BlankNodeOrIRI
property:
  path: total
  name: total
  datatype: int
  max count: 1
property:
  path: matched
  name: matched
  datatype: int
  max count: 1

CampaignManagementCompanyNameShape
type: NodeShape
target class: CampaignManagementCompanyName
property:
  path: id
  name: id
  description: The company name ID.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The company name.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The company name status.
  datatype: string
  max count: 1
  in: NotProcessed
  in: Matched
  in: NoMatch

CampaignManagementAddLinkedInSegmentsResponseShape
type: NodeShape
target class: CampaignManagementAddLinkedInSegmentsResponse
property:
  path: linkedInSegmentIds
  name: linked in segment ids
  description: The LinkedIn segment IDs.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that weren't successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddListItemsToSharedListRequestShape
type: NodeShape
target class: CampaignManagementAddListItemsToSharedListRequest
property:
  path: listItems
  name: list items
  description: The negative keywords to add to the negative keyword list, or the negative sites to add to the website exclusion list. The list can contain a maximum of 5,000 items per service call.
  or:
    node: CampaignManagementBrandItemShape
    class: CampaignManagementBrandItem
  or:
    node: CampaignManagementNegativeKeywordShape
    class: CampaignManagementNegativeKeyword
  or:
    node: CampaignManagementNegativeSiteShape
    class: CampaignManagementNegativeSite
  or:
    node: CampaignManagementSharedListItemShape
    class: CampaignManagementSharedListItem
  or:
    node: CampaignManagementSharedListItemBaseShape
    class: CampaignManagementSharedListItemBase
  or:
    node: CampaignManagementSiteShape
    class: CampaignManagementSite
  node kind: BlankNodeOrIRI
property:
  path: sharedList
  name: shared list
  description: The negative keyword list or website exclusion list. If the SharedEntityScope is either empty or set to Account, and if the SharedList is a NegativeKeywordList or AccountNegativeKeywordList, then the ListItems must be negative keyword (NegativeKeyword) objects. If the SharedEntityScope is set to Customer, and if the SharedList is a PlacementExclusionList, then the ListItems must be negative site (NegativeSite) objects.
  or:
    node: CampaignManagementAccountContentNegativeKeywordListShape
    class: CampaignManagementAccountContentNegativeKeywordList
  or:
    node: CampaignManagementAccountNegativeKeywordListShape
    class: CampaignManagementAccountNegativeKeywordList
  or:
    node: CampaignManagementAccountPlacementExclusionListShape
    class: CampaignManagementAccountPlacementExclusionList
  or:
    node: CampaignManagementAccountPlacementInclusionListShape
    class: CampaignManagementAccountPlacementInclusionList
  or:
    node: CampaignManagementBrandListShape
    class: CampaignManagementBrandList
  or:
    node: CampaignManagementNegativeKeywordListShape
    class: CampaignManagementNegativeKeywordList
  or:
    node: CampaignManagementPlacementExclusionListShape
    class: CampaignManagementPlacementExclusionList
  or:
    node: CampaignManagementSharedListShape
    class: CampaignManagementSharedList
  or:
    node: CampaignManagementSharedListBaseShape
    class: CampaignManagementSharedListBase
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: sharedEntityScope
  name: shared entity scope
  description: Indicates whether the shared entity is available at the ad account (Account) or manager account (Customer) level. This element is optional and defaults to Account scope. The ad account scope is only applicable for negative keyword lists. Set this element to Customer to add negative sites to a website exclusion list in your manager account (customer) shared library.
  datatype: string
  max count: 1
  in: Account
  in: Customer

CampaignManagementSharedListItemShape
type: NodeShape
target class: CampaignManagementSharedListItem
property:
  path: type
  name: type
  description: The type of the shared list item. For more information about shared list item types, see Remarks.
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: id
  name: id
  datatype: long
  max count: 1
property:
  path: text
  name: text
  datatype: string
  max count: 1
property:
  path: matchType
  name: match type
  datatype: string
  max count: 1
  in: Exact
  in: Phrase
  in: Broad
property:
  path: url
  name: url
  datatype: string
  max count: 1
property:
  path: brandId
  name: brand id
  datatype: long
  max count: 1

CampaignManagementSharedListShape
type: NodeShape
target class: CampaignManagementSharedList
property:
  path: itemCount
  name: item count
  description: The number of SharedListItem objects that are added to this shared list. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the shared entity. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the shared entity. The maximum string length is 255. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the shared entity. This value is NegativeKeywordList when you retrieve a NegativeKeywordList. This value is PlacementExclusionList when you retrieve a PlacementExclusionList. This value is AccountNegativeKeywordList when you retrieve an AccountNegativeKeywordList. For more information about shared entity types, see SharedEntity Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: associationCount
  name: association count
  description: The number of active associations between this shared entity and another entity such as campaign or ad account. For a NegativeKeywordList, the maximum number of active associations between the negative keyword list and campaign is 20. For a PlacementExclusionList, the maximum number of active associations between the website exclusion list and ad account is undefined. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementAddListItemsToSharedListResponseShape
type: NodeShape
target class: CampaignManagementAddListItemsToSharedListResponse
property:
  path: listItemIds
  name: list item ids
  description: A list of long values that represents the identifiers for the list items that were added. Items of the list may be returned as null. For each list index where a list item was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddMediaRequestShape
type: NodeShape
target class: CampaignManagementAddMediaRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account that owns the asset library.
  datatype: long
  max count: 1
property:
  path: media
  name: media
  description: An array of Media to add to the account's asset library. You can add a maximum of 10 media in a single call.
  or:
    node: CampaignManagementImageShape
    class: CampaignManagementImage
  or:
    node: CampaignManagementMediaShape
    class: CampaignManagementMedia
  or:
    node: CampaignManagementMediaBaseShape
    class: CampaignManagementMediaBase
  node kind: BlankNodeOrIRI

CampaignManagementMediaShape
type: NodeShape
target class: CampaignManagementMedia
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the media. Add: Read-only
  datatype: long
  max count: 1
property:
  path: mediaType
  name: media type
  description: The type of media to add to the media library. The recommended sub type is "GenericImage". For media that will be used with an ImageAdExtension, the supported values are GenericImage, Image16x9, Image15x10, Image4x3, and Image12x10. For media that will be used with a ResponsiveAd, the supported values are GenericImage, Image1x1, Image191x100, and Image4x1. For more information about supported aspect ratios, see the Image Data Object Remarks. Add: Required
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The media type. For more information about media types, see Remarks below. Add: Read-only
  datatype: string
  max count: 1
property:
  path: text
  name: text
  description: The media text.
  datatype: string
  max count: 1
property:
  path: data
  name: data
  datatype: string
  max count: 1

CampaignManagementAddMediaResponseShape
type: NodeShape
target class: CampaignManagementAddMediaResponse
property:
  path: mediaIds
  name: media ids
  description: The identifiers of the media that you added to the library. You use the identifier to set the appropriate media ID field in the ImageAdExtension or ResponsiveAd object. You can get the media indentifiers for image ad extensions and responsive ads with the GetMediaMetaDataByAccountId and GetMediaMetaDataByIds operations.
  datatype: long

CampaignManagementAddNegativeKeywordsToEntitiesRequestShape
type: NodeShape
target class: CampaignManagementAddNegativeKeywordsToEntitiesRequest
property:
  path: entityNegativeKeywords
  name: entity negative keywords
  description: An array of negative keyword with associated entity such as a campaign or ad group. The specified negative keywords will be appended to any existing negative keywords if the limit of 20,000 negative keywords per associated campaign or ad group would not be exceeded. The EntityType specified within each EntityNegativeKeyword must be set to the same value. This array can contain a maximum of 1 EntityNegativeKeyword element, which contains up to 20,000 negative keywords.
  node: CampaignManagementEntityNegativeKeywordShape
  class: CampaignManagementEntityNegativeKeyword
  node kind: BlankNodeOrIRI

CampaignManagementEntityNegativeKeywordShape
type: NodeShape
target class: CampaignManagementEntityNegativeKeyword
property:
  path: entityId
  name: entity id
  description: The system-generated identifier of a campaign or ad group that is associated with the negative keywords.
  datatype: long
  max count: 1
property:
  path: entityType
  name: entity type
  description: The type of entity such as a campaign that is associated with the negative keywords. The possible values are AdGroup and Campaign.
  datatype: string
  max count: 1
property:
  path: negativeKeywords
  name: negative keywords
  description: An array of negative keywords that are associated with the corresponding campaign or ad group.
  node: CampaignManagementNegativeKeywordShape
  class: CampaignManagementNegativeKeyword
  node kind: BlankNodeOrIRI

CampaignManagementNegativeKeywordShape
type: NodeShape
target class: CampaignManagementNegativeKeyword
property:
  path: type
  name: type
  description: The type of the shared list item. This value is NegativeKeyword when you retrieve a negative keyword. For more information about shared list item types, see SharedListItem Data Object Remarks. Add: Read-only
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the negative keyword. Add: Read-only Delete: Required
  datatype: long
  max count: 1
property:
  path: text
  name: text
  description: The negative keyword text. The text can contain a maximum of 100 characters. Add: Required Delete: Optional
  datatype: string
  max count: 1
property:
  path: matchType
  name: match type
  description: The type of match to compare the negative keyword and the user's search term. The supported values for a negative keyword are Exact and Phrase. Add: Required Delete: Optional
  datatype: string
  max count: 1
  in: Exact
  in: Phrase
  in: Broad

CampaignManagementAddNegativeKeywordsToEntitiesResponseShape
type: NodeShape
target class: CampaignManagementAddNegativeKeywordsToEntitiesResponse
property:
  path: nestedPartialErrors
  name: nested partial errors
  description: An array of BatchErrorCollection objects that contain details for any negative keyword that were not successfully added. The top level error within each BatchErrorCollection object corresponds to potential campaign or ad group errors. The nested list of BatchError objects would include any errors specific to the negative keywords that you attempted to add to the campaign or ad group. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorCollectionShape
    class: CampaignManagementBatchErrorCollection
  or:
    node: CampaignManagementBatchErrorCollectionBaseShape
    class: CampaignManagementBatchErrorCollectionBase
  or:
    node: CampaignManagementEditorialErrorCollectionShape
    class: CampaignManagementEditorialErrorCollection
  node kind: BlankNodeOrIRI
property:
  path: negativeKeywordIds
  name: negative keyword ids
  description: A list of IdCollection corresponding to the negative keywords that were added for the corresponding entity. Within an IdCollection, the list of Ids corresponds directly to the list of negative keywords in the request. Items of the list may be returned as null. For each list index where a negative keyword was not added, the corresponding element will be null.
  node: CampaignManagementIdCollectionShape
  class: CampaignManagementIdCollection
  node kind: BlankNodeOrIRI

CampaignManagementIdCollectionShape
type: NodeShape
target class: CampaignManagementIdCollection
property:
  path: ids
  name: ids
  description: A list of entity identifiers.
  datatype: long

CampaignManagementAddNewCustomerAcquisitionGoalsRequestShape
type: NodeShape
target class: CampaignManagementAddNewCustomerAcquisitionGoalsRequest
property:
  path: newCustomerAcquisitionGoals
  name: new customer acquisition goals
  description: Reserved.
  node: CampaignManagementNewCustomerAcquisitionGoalShape
  class: CampaignManagementNewCustomerAcquisitionGoal
  node kind: BlankNodeOrIRI

CampaignManagementNewCustomerAcquisitionGoalShape
type: NodeShape
target class: CampaignManagementNewCustomerAcquisitionGoal
property:
  path: id
  name: id
  description: Reserved.
  datatype: long
  max count: 1
property:
  path: additionalValue
  name: additional value
  description: Reserved.
  datatype: double
  max count: 1
property:
  path: audiences
  name: audiences
  description: Reserved.
  node: CampaignManagementAudienceIdNameShape
  class: CampaignManagementAudienceIdName
  node kind: BlankNodeOrIRI

CampaignManagementAudienceIdNameShape
type: NodeShape
target class: CampaignManagementAudienceIdName
property:
  path: id
  name: id
  description: Reserved.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Reserved.
  datatype: string
  max count: 1

CampaignManagementAddNewCustomerAcquisitionGoalsResponseShape
type: NodeShape
target class: CampaignManagementAddNewCustomerAcquisitionGoalsResponse
property:
  path: newCustomerAcquisitionGoalIds
  name: new customer acquisition goal ids
  description: Reserved.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: Reserved.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddSeasonalityAdjustmentsRequestShape
type: NodeShape
target class: CampaignManagementAddSeasonalityAdjustmentsRequest
property:
  path: accountId
  name: account id
  description: The account ID.
  datatype: long
  max count: 1
property:
  path: seasonalityAdjustments
  name: seasonality adjustments
  description: The seasonality adjustments to add.
  node: CampaignManagementSeasonalityAdjustmentShape
  class: CampaignManagementSeasonalityAdjustment
  node kind: BlankNodeOrIRI

CampaignManagementSeasonalityAdjustmentShape
type: NodeShape
target class: CampaignManagementSeasonalityAdjustment
property:
  path: id
  name: id
  description: The seasonality adjustment ID.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the seasonality adjustment.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: A description for the seasonality adjustment.
  datatype: string
  max count: 1
property:
  path: adjustmentPercentage
  name: adjustment percentage
  description: The percentage of the conversion rate adjustment.
  datatype: double
  max count: 1
property:
  path: startDate
  name: start date
  description: The start date. Important: The value must be in your account time zone. This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.
  datatype: dateTime
  max count: 1
property:
  path: endDate
  name: end date
  description: The end date. Important: The value must be in your account time zone. This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.
  datatype: dateTime
  max count: 1
property:
  path: deviceTypeFilter
  name: device type filter
  description: Make the seasonality adjustment to these device types.
  datatype: string
  max count: 1
property:
  path: campaignTypeFilter
  name: campaign type filter
  description: Make the seasonality adjustment to these campaign types.
  datatype: string
  max count: 1
property:
  path: campaignAssociations
  name: campaign associations
  description: Make the seasonality adjustment to these campaigns.
  node: CampaignManagementCampaignAssociationShape
  class: CampaignManagementCampaignAssociation
  node kind: BlankNodeOrIRI

CampaignManagementAddSeasonalityAdjustmentsResponseShape
type: NodeShape
target class: CampaignManagementAddSeasonalityAdjustmentsResponse
property:
  path: seasonalityAdjustmentIds
  name: seasonality adjustment ids
  description: The seasonality adjustment IDs.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddSharedEntityRequestShape
type: NodeShape
target class: CampaignManagementAddSharedEntityRequest
property:
  path: sharedEntity
  name: shared entity
  description: The negative keyword list or website exclusion list. If the SharedEntityScope is either empty or set to Account, and if the SharedEntity is a NegativeKeywordList, then the ListItems must be negative keyword (NegativeKeyword) objects. If the SharedEntityScope is set to Customer, and if the SharedEntity is a PlacementExclusionList, then the ListItems must be negative site (NegativeSite) objects.
  or:
    node: CampaignManagementAccountContentNegativeKeywordListShape
    class: CampaignManagementAccountContentNegativeKeywordList
  or:
    node: CampaignManagementAccountNegativeKeywordListShape
    class: CampaignManagementAccountNegativeKeywordList
  or:
    node: CampaignManagementAccountPlacementExclusionListShape
    class: CampaignManagementAccountPlacementExclusionList
  or:
    node: CampaignManagementAccountPlacementInclusionListShape
    class: CampaignManagementAccountPlacementInclusionList
  or:
    node: CampaignManagementBrandListShape
    class: CampaignManagementBrandList
  or:
    node: CampaignManagementNegativeKeywordListShape
    class: CampaignManagementNegativeKeywordList
  or:
    node: CampaignManagementPlacementExclusionListShape
    class: CampaignManagementPlacementExclusionList
  or:
    node: CampaignManagementSharedEntityShape
    class: CampaignManagementSharedEntity
  or:
    node: CampaignManagementSharedListShape
    class: CampaignManagementSharedList
  or:
    node: CampaignManagementSharedListBaseShape
    class: CampaignManagementSharedListBase
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: listItems
  name: list items
  description: The negative keywords (5,000 total maximum) to include with the new negative keyword list, or negative sites (10,000 total maximum) to include with the new website exclusion list. The list can contain a maximum of 5,000 items per service call. To add more list items, call the AddListItemsToSharedList operation.
  or:
    node: CampaignManagementBrandItemShape
    class: CampaignManagementBrandItem
  or:
    node: CampaignManagementNegativeKeywordShape
    class: CampaignManagementNegativeKeyword
  or:
    node: CampaignManagementNegativeSiteShape
    class: CampaignManagementNegativeSite
  or:
    node: CampaignManagementSharedListItemShape
    class: CampaignManagementSharedListItem
  or:
    node: CampaignManagementSharedListItemBaseShape
    class: CampaignManagementSharedListItemBase
  or:
    node: CampaignManagementSiteShape
    class: CampaignManagementSite
  node kind: BlankNodeOrIRI
property:
  path: sharedEntityScope
  name: shared entity scope
  description: Indicates whether the shared entity is available at the ad account (Account) or manager account (Customer) level. This element is optional and defaults to Account scope. The ad account scope is only applicable for negative keyword lists. Set this element to Customer to add a website exclusion list in your manager account (customer) shared library.
  datatype: string
  max count: 1
  in: Account
  in: Customer

CampaignManagementAddSharedEntityResponseShape
type: NodeShape
target class: CampaignManagementAddSharedEntityResponse
property:
  path: sharedEntityId
  name: shared entity id
  description: The identifier for the shared entity that was added.
  datatype: long
  max count: 1
property:
  path: listItemIds
  name: list item ids
  description: A list of long values that represents the identifiers for the list items that were added. Items of the list may be returned as null. For each list index where a list item was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddUetTagsRequestShape
type: NodeShape
target class: CampaignManagementAddUetTagsRequest
property:
  path: uetTags
  name: uet tags
  description: An array of UetTag objects to add to the customer's shared UET tag library. The customer is determined by the required CustomerId header element. You can add a maximum of 100 UET tags in a single call, although please note that you can use one UET tag with all of your conversion goals and remarketing lists. Before you create multiple UET tags, see Reasons for creating more than one UET tag. If the call is successful, the tracking script that you should add to your website is included in a corresponding UetTag within the response message.
  node: CampaignManagementUetTagShape
  class: CampaignManagementUetTag
  node kind: BlankNodeOrIRI

CampaignManagementUetTagShape
type: NodeShape
target class: CampaignManagementUetTag
property:
  path: name
  name: name
  description: The UET tag name. The maximum length of the name is 100, and the name must be unique among all UET tags belonging to the same customer. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Text to help you identify the UET tag. We recommend that you set this to the related website page name or URL. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: trackingScript
  name: tracking script
  description: The tracking script that you can add to your website to allow Microsoft Advertising to collect actions people take on your website. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: trackingNoScript
  name: tracking no script
  description: If your website doesn't support JavaScript, you can use this Non-JavaScript representation of the UET tag. If you use Non-JavaScript, you can't track custom events or variable revenue. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: trackingStatus
  name: tracking status
  description: The system-determined status values of a UET tag, for example the system sets the status to Unverified if the UET tag has not yet been verified. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Unverified
  in: Active
  in: Inactive
property:
  path: customerShare
  name: customer share
  description: Determines the list of customers that share the UET tag. Details include UET tag to audience association counts. Shared UET tags and audiences are only available for pilot customers. For an overview of sharing audiences and UET tags in a customer hierarchy, see the Share Audiences and UET Tags technical guide. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set this element to null or empty to retain any existing customer account shares. To remove all customer account shares, set the CustomerAccountShares element of the CustomerShare object to null or empty. To remove a subset of customer account shares, specify the customer account shares that you want to keep in the CustomerAccountShares element of the CustomerShare object.
  node: CampaignManagementCustomerShareShape
  class: CampaignManagementCustomerShare
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: industry
  name: industry
  description: The industry of the website associated with your UET tag. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: AdultGambling
  in: Autos
  in: B2BServices
  in: B2CServices
  in: CPG
  in: CareersEducation
  in: CommunitySocialCharitableGroups
  in: Entertainment
  in: FinancialServicesInsurance
  in: Government
  in: HealthWellness
  in: RealEstate
  in: RestaurantsFood
  in: Retail
  in: ScienceSocialScienceOthers
  in: TechnologyTelecommunications
  in: TravelTransportation
  in: Other
  in: Unknown
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the UET tag. Add: Read-only Update: Required and Read-only
  datatype: long
  max count: 1

CampaignManagementAddUetTagsResponseShape
type: NodeShape
target class: CampaignManagementAddUetTagsResponse
property:
  path: uetTags
  name: uet tags
  description: An array of UetTag objects to add to the customer's shared UET tag library. The customer is determined by the required CustomerId header element. You can add a maximum of 100 UET tags in a single call, although please note that you can use one UET tag with all of your conversion goals and remarketing lists. Before you create multiple UET tags, see Reasons for creating more than one UET tag. If the call is successful, the tracking script that you should add to your website is included in a corresponding UetTag within the response message.
  node: CampaignManagementUetTagShape
  class: CampaignManagementUetTag
  node kind: BlankNodeOrIRI
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAddVideosRequestShape
type: NodeShape
target class: CampaignManagementAddVideosRequest
property:
  path: videos
  name: videos
  description: The list of videos to add to the account. The maximum size of the list is 100 items per service request.
  node: CampaignManagementVideoShape
  class: CampaignManagementVideo
  node kind: BlankNodeOrIRI

CampaignManagementVideoShape
type: NodeShape
target class: CampaignManagementVideo
property:
  path: description
  name: description
  description: The description of the video asset. Add: Supported Update: Supported
  datatype: string
  max count: 1
property:
  path: thumbnailUrl
  name: thumbnail url
  description: The thumbnail URL of the video asset. Add: Unsupported Update: Unsupported
  datatype: string
  max count: 1
property:
  path: sourceUrl
  name: source url
  description: The original URL of the video. Note: SourceUrl must be a direct download URL. Add: Supported and Required
  datatype: string
  max count: 1
property:
  path: url
  name: url
  description: The URL where the video is hosted. Note: URL is reserved for internal usage. Add: Supported Update: Supported
  datatype: string
  max count: 1
property:
  path: aspectRatio
  name: aspect ratio
  description: The video's aspect ratio. Possible values are 16:9, 9:16, 4:3, 3:4, 1:1, 5:4, and 4:5.
  datatype: string
  max count: 1
property:
  path: durationInMilliseconds
  name: duration in milliseconds
  description: The duration in milliseconds of the video asset. Add: Unsupported Update: Unsupported
  datatype: int
  max count: 1
property:
  path: status
  name: status
  description: The status of the video asset. The status can be Draft, Active, Deleted or Failed. Add: Unsupported Update: Supported
  datatype: string
  max count: 1
property:
  path: createdDateTimeInUTC
  name: created date time in utc
  description: The date and time the video was created, in Coordinated Universal Time.
  datatype: dateTime
  max count: 1
property:
  path: modifiedDateTimeInUTC
  name: modified date time in utc
  description: The date and time the video was last modified, in Coordinated Universal Time.
  datatype: dateTime
  max count: 1
property:
  path: failureCode
  name: failure code
  description: Read the description for each possible error code below. AssetDataInvalid: The file downloaded from the URL is not a video. VideoDownloadError: The provided URL is not accessible. AssetDataInvalidWidth: The video frame width is less than 120 pixels. AssetDataInvalidHeight: The video frame height is less than 120 pixels. InvalidDuration: The video duration is less than 6 seconds. VideoOverweight: The video file size is greater than 2 GB. VideoTranscodingError: A general failure code that represents a transcoding issue. This is controlled by Azure Media Service. Learn more about encoding video and JobErrorCode.
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: The identifier of the video.
  datatype: long
  max count: 1

CampaignManagementAddVideosResponseShape
type: NodeShape
target class: CampaignManagementAddVideosResponse
property:
  path: videoIds
  name: video ids
  description: A list of unique system identifiers corresponding to the videos that were added. The list of identifiers corresponds directly to the list of videos in the request. Items of the list may be returned as null. For each list index where a video was not added, the corresponding element will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAdExtensionAssociationShape
type: NodeShape
target class: CampaignManagementAdExtensionAssociation
property:
  path: entityId
  name: entity id
  description: The identifier of an entity associated with the ad extension. Add: Required Update: Required
  datatype: long
  max count: 1
property:
  path: associationType
  name: association type
  description: The type of entity associated with the ad extension. Add: Required Update: Required
  datatype: string
  max count: 1
  in: Campaign
  in: AdGroup
  in: Account
property:
  path: adExtension
  name: ad extension
  description: The ad extension associated with a supported entity. Add: Required Update: Required
  or:
    node: CampaignManagementActionAdExtensionShape
    class: CampaignManagementActionAdExtension
  or:
    node: CampaignManagementAdExtensionShape
    class: CampaignManagementAdExtension
  or:
    node: CampaignManagementAdExtensionBaseShape
    class: CampaignManagementAdExtensionBase
  or:
    node: CampaignManagementAppAdExtensionShape
    class: CampaignManagementAppAdExtension
  or:
    node: CampaignManagementCallAdExtensionShape
    class: CampaignManagementCallAdExtension
  or:
    node: CampaignManagementCalloutAdExtensionShape
    class: CampaignManagementCalloutAdExtension
  or:
    node: CampaignManagementDataTableAdExtensionShape
    class: CampaignManagementDataTableAdExtension
  or:
    node: CampaignManagementDisclaimerAdExtensionShape
    class: CampaignManagementDisclaimerAdExtension
  or:
    node: CampaignManagementFilterLinkAdExtensionShape
    class: CampaignManagementFilterLinkAdExtension
  or:
    node: CampaignManagementFlyerAdExtensionShape
    class: CampaignManagementFlyerAdExtension
  or:
    node: CampaignManagementImageAdExtensionShape
    class: CampaignManagementImageAdExtension
  or:
    node: CampaignManagementLeadFormAdExtensionShape
    class: CampaignManagementLeadFormAdExtension
  or:
    node: CampaignManagementLocationAdExtensionShape
    class: CampaignManagementLocationAdExtension
  or:
    node: CampaignManagementLogoAdExtensionShape
    class: CampaignManagementLogoAdExtension
  or:
    node: CampaignManagementNewsAdExtensionShape
    class: CampaignManagementNewsAdExtension
  or:
    node: CampaignManagementPriceAdExtensionShape
    class: CampaignManagementPriceAdExtension
  or:
    node: CampaignManagementPromotionAdExtensionShape
    class: CampaignManagementPromotionAdExtension
  or:
    node: CampaignManagementReviewAdExtensionShape
    class: CampaignManagementReviewAdExtension
  or:
    node: CampaignManagementSitelinkAdExtensionShape
    class: CampaignManagementSitelinkAdExtension
  or:
    node: CampaignManagementStructuredSnippetAdExtensionShape
    class: CampaignManagementStructuredSnippetAdExtension
  or:
    node: CampaignManagementVideoAdExtensionShape
    class: CampaignManagementVideoAdExtension
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: editorialStatus
  name: editorial status
  description: The editorial status of the ad extension. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited

CampaignManagementAdExtensionAssociationCollectionShape
type: NodeShape
target class: CampaignManagementAdExtensionAssociationCollection
property:
  path: adExtensionAssociations
  name: ad extension associations
  description: An array of objects that associate an ad extension and its editorial status to an account, campaign, or ad group. Add: Required Update: Required
  node: CampaignManagementAdExtensionAssociationShape
  class: CampaignManagementAdExtensionAssociation
  node kind: BlankNodeOrIRI

CampaignManagementAdExtensionBaseShape
type: NodeShape
target class: CampaignManagementAdExtensionBase
property:
  path: status
  name: status
  datatype: string
  max count: 1
  in: Active
  in: Deleted
property:
  path: scheduling
  name: scheduling
  node: CampaignManagementScheduleShape
  class: CampaignManagementSchedule
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: devicePreference
  name: device preference
  datatype: long
  max count: 1
property:
  path: id
  name: id
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: version
  name: version
  datatype: int
  max count: 1

CampaignManagementAdExtensionEditorialReasonShape
type: NodeShape
target class: CampaignManagementAdExtensionEditorialReason
property:
  path: reasonCode
  name: reason code
  description: A code that identifies the reason for the failure. For a list of possible reason codes, see Editorial Reason Codes.
  datatype: int
  max count: 1
property:
  path: location
  name: location
  description: The component of the ad extension that failed editorial review.
  datatype: string
  max count: 1
property:
  path: term
  name: term
  description: The term that failed editorial review. This element will not be set if a combination of terms caused the failure or if the failure was based on a policy violation.
  datatype: string
  max count: 1
property:
  path: publisherCountries
  name: publisher countries
  description: The list of publisher countries or regions whose editorial guidelines do not allow the specified term.
  datatype: string

CampaignManagementAdExtensionEditorialReasonCollectionShape
type: NodeShape
target class: CampaignManagementAdExtensionEditorialReasonCollection
property:
  path: adExtensionId
  name: ad extension id
  description: The identifier of the ad extension that failed editorial review.
  datatype: long
  max count: 1
property:
  path: reasons
  name: reasons
  description: A list of AdExtensionEditorialReason objects that identify the component of an ad extension that failed editorial review, and the reason for the failure.
  node: CampaignManagementAdExtensionEditorialReasonShape
  class: CampaignManagementAdExtensionEditorialReason
  node kind: BlankNodeOrIRI

CampaignManagementAdExtensionIdToEntityIdAssociationShape
type: NodeShape
target class: CampaignManagementAdExtensionIdToEntityIdAssociation
property:
  path: adExtensionId
  name: ad extension id
  description: The system-generated identifier of the ad extension.
  datatype: long
  max count: 1
property:
  path: entityId
  name: entity id
  description: The identifier of an entity associated with the ad extension.
  datatype: long
  max count: 1

CampaignManagementAdGroupCriterionActionShape
type: NodeShape
target class: CampaignManagementAdGroupCriterionAction
property:
  path: action
  name: action
  description: The action to be applied for the AdGroupCriterion.
  datatype: string
  max count: 1
  in: Add
  in: Delete
  in: Update
property:
  path: adGroupCriterion
  name: ad group criterion
  description: The BiddableAdGroupCriterion or NegativeAdGroupCriterion, either of which must contain a ProductPartition criterion. For the Update action, only the CriterionBid and DestinationUrl elements of the AdGroupCriterion are mutable. To update the order or structure of the product group, you cannot use the update action. You must delete ad group criterions and then add new product partitions instead.
  or:
    node: CampaignManagementAdGroupCriterionShape
    class: CampaignManagementAdGroupCriterion
  or:
    node: CampaignManagementAdGroupCriterionBaseShape
    class: CampaignManagementAdGroupCriterionBase
  or:
    node: CampaignManagementBiddableAdGroupCriterionShape
    class: CampaignManagementBiddableAdGroupCriterion
  or:
    node: CampaignManagementNegativeAdGroupCriterionShape
    class: CampaignManagementNegativeAdGroupCriterion
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementAdGroupCriterionBaseShape
type: NodeShape
target class: CampaignManagementAdGroupCriterionBase
property:
  path: adGroupId
  name: ad group id
  datatype: long
  max count: 1
property:
  path: status
  name: status
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: criterion
  name: criterion
  or:
    node: CampaignManagementAgeCriterionShape
    class: CampaignManagementAgeCriterion
  or:
    node: CampaignManagementAudienceCriterionShape
    class: CampaignManagementAudienceCriterion
  or:
    node: CampaignManagementChannelPlacementCriterionShape
    class: CampaignManagementChannelPlacementCriterion
  or:
    node: CampaignManagementCriterionShape
    class: CampaignManagementCriterion
  or:
    node: CampaignManagementCriterionBaseShape
    class: CampaignManagementCriterionBase
  or:
    node: CampaignManagementCustomLinkedInCriterionShape
    class: CampaignManagementCustomLinkedInCriterion
  or:
    node: CampaignManagementDayTimeCriterionShape
    class: CampaignManagementDayTimeCriterion
  or:
    node: CampaignManagementDealCriterionShape
    class: CampaignManagementDealCriterion
  or:
    node: CampaignManagementDeviceCriterionShape
    class: CampaignManagementDeviceCriterion
  or:
    node: CampaignManagementGenderCriterionShape
    class: CampaignManagementGenderCriterion
  or:
    node: CampaignManagementGenreCriterionShape
    class: CampaignManagementGenreCriterion
  or:
    node: CampaignManagementHotelAdvanceBookingWindowCriterionShape
    class: CampaignManagementHotelAdvanceBookingWindowCriterion
  or:
    node: CampaignManagementHotelCheckInDateCriterionShape
    class: CampaignManagementHotelCheckInDateCriterion
  or:
    node: CampaignManagementHotelCheckInDayCriterionShape
    class: CampaignManagementHotelCheckInDayCriterion
  or:
    node: CampaignManagementHotelDateSelectionTypeCriterionShape
    class: CampaignManagementHotelDateSelectionTypeCriterion
  or:
    node: CampaignManagementHotelGroupShape
    class: CampaignManagementHotelGroup
  or:
    node: CampaignManagementHotelLengthOfStayCriterionShape
    class: CampaignManagementHotelLengthOfStayCriterion
  or:
    node: CampaignManagementLocationCriterionShape
    class: CampaignManagementLocationCriterion
  or:
    node: CampaignManagementLocationIntentCriterionShape
    class: CampaignManagementLocationIntentCriterion
  or:
    node: CampaignManagementPlacementCriterionShape
    class: CampaignManagementPlacementCriterion
  or:
    node: CampaignManagementProductPartitionShape
    class: CampaignManagementProductPartition
  or:
    node: CampaignManagementProductScopeShape
    class: CampaignManagementProductScope
  or:
    node: CampaignManagementProfileCriterionShape
    class: CampaignManagementProfileCriterion
  or:
    node: CampaignManagementRadiusCriterionShape
    class: CampaignManagementRadiusCriterion
  or:
    node: CampaignManagementStoreCriterionShape
    class: CampaignManagementStoreCriterion
  or:
    node: CampaignManagementTopicCriterionShape
    class: CampaignManagementTopicCriterion
  or:
    node: CampaignManagementWebpageShape
    class: CampaignManagementWebpage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementAdGroupNegativeSitesShape
type: NodeShape
target class: CampaignManagementAdGroupNegativeSites
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group to which the negative site URLs belong.
  datatype: long
  max count: 1
property:
  path: negativeSites
  name: negative sites
  description: A list of URLs of the websites where you do not want your ads displayed. This element can include a maximum of 2,500 URLs. Each URL must specify the domain name e.g., contoso.com which can include up to three subdomains and two subdirectories. The subdomain count includes the www prefix. For example one.two.three.contoso.com/1/2, www.two.three.contoso.com/1/2, and one.two.contoso.co.uk/1/2 are valid URLs, whereas one.two.three.contoso.co.uk/1/2 (too many subdomains) and one.two.three.contoso.com/1/2/3 (too many subdirectories) are not. Duplicate URLs in the list are not added. You can only exclude websites for syndicated search websites. The ad group's network must be set to OwnedAndOperatedAndSyndicatedSearch. For more information about network distribution, see Network. Note: You can exclude Yahoo and Microsoft sites (e.g., MSN.com) from Microsoft Audience Network (MSAN) ads, but not search ads. Negative site URLs specified at the ad group level are used instead of any negative site URLs specified at the campaign level. If you associate any website exclusion lists (Placement Exclusion List or Account Placement Exclusion List) with an ad account, the list of negative sites are used in addition to the campaign negative sites or ad group negative sites. To remove ad group negative site URLs, set this element to null.
  datatype: string

CampaignManagementAdRecommendationCustomizedPropertyShape
type: NodeShape
target class: CampaignManagementAdRecommendationCustomizedProperty
property:
  path: assetTypeName
  name: asset type name
  description: The asset type name.
  datatype: string
  max count: 1
property:
  path: propertyName
  name: property name
  description: The property name.
  datatype: string
  max count: 1
property:
  path: propertyValue
  name: property value
  description: The property value.
  datatype: string
  max count: 1

CampaignManagementAdRecommendationImageAssetPropertyShape
type: NodeShape
target class: CampaignManagementAdRecommendationImageAssetProperty
property:
  path: imageField
  name: image field
  description: The image field for the ad recommendation.
  datatype: string
  max count: 1
  in: Image
  in: Logo
property:
  path: imageUrl
  name: image url
  description: The URL of the image.
  datatype: string
  max count: 1
property:
  path: cropX
  name: crop x
  description: Where to crop along the x-axis in pixels.
  datatype: int
  max count: 1
property:
  path: cropY
  name: crop y
  description: Where to crop along the y-axis in pixels.
  datatype: int
  max count: 1
property:
  path: cropWidth
  name: crop width
  description: The crop width in pixels.
  datatype: int
  max count: 1
property:
  path: cropHeight
  name: crop height
  description: The crop height in pixels.
  datatype: int
  max count: 1

CampaignManagementAdRecommendationImageRefineOperationShape
type: NodeShape
target class: CampaignManagementAdRecommendationImageRefineOperation
property:
  path: imageRefineType
  name: image refine type
  description: The image refine type.
  datatype: string
  max count: 1
  in: BackgroundChange
  in: RefineDisplay
property:
  path: imageIndex
  name: image index
  description: Index of the image to be refined.
  datatype: int
  max count: 1
property:
  path: prompt
  name: prompt
  description: Description of image background change.
  datatype: string
  max count: 1

CampaignManagementAdRecommendationImageSuggestionShape
type: NodeShape
target class: CampaignManagementAdRecommendationImageSuggestion
property:
  path: image
  name: image
  description: The suggsted image.
  node: CampaignManagementImageShape
  class: CampaignManagementImage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: imageUrl
  name: image url
  description: The URL of the suggested image.
  datatype: string
  max count: 1
property:
  path: assetLink
  name: asset link
  description: Defines the relationship of an asset to an ad.
  node: CampaignManagementAssetLinkShape
  class: CampaignManagementAssetLink
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: imageMetadata
  name: image metadata
  description: The ad recommendation image suggestion metadata data object.
  node: CampaignManagementAdRecommendationImageSuggestionMetadataShape
  class: CampaignManagementAdRecommendationImageSuggestionMetadata
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: internalTemplate
  name: internal template
  node: CampaignManagementRecommendationTemplateShape
  class: CampaignManagementRecommendationTemplate
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementImageShape
type: NodeShape
target class: CampaignManagementImage
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the media. Add: Read-only
  datatype: long
  max count: 1
property:
  path: mediaType
  name: media type
  description: The type of media to add to the library. The recommended media type is "GenericImage". For media that will be used with an ImageAdExtension, the supported values are GenericImage, Image16x9, Image15x10, Image4x3, and Image12x10. For media that will be used with a ResponsiveAd, the supported values are GenericImage, Image1x1, Image191x100, and Image4x1. For more information about supported aspect ratios, see the Remarks section below. Add: Required
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The media type. For more information about media types, see the Media Data Object Remarks. Add: Read-only
  datatype: string
  max count: 1
property:
  path: text
  name: text
  description: The image alt text.
  datatype: string
  max count: 1
property:
  path: data
  name: data
  description: A base64 string that represents the image or icon to add to the library. The base64 string can contain a maximum of 102,400 characters. For information about restrictions and supported data types, see Remarks below.
  datatype: string
  max count: 1

CampaignManagementAdRecommendationImageSuggestionMetadataShape
type: NodeShape
target class: CampaignManagementAdRecommendationImageSuggestionMetadata
property:
  path: templateId
  name: template id
  description: The identifier of the template.
  datatype: string
  max count: 1
property:
  path: templateVersion
  name: template version
  description: The version of the template.
  datatype: string
  max count: 1
property:
  path: textAssetProperties
  name: text asset properties
  description: The text asset properties for the ad recommendation.
  node: CampaignManagementAdRecommendationTextAssetPropertyShape
  class: CampaignManagementAdRecommendationTextAssetProperty
  node kind: BlankNodeOrIRI
property:
  path: imageAssetProperties
  name: image asset properties
  description: The image asset properties for the ad recommendation.
  node: CampaignManagementAdRecommendationImageAssetPropertyShape
  class: CampaignManagementAdRecommendationImageAssetProperty
  node kind: BlankNodeOrIRI
property:
  path: customizedProperties
  name: customized properties
  description: The customized properties for the ad recommendation.
  node: CampaignManagementAdRecommendationCustomizedPropertyShape
  class: CampaignManagementAdRecommendationCustomizedProperty
  node kind: BlankNodeOrIRI

CampaignManagementAdRecommendationTextAssetPropertyShape
type: NodeShape
target class: CampaignManagementAdRecommendationTextAssetProperty
property:
  path: textField
  name: text field
  description: The type of text.
  datatype: string
  max count: 1
  in: Headline
  in: LongHeadline
  in: Description
  in: CallToAction
property:
  path: text
  name: text
  description: The text.
  datatype: string
  max count: 1

CampaignManagementRecommendationTemplateShape
type: NodeShape
target class: CampaignManagementRecommendationTemplate
property:
  path: style
  name: style
  datatype: int
  max count: 1
property:
  path: templateId
  name: template id
  datatype: string
  max count: 1
property:
  path: templateName
  name: template name
  datatype: string
  max count: 1
property:
  path: version
  name: version
  datatype: string
  max count: 1
property:
  path: image
  name: image
  node: CampaignManagementRecommendationImageShape
  class: CampaignManagementRecommendationImage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: logo
  name: logo
  node: CampaignManagementRecommendationImageShape
  class: CampaignManagementRecommendationImage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: businessName
  name: business name
  node: CampaignManagementRecommendationTextShape
  class: CampaignManagementRecommendationText
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shortHeadline
  name: short headline
  node: CampaignManagementRecommendationTextShape
  class: CampaignManagementRecommendationText
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: longHeadline
  name: long headline
  node: CampaignManagementRecommendationTextShape
  class: CampaignManagementRecommendationText
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: description
  name: description
  node: CampaignManagementRecommendationTextShape
  class: CampaignManagementRecommendationText
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: cta
  name: cta
  node: CampaignManagementRecommendationTextShape
  class: CampaignManagementRecommendationText
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: assetProperties
  name: asset properties
  node: CampaignManagementRecommendationAssetPropertyShape
  class: CampaignManagementRecommendationAssetProperty
  node kind: BlankNodeOrIRI
property:
  path: background
  name: background
  node: CampaignManagementRecommendationBackgroundShape
  class: CampaignManagementRecommendationBackground
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: color
  name: color
  node: CampaignManagementRecommendationColorShape
  class: CampaignManagementRecommendationColor
  node kind: BlankNodeOrIRI

CampaignManagementRecommendationImageShape
type: NodeShape
target class: CampaignManagementRecommendationImage
property:
  path: assetId
  name: asset id
  datatype: string
  max count: 1
property:
  path: url
  name: url
  datatype: string
  max count: 1
property:
  path: editable
  name: editable
  datatype: boolean
  max count: 1
property:
  path: source
  name: source
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  datatype: string
  max count: 1
property:
  path: imageSize
  name: image size
  node: CampaignManagementRecommendationImageSizeShape
  class: CampaignManagementRecommendationImageSize
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: cropSetting
  name: crop setting
  node: CampaignManagementRecommendationCropSettingShape
  class: CampaignManagementRecommendationCropSetting
  node kind: BlankNodeOrIRI

CampaignManagementRecommendationImageSizeShape
type: NodeShape
target class: CampaignManagementRecommendationImageSize
property:
  path: width
  name: width
  datatype: int
  max count: 1
property:
  path: height
  name: height
  datatype: int
  max count: 1

CampaignManagementRecommendationCropSettingShape
type: NodeShape
target class: CampaignManagementRecommendationCropSetting
property:
  path: sourceX
  name: source x
  datatype: int
  max count: 1
property:
  path: sourceY
  name: source y
  datatype: int
  max count: 1
property:
  path: sourceWidth
  name: source width
  datatype: int
  max count: 1
property:
  path: sourceHeight
  name: source height
  datatype: int
  max count: 1
property:
  path: aspectRatio
  name: aspect ratio
  datatype: string
  max count: 1

CampaignManagementRecommendationTextShape
type: NodeShape
target class: CampaignManagementRecommendationText
property:
  path: text
  name: text
  datatype: string
  max count: 1
property:
  path: editable
  name: editable
  datatype: boolean
  max count: 1
property:
  path: source
  name: source
  datatype: string
  max count: 1
property:
  path: recommendationId
  name: recommendation id
  datatype: string
  max count: 1
property:
  path: minLengthInChar
  name: min length in char
  datatype: int
  max count: 1
property:
  path: maxLengthInChar
  name: max length in char
  datatype: int
  max count: 1

CampaignManagementRecommendationAssetPropertyShape
type: NodeShape
target class: CampaignManagementRecommendationAssetProperty
property:
  path: assetName
  name: asset name
  datatype: string
  max count: 1
property:
  path: assetProperty
  name: asset property
  datatype: string
  max count: 1
property:
  path: value
  name: value
  datatype: string
  max count: 1

CampaignManagementRecommendationBackgroundShape
type: NodeShape
target class: CampaignManagementRecommendationBackground
property:
  path: editable
  name: editable
  datatype: boolean
  max count: 1

CampaignManagementRecommendationColorShape
type: NodeShape
target class: CampaignManagementRecommendationColor
property:
  path: elementName
  name: element name
  datatype: string
  max count: 1
property:
  path: suffix
  name: suffix
  datatype: string
  max count: 1
property:
  path: editable
  name: editable
  datatype: boolean
  max count: 1
property:
  path: color
  name: color
  datatype: string
  max count: 1

CampaignManagementAdRecommendationJobInfoShape
type: NodeShape
target class: CampaignManagementAdRecommendationJobInfo
property:
  path: jobId
  name: job id
  description: The unique identifier of the job.
  datatype: long
  max count: 1
property:
  path: jobStatus
  name: job status
  description: The status of the current job. Possible values are: Completed, InProgress, Failed.
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  description: The error code when the JobStatus is Failed.
  datatype: string
  max count: 1
property:
  path: errorMessage
  name: error message
  description: The error message when the JobStatus is Failed.
  datatype: string
  max count: 1

CampaignManagementAdRecommendationMediaRefineResultShape
type: NodeShape
target class: CampaignManagementAdRecommendationMediaRefineResult
property:
  path: mediaList
  name: media list
  description: List of ad recommendation refined media.
  node: CampaignManagementAdRecommendationRefinedMediaShape
  class: CampaignManagementAdRecommendationRefinedMedia
  node kind: BlankNodeOrIRI
property:
  path: errors
  name: errors
  description: An array of OperationError objects that contains the details that explain why the service operation failed.
  node: CampaignManagementOperationErrorShape
  class: CampaignManagementOperationError
  node kind: BlankNodeOrIRI

CampaignManagementAdRecommendationRefinedMediaShape
type: NodeShape
target class: CampaignManagementAdRecommendationRefinedMedia
property:
  path: mediaUrl
  name: media url
  description: The media URL.
  datatype: string
  max count: 1

CampaignManagementOperationErrorShape
type: NodeShape
target class: CampaignManagementOperationError
property:
  path: code
  name: code
  description: A numeric error code that identifies the error.
  datatype: int
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error. For example, UserIsNotAuthorized.
  datatype: string
  max count: 1
property:
  path: details
  name: details
  description: A message that provides additional details about the error. This string can be empty.
  datatype: string
  max count: 1
property:
  path: message
  name: message
  description: A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.
  datatype: string
  max count: 1

CampaignManagementAdRecommendationTextRefineOperationShape
type: NodeShape
target class: CampaignManagementAdRecommendationTextRefineOperation
property:
  path: textField
  name: text field
  description: Reserved.
  datatype: string
  max count: 1
  in: Headline
  in: LongHeadline
  in: Description
  in: CallToAction
property:
  path: textFieldIndex
  name: text field index
  description: Reserved.
  datatype: int
  max count: 1
property:
  path: textTone
  name: text tone
  description: Reserved.
  datatype: string
  max count: 1
  in: Friendly
  in: Persuasive
  in: Cute
  in: Inspiring

CampaignManagementAdRecommendationTextRefineResultShape
type: NodeShape
target class: CampaignManagementAdRecommendationTextRefineResult
property:
  path: textAssetLinks
  name: text asset links
  description: List of text asset links.
  node: CampaignManagementAssetLinkShape
  class: CampaignManagementAssetLink
  node kind: BlankNodeOrIRI
property:
  path: errors
  name: errors
  description: An array of OperationError objects that contains the details that explain why the service operation failed.
  node: CampaignManagementOperationErrorShape
  class: CampaignManagementOperationError
  node kind: BlankNodeOrIRI

CampaignManagementAdRecommendationVideoSuggestionShape
type: NodeShape
target class: CampaignManagementAdRecommendationVideoSuggestion
property:
  path: video
  name: video
  description: Reserved.
  node: CampaignManagementVideoShape
  class: CampaignManagementVideo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: internalTemplate
  name: internal template
  node: CampaignManagementRecommendationTemplateVideoShape
  class: CampaignManagementRecommendationTemplateVideo
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementRecommendationTemplateVideoShape
type: NodeShape
target class: CampaignManagementRecommendationTemplateVideo
property:
  path: templateId
  name: template id
  datatype: string
  max count: 1
property:
  path: logo
  name: logo
  node: CampaignManagementRecommendationLogoShape
  class: CampaignManagementRecommendationLogo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: businessName
  name: business name
  node: CampaignManagementRecommendationBusinessNameShape
  class: CampaignManagementRecommendationBusinessName
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: duration
  name: duration
  datatype: int
  max count: 1
property:
  path: audio
  name: audio
  node: CampaignManagementRecommendationAudioShape
  class: CampaignManagementRecommendationAudio
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: width
  name: width
  datatype: int
  max count: 1
property:
  path: height
  name: height
  datatype: int
  max count: 1
property:
  path: backgroundColor
  name: background color
  node: CampaignManagementSolidBackgroundAssetShape
  class: CampaignManagementSolidBackgroundAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: scenes
  name: scenes
  node: CampaignManagementRecommendationSceneShape
  class: CampaignManagementRecommendationScene
  node kind: BlankNodeOrIRI

CampaignManagementRecommendationLogoShape
type: NodeShape
target class: CampaignManagementRecommendationLogo
property:
  path: url
  name: url
  datatype: string
  max count: 1
property:
  path: display
  name: display
  datatype: boolean
  max count: 1

CampaignManagementRecommendationBusinessNameShape
type: NodeShape
target class: CampaignManagementRecommendationBusinessName
property:
  path: text
  name: text
  datatype: string
  max count: 1
property:
  path: display
  name: display
  datatype: boolean
  max count: 1

CampaignManagementRecommendationAudioShape
type: NodeShape
target class: CampaignManagementRecommendationAudio
property:
  path: category
  name: category
  datatype: string
  max count: 1
property:
  path: fileName
  name: file name
  datatype: string
  max count: 1
property:
  path: audioName
  name: audio name
  datatype: string
  max count: 1

CampaignManagementSolidBackgroundAssetShape
type: NodeShape
target class: CampaignManagementSolidBackgroundAsset
property:
  path: color
  name: color
  datatype: string
  max count: 1

CampaignManagementRecommendationSceneShape
type: NodeShape
target class: CampaignManagementRecommendationScene
property:
  path: image
  name: image
  datatype: string
  max count: 1
property:
  path: images
  name: images
  datatype: string
property:
  path: imageData
  name: image data
  node: CampaignManagementVideoRecommendationImageDataShape
  class: CampaignManagementVideoRecommendationImageData
  node kind: BlankNodeOrIRI
property:
  path: text
  name: text
  datatype: string
property:
  path: textData
  name: text data
  node: CampaignManagementVideoRecommendationTextDataShape
  class: CampaignManagementVideoRecommendationTextData
  node kind: BlankNodeOrIRI
property:
  path: logos
  name: logos
  datatype: string
property:
  path: logoData
  name: logo data
  node: CampaignManagementVideoRecommendationImageDataShape
  class: CampaignManagementVideoRecommendationImageData
  node kind: BlankNodeOrIRI
property:
  path: keyFrame
  name: key frame
  node: CampaignManagementKeyFrameShape
  class: CampaignManagementKeyFrame
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: colors
  name: colors
  datatype: string
property:
  path: colorData
  name: color data
  node: CampaignManagementVideoRecommendationColorDataShape
  class: CampaignManagementVideoRecommendationColorData
  node kind: BlankNodeOrIRI

CampaignManagementVideoRecommendationImageDataShape
type: NodeShape
target class: CampaignManagementVideoRecommendationImageData
property:
  path: width
  name: width
  datatype: int
  max count: 1
property:
  path: height
  name: height
  datatype: int
  max count: 1
property:
  path: itemId
  name: item id
  datatype: string
  max count: 1
property:
  path: croppedImageUrl
  name: cropped image url
  datatype: string
  max count: 1
property:
  path: videoClipUrl
  name: video clip url
  datatype: string
  max count: 1
property:
  path: isVideoFeasible
  name: is video feasible
  datatype: boolean
  max count: 1

CampaignManagementVideoRecommendationTextDataShape
type: NodeShape
target class: CampaignManagementVideoRecommendationTextData
property:
  path: font
  name: font
  datatype: string
  max count: 1
property:
  path: fontWeight
  name: font weight
  datatype: string
  max count: 1
property:
  path: color
  name: color
  datatype: string
  max count: 1
property:
  path: maxLength
  name: max length
  datatype: int
  max count: 1
property:
  path: itemId
  name: item id
  datatype: string
  max count: 1
property:
  path: hint
  name: hint
  datatype: string
  max count: 1

CampaignManagementKeyFrameShape
type: NodeShape
target class: CampaignManagementKeyFrame
property:
  path: templateId
  name: template id
  datatype: string
  max count: 1
property:
  path: url
  name: url
  datatype: string
  max count: 1
property:
  path: keyframeTimestamp
  name: keyframe timestamp
  datatype: double
  max count: 1

CampaignManagementVideoRecommendationColorDataShape
type: NodeShape
target class: CampaignManagementVideoRecommendationColorData
property:
  path: color
  name: color
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementAgeCriterionShape
type: NodeShape
target class: CampaignManagementAgeCriterion
property:
  path: type
  name: type
  description: The type of the criterion. This value is Age when you retrieve an age criterion. For more information about criterion types, see the Criterion Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: ageRange
  name: age range
  description: The age range of the people you want to see your ads. Add: Required Update: Not allowed. If you specify this element it must match the existing setting.
  datatype: string
  max count: 1
  in: Unknown
  in: EighteenToTwentyFour
  in: TwentyFiveToThirtyFour
  in: ThirtyFiveToFourtyNine
  in: FiftyToSixtyFour
  in: SixtyFiveAndAbove
  in: ThirtyFiveToFiftyFour
  in: FiftyFiveAndAbove

CampaignManagementAgeDimensionShape
type: NodeShape
target class: CampaignManagementAgeDimension
property:
  path: type
  name: type
  description: The type of audience dimensions, the following dimension types are supported as of now: Age, Gender, Audience. Add: For more information about audience types, see the Remarks. Update: For more information about audience types, see the Remarks.
  datatype: string
  max count: 1
  in: Age
  in: Gender
  in: Audience
  in: Profile
property:
  path: ageRanges
  name: age ranges
  description: A list of age ranges. To remove existing values, set AgeRanges to null or empty. To remove a subset of age ranges, specify the age ranges that you want to keep and the existing age ranges will be replaced. Add: Required Update: Optional.
  datatype: string
  in: Unknown
  in: EighteenToTwentyFour
  in: TwentyFiveToThirtyFour
  in: ThirtyFiveToFourtyNine
  in: FiftyToSixtyFour
  in: SixtyFiveAndAbove
  in: ThirtyFiveToFiftyFour
  in: FiftyFiveAndAbove

CampaignManagementAISearchSettingShape
type: NodeShape
target class: CampaignManagementAISearchSetting
property:
  path: type
  name: type
  description: The type of setting. For more information, see Setting Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: finalUrlExpansionOptOut
  name: final url expansion opt out
  description: Opt out of final URL expansion.
  datatype: boolean
  max count: 1
property:
  path: autoGeneratedTextOptOut
  name: auto generated text opt out
  description: Opt out of auto-generated text.
  datatype: boolean
  max count: 1
property:
  path: autoGeneratedImageOptOut
  name: auto generated image opt out
  description: Opt out of auto-generated images.
  datatype: boolean
  max count: 1
property:
  path: searchTermMatchingOptOut
  name: search term matching opt out
  description: Opt out of search term matching.
  datatype: boolean
  max count: 1
property:
  path: aISearchEnabled
  name: a isearch enabled
  description: Enable AI search.
  datatype: boolean
  max count: 1
property:
  path: pageFeedIds
  name: page feed ids
  description: The page feed IDs.
  datatype: long

CampaignManagementAnnotationOptOutShape
type: NodeShape
target class: CampaignManagementAnnotationOptOut
property:
  path: customerId
  name: customer id
  description: The customer ID.
  datatype: long
  max count: 1
property:
  path: accountId
  name: account id
  description: The account ID.
  datatype: long
  max count: 1
property:
  path: isOptOut
  name: is opt out
  description: Whether or not the entity is opted out.
  datatype: boolean
  max count: 1
property:
  path: annotationGroupId
  name: annotation group id
  description: The annotation group ID. The possible values are: 17000 - Dynamic Locations17001 - Consumer Ratings17002 - Dynamic Ad Enhancements 17003 - Dynamic Callouts17004 - Dynamic Partner Data enhancements17005 - Dynamic Sitelink17006 - Dynamic Structured Snippets17007 - Longer Ad Headlines17008 - Previous Visit17009 - Seller Ratings17011 - Dynamic Multimedia Extensions17013 - Syndication Only Decorations 17014 - Business Logo
  datatype: long
  max count: 1

CampaignManagementApiFaultDetailShape
type: NodeShape
target class: CampaignManagementApiFaultDetail
property:
  path: trackingId
  name: tracking id
  description: The identifier of the log entry that contains the details of the API call.
  datatype: string
  max count: 1
property:
  path: batchErrors
  name: batch errors
  description: An array of batch errors that identifies the items in the batch of items in the request message that caused the operation to fail. Each object contains the details that explain why the item caused the failure.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI
property:
  path: operationErrors
  name: operation errors
  description: An array of operation errors that contains the reasons that explain why the service operation failed when the error is not related to a specific item in the batch of items.
  node: CampaignManagementOperationErrorShape
  class: CampaignManagementOperationError
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementAppAdExtensionShape
type: NodeShape
target class: CampaignManagementAppAdExtension
property:
  path: status
  name: status
  description: The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Deleted
property:
  path: scheduling
  name: scheduling
  description: Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads. Add: Optional Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. To remove all scheduling set this element to an empty Schedule object.
  node: CampaignManagementScheduleShape
  class: CampaignManagementSchedule
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: devicePreference
  name: device preference
  description: This element determines whether the preference is for the ad extension to be displayed on mobile devices or all devices. To specify a preference for mobile devices, set this element to 30001. To specify all devices, set this element to 0 (zero) or leave the element nil. By default, this element will be nil. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: long
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad extension. Add: Read-only Update: Read-only and Required
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad extension. This value is AppAdExtension when you retrieve an app ad extension. Add: Read-only Update: Read-only For more information about ad extension types, see the Ad Extension Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Tracks the number of times the ad extension has been updated. The version is set to 1 when the ad extension is created, and increments by one after each update. Add: Not allowed Update: Not allowed
  datatype: int
  max count: 1
property:
  path: appPlatform
  name: app platform
  description: The application platform. Possible values include iOS, Android, and Windows. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: appStoreId
  name: app store id
  description: The application identifier provided by the app store. If the application is new, please expect to wait 4-7 days before the ad will be eligible to deliver. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: displayText
  name: display text
  description: The text displayed in the app ad extension. The text can contain a maximum of 35 characters. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: destinationUrl
  name: destination url
  description: The URL of the app store download webpage that users are taken to when they click the app extension link. The URL can contain dynamic text strings such as {keyword}. For a list of supported parameters, see the Available parameters section within the Microsoft Advertising help article What tracking or URL parameters can I use?. The URL can contain a maximum of 1,024 characters. If the URL does not specify a protocol, the system uses the HTTP protocol when a user clicks the ad. If the URL specifies the HTTP protocol when you add an ad, the service will remove the http:// protocol string (the HTTP protocol string does not count against the 1,024 character limit); however, the service will not remove an HTTPS protocol string (https://) from the URL. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: Reserved for future use.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: Reserved for future use.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Reserved for future use.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: Reserved for future use.
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: Reserved for future use.
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  description: For future use.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. There are currently no forward compatibility changes for the AdExtension object. Add: Read-only Update: Read-only
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementAppDownloadGoalShape
type: NodeShape
target class: CampaignManagementAppDownloadGoal
property:
  path: name
  name: name
  description: The conversion goal name. The maximum length of the name is 100, and the name must be unique among all conversion goals belonging to the same customer. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Defines the possible user-determined status values of a conversion goal. These are the status values that a user can decide to set, for example a goal can be set to Paused if you no longer wish to track conversions for that goal. For status values that can be set by the system, see the TrackingStatus element. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: scope
  name: scope
  description: Determines if the goal applies to all accounts or only the account specified in the required CustomerAccountId header element. If you have multiple Microsoft Advertising accounts, you can track conversions across all of those accounts. If you associate a goal with one account, conversions will be tracked for that account only. For app install goals the Account level scope is not supported. You can set this element to Customer or leave it nil. If not specified, the scope will be set to Customer by default. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: countType
  name: count type
  description: Not applicable for app install goals.
  datatype: string
  max count: 1
  in: All
  in: Unique
property:
  path: revenue
  name: revenue
  description: Determines how much each conversion is worth to your business. When adding a conversion goal if you do not specify any revenue tracking preferences, then each ConversionGoalRevenue will be set to their respective default values. When updating a conversion goal, if the Revenue element is nil or empty then none of the nested properties will be updated. However, if this element is not nil or empty then you are effectively replacing any existing revenue properties. The VariableValue option is not available for app install conversion goals. Add: Optional Update: Optional
  node: CampaignManagementConversionGoalRevenueShape
  class: CampaignManagementConversionGoalRevenue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: conversionWindowInMinutes
  name: conversion window in minutes
  description: The conversion window is the length of time in minutes after a click that you want to track conversions. If you set this value to 43200 minutes (30 days), then conversions that happen within 30 days after a click are tracked. Past conversions aren't affected. The minimum value supported is 1 minute, although keep in mind that a shorter conversion window will reduce the number of conversions your account records. The maximum value supported is 129600 minutes (90 days). Add: Optional Update: Optional
  datatype: int
  max count: 1
property:
  path: tagId
  name: tag id
  description: Not applicable for app install goals.
  datatype: long
  max count: 1
property:
  path: trackingStatus
  name: tracking status
  description: Defines the possible system-determined status values of a conversion goal. These are the status values that can be set by the system, for example the system sets the status to RecordingConversions if we have recorded conversions within the last 7 days. Only the NoRecentConversions and RecordingConversions statuses are applicable for app install conversion goals. For status values that a user can decide to set, for example setting the status to Paused if you no longer wish to track conversions for that goal, see the Status element. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: TagUnverified
  in: NoRecentConversions
  in: RecordingConversions
  in: TagInactive
  in: InactiveDueToTagUnavailable
property:
  path: excludeFromBidding
  name: exclude from bidding
  description: Determines whether or not to exclude data otherwise related to this conversion goal from a subset of performance report columns. This element is only available for customers who are enabled for the Include in Conversions feature (GetCustomerPilotFeatures returns 574). If this element is set to true, data otherwise related to this conversion goal will be excluded from the Conversions, ConversionRate, CostPerConversion, ReturnOnAdSpend, RevenuePerConversion, and Revenue report columns. Also, if you use an automated bidding bid strategy, setting this property true will result in the goal's conversions no longer factoring into automated bidding calculations. Setting this property "true" is effectively the same as unchecking "Include in Conversions" in the Microsoft Advertising web application. Regardless of this element value, the AllConversions, AllConversionRate, AllCostPerConversion, AllReturnOnAdSpend, AllRevenuePerConversion, and AllRevenue report columns will include data for all conversion goals. By default this element is false, and data related to this conversion goal are included in all report columns. For more information, see Report Attributes and Performance Statistics and the help article Conversion goals: "Conversions" versus "All conversions". Add: Optional Update: Optional
  datatype: boolean
  max count: 1
property:
  path: viewThroughConversionWindowInMinutes
  name: view through conversion window in minutes
  description: Not applicable for app install goals.
  datatype: int
  max count: 1
property:
  path: goalCategory
  name: goal category
  description: The category used to segment the conversion goal. Categorize your conversion goals however makes sense for your business. Goal categories don't affect performance - they are here to help you segment your goals and their performance metrics. The supported category values vary by conversion goal type. App install goals only support the Download category. Add: Optional. If you leave this element nil or empty, the default category will be set to Download. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Unknown
  in: None
  in: Purchase
  in: AddToCart
  in: BeginCheckout
  in: Subscribe
  in: SubmitLeadForm
  in: BookAppointment
  in: Signup
  in: RequestQuote
  in: GetDirections
  in: OutboundClick
  in: Contact
  in: PageView
  in: Download
  in: Other
property:
  path: attributionModelType
  name: attribution model type
  description: Not applicable for app install goals.
  datatype: string
  max count: 1
  in: LastClick
  in: LastTouch
  in: DataDriven
property:
  path: isEnhancedConversionsEnabled
  name: is enhanced conversions enabled
  description: Determines whether enhanced conversions are enabled for a conversion goal.
  datatype: boolean
  max count: 1
property:
  path: isAutoGoal
  name: is auto goal
  description: Only available for event goal.
  datatype: boolean
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the conversion goal. Add: Read-only Update: Required and Read-Only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the conversion goal. This value is AppInstall when you retrieve an app install goal. For more information about conversion goal types, see the ConversionGoal Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: appPlatform
  name: app platform
  description: The application platform. Possible values include Android, iOS, Windows and WindowsPhone. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: appStoreId
  name: app store id
  description: The application identifier provided by the app store. Add: Required Update: Optional
  datatype: string
  max count: 1

CampaignManagementAppealEditorialRejectionsRequestShape
type: NodeShape
target class: CampaignManagementAppealEditorialRejectionsRequest
property:
  path: entityIdToParentIdAssociations
  name: entity id to parent id associations
  description: A list of unique identifiers of the ads or keywords that failed editorial review. The list can contain a maximum of 1,000 EntityIdToParentIdAssociation objects. You submit each ad or keyword identifier with their respective ad group parent identifier in a EntityIdToParentIdAssociation object. The list of EntityIdToParentIdAssociation must include either ad identifiers or keyword identifiers. The list cannot include a mix ad and keyword entity identifiers. If an entity in the list has already been approved, the entity is ignored. If an entity in the list is not appealable, the call fails. If an entity in the list has an appeal pending, this request supersedes the pending request. Note: To support AssetGroups, EntityId = AssetGroupId and ParentId = CampaignId. For asset group appeals, we limit the amount of objects to 100 instead of 1,000.
  node: CampaignManagementEntityIdToParentIdAssociationShape
  class: CampaignManagementEntityIdToParentIdAssociation
  node kind: BlankNodeOrIRI
property:
  path: entityType
  name: entity type
  description: The type of entity that the entity to parent list contains. The supported entity type values are Ad, AdGroup, AssetGroup, Campaign, ImageAsset, Keyword, and TextAsset.
  datatype: string
  max count: 1
  in: None
  in: Campaign
  in: AdGroup
  in: Ad
  in: Keyword
  in: AssetGroup
  in: TextAsset
  in: ImageAsset
property:
  path: justificationText
  name: justification text
  description: The justification for the appeal. The string can contain a maximum of 1,000 characters. The justification applies to all of the specified entities. A useful justification should include reasons why the ad or keyword is compliant with editorial policy for example, JustificationText = "my ads for paint guns are not firearms, they are painting tools".
  datatype: string
  max count: 1

CampaignManagementEntityIdToParentIdAssociationShape
type: NodeShape
target class: CampaignManagementEntityIdToParentIdAssociation
property:
  path: entityId
  name: entity id
  description: The system-generated unique identifier of an entity such as ad or keyword.
  datatype: long
  max count: 1
property:
  path: parentId
  name: parent id
  description: The identifier of the entity's parent. An ad group is the parent of an ad or keyword.
  datatype: long
  max count: 1

CampaignManagementAppealEditorialRejectionsResponseShape
type: NodeShape
target class: CampaignManagementAppealEditorialRejectionsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any appeals that were not successfully submitted. The list of errors corresponds directly to the list of EntityIdToParentIdAssociation in the request. Items of the list may be returned as null. For each list index where an appeal was successfully submitted, the corresponding error element will be null. Ideally all appeals are submitted successfully and all elements in this list are null.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAppInstallAdShape
type: NodeShape
target class: CampaignManagementAppInstallAd
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the ad. Add: Read-only Update: Required and Read-only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad. This value is AppInstall when you retrieve an app install ad. For more information about ad types, see the Ad Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Text
  in: Image
  in: Product
  in: AppInstall
  in: ExpandedText
  in: DynamicSearch
  in: ResponsiveAd
  in: ResponsiveSearch
  in: Hotel
property:
  path: status
  name: status
  description: The status of the ad. You can set the ad status to Active or Paused. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Inactive
  in: Active
  in: Paused
  in: Deleted
property:
  path: editorialStatus
  name: editorial status
  description: The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: devicePreference
  name: device preference
  description: This element determines whether the preference is for app install ads to be displayed on mobile and tablet devices or only on mobile devices. (App install ads are not currently supported on desktop computers.) To specify a preference for mobile devices only (i.e. excluding tablets), set this element to 30001. To specify a preference for both mobile and tablet devices, set this element to 0 (zero) or leave the element nil. By default, this element will be nil. Add: Optional Update: Optional
  datatype: long
  max count: 1
property:
  path: adFormatPreference
  name: ad format preference
  description: Not supported for this ad type.
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for the URL specified with FinalUrls. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: The URL where a search user lands and can choose to install an app. Add: Required Update: Optional
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: Not supported for app install ads.
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  description: Not supported for app install ads.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. There are currently not any ForwardCompatibilityMap key and value pairs that are applicable for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: appPlatform
  name: app platform
  description: The application platform. Possible values include iOS and Android. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: appStoreId
  name: app store id
  description: The application identifier provided by the app store. If the application is new, please expect to wait 4-7 days before the ad will be eligible to deliver. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: title
  name: title
  description: The title of the ad. The title must contain at least one word. The ad's copy and title combined must total at least three words. The title cannot contain dynamic text strings such as {keyword}. The maximum input length of the title is 25 characters. Note that for ad groups that use Traditional Chinese, the title is limited to 15 characters. The title cannot contain the newline (\n) character. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: text
  name: text
  description: The ad copy. The copy must contain at least one word. The ad's copy and title combined must total at least three words. The ad copy cannot contain dynamic text strings such as {keyword}. The maximum input length of the copy is 71 characters. Note that for ad groups that use Traditional Chinese, the text is limited to 38 characters. The ad copy cannot contain the newline (\n) character. Add: Required Update: Optional
  datatype: string
  max count: 1

CampaignManagementAppInstallGoalShape
type: NodeShape
target class: CampaignManagementAppInstallGoal
property:
  path: name
  name: name
  description: The conversion goal name. The maximum length of the name is 100, and the name must be unique among all conversion goals belonging to the same customer. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Defines the possible user-determined status values of a conversion goal. These are the status values that a user can decide to set, for example a goal can be set to Paused if you no longer wish to track conversions for that goal. For status values that can be set by the system, see the TrackingStatus element. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: scope
  name: scope
  description: Determines if the goal applies to all accounts or only the account specified in the required CustomerAccountId header element. If you have multiple Microsoft Advertising accounts, you can track conversions across all of those accounts. If you associate a goal with one account, conversions will be tracked for that account only. For app install goals the Account level scope is not supported. You can set this element to Customer or leave it nil. If not specified, the scope will be set to Customer by default. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: countType
  name: count type
  description: Not applicable for app install goals.
  datatype: string
  max count: 1
  in: All
  in: Unique
property:
  path: revenue
  name: revenue
  description: Determines how much each conversion is worth to your business. When adding a conversion goal if you do not specify any revenue tracking preferences, then each ConversionGoalRevenue will be set to their respective default values. When updating a conversion goal, if the Revenue element is nil or empty then none of the nested properties will be updated. However, if this element is not nil or empty then you are effectively replacing any existing revenue properties. The VariableValue option is not available for app install conversion goals. Add: Optional Update: Optional
  node: CampaignManagementConversionGoalRevenueShape
  class: CampaignManagementConversionGoalRevenue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: conversionWindowInMinutes
  name: conversion window in minutes
  description: The conversion window is the length of time in minutes after a click that you want to track conversions. If you set this value to 43200 minutes (30 days), then conversions that happen within 30 days after a click are tracked. Past conversions aren't affected. The minimum value supported is 1 minute, although keep in mind that a shorter conversion window will reduce the number of conversions your account records. The maximum value supported is 129600 minutes (90 days). Add: Optional Update: Optional
  datatype: int
  max count: 1
property:
  path: tagId
  name: tag id
  description: Not applicable for app install goals.
  datatype: long
  max count: 1
property:
  path: trackingStatus
  name: tracking status
  description: Defines the possible system-determined status values of a conversion goal. These are the status values that can be set by the system, for example the system sets the status to RecordingConversions if we have recorded conversions within the last 7 days. Only the NoRecentConversions and RecordingConversions statuses are applicable for app install conversion goals. For status values that a user can decide to set, for example setting the status to Paused if you no longer wish to track conversions for that goal, see the Status element. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: TagUnverified
  in: NoRecentConversions
  in: RecordingConversions
  in: TagInactive
  in: InactiveDueToTagUnavailable
property:
  path: excludeFromBidding
  name: exclude from bidding
  description: Determines whether or not to exclude data otherwise related to this conversion goal from a subset of performance report columns. This element is only available for customers who are enabled for the Include in Conversions feature (GetCustomerPilotFeatures returns 574). If this element is set to true, data otherwise related to this conversion goal will be excluded from the Conversions, ConversionRate, CostPerConversion, ReturnOnAdSpend, RevenuePerConversion, and Revenue report columns. Also, if you use an automated bidding bid strategy, setting this property true will result in the goal's conversions no longer factoring into automated bidding calculations. Setting this property "true" is effectively the same as unchecking "Include in Conversions" in the Microsoft Advertising web application. Regardless of this element value, the AllConversions, AllConversionRate, AllCostPerConversion, AllReturnOnAdSpend, AllRevenuePerConversion, and AllRevenue report columns will include data for all conversion goals. By default this element is false, and data related to this conversion goal are included in all report columns. For more information, see Report Attributes and Performance Statistics and the help article Conversion goals: "Conversions" versus "All conversions". Add: Optional Update: Optional
  datatype: boolean
  max count: 1
property:
  path: viewThroughConversionWindowInMinutes
  name: view through conversion window in minutes
  description: Not applicable for app install goals.
  datatype: int
  max count: 1
property:
  path: goalCategory
  name: goal category
  description: The category used to segment the conversion goal. Categorize your conversion goals however makes sense for your business. Goal categories don't affect performance - they are here to help you segment your goals and their performance metrics. The supported category values vary by conversion goal type. App install goals only support the Download category. Add: Optional. If you leave this element nil or empty, the default category will be set to Download. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Unknown
  in: None
  in: Purchase
  in: AddToCart
  in: BeginCheckout
  in: Subscribe
  in: SubmitLeadForm
  in: BookAppointment
  in: Signup
  in: RequestQuote
  in: GetDirections
  in: OutboundClick
  in: Contact
  in: PageView
  in: Download
  in: Other
property:
  path: attributionModelType
  name: attribution model type
  description: Not applicable for app install goals.
  datatype: string
  max count: 1
  in: LastClick
  in: LastTouch
  in: DataDriven
property:
  path: isEnhancedConversionsEnabled
  name: is enhanced conversions enabled
  description: Determines whether enhanced conversions are enabled for a conversion goal.
  datatype: boolean
  max count: 1
property:
  path: isAutoGoal
  name: is auto goal
  description: Only available for event goal.
  datatype: boolean
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the conversion goal. Add: Read-only Update: Required and Read-Only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the conversion goal. This value is AppInstall when you retrieve an app install goal. For more information about conversion goal types, see the ConversionGoal Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: appPlatform
  name: app platform
  description: The application platform. Possible values include Android, iOS, Windows and WindowsPhone. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: appStoreId
  name: app store id
  description: The application identifier provided by the app store. Add: Required Update: Optional
  datatype: string
  max count: 1

CampaignManagementApplicationFaultShape
type: NodeShape
target class: CampaignManagementApplicationFault
property:
  path: trackingId
  name: tracking id
  description: The identifier of the log entry that contains the details of the API call.
  datatype: string
  max count: 1
property:
  path: errors
  name: errors
  node: CampaignManagementAdApiErrorShape
  class: CampaignManagementAdApiError
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: editorialErrors
  name: editorial errors
  node: CampaignManagementEditorialErrorShape
  class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI
property:
  path: batchErrors
  name: batch errors
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI
property:
  path: operationErrors
  name: operation errors
  node: CampaignManagementOperationErrorShape
  class: CampaignManagementOperationError
  node kind: BlankNodeOrIRI
property:
  path: errorMessage
  name: error message
  datatype: string
  max count: 1
property:
  path: mTServerName
  name: m tserver name
  datatype: string
  max count: 1
property:
  path: faultingLayer
  name: faulting layer
  datatype: string
  max count: 1
  in: MiddleTier
  in: Database
  in: Editorial
  in: Authentication
  in: Authorization
  in: Publisher
  in: AudienceInteligence
  in: Cam
  in: Dam
  in: FlexTag
  in: BingMerchantCenter
property:
  path: errorSourceSystem
  name: error source system
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  datatype: string
  max count: 1
  in: NoCredential
  in: InvalidCustomerId
  in: InvalidSecurityTicket

CampaignManagementEditorialErrorShape
type: NodeShape
target class: CampaignManagementEditorialError
property:
  path: index
  name: index
  description: The zero-based index of the item in the batch of items in the request message that failed.
  datatype: int
  max count: 1
property:
  path: disapprovedText
  name: disapproved text
  description: The text that caused the entity to be disapproved. For text length violations, this element specifies the number of characters by which the specified text exceeds the maximum.
  datatype: string
  max count: 1
property:
  path: reasonCode
  name: reason code
  description: A numeric code that identifies the error. For more information, see Editorial Reason Codes.
  datatype: int
  max count: 1
property:
  path: location
  name: location
  description: The element or property of the entity that caused the entity to be disapproved.
  datatype: string
  max count: 1
property:
  path: publisherCountry
  name: publisher country
  description: The corresponding country or region for the flagged editorial issue.
  datatype: string
  max count: 1
property:
  path: fieldPath
  name: field path
  description: The name of the data object's element where the error occurred. For example if the TrackingUrlTemplate of a Campaign contains invalid text, the value of this FieldPath element is TrackingUrlTemplate. This value is subject to change, so you should not take a dependency on the current string format. This element is not supported for all errors. The field path is supported for errors related to FinalMobileUrls, FinalUrls, TrackingUrlTemplate, and UrlCustomParameters elements of the respective Campaign, AdGroup, TextAd, ProductAd, BiddableAdGroupCriterion, and Keyword objects. It is also supported for errors related to all fields of the CalloutAdExtension and ReviewAdExtension objects.
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error. For example, UserIsNotAuthorized.
  datatype: string
  max count: 1
property:
  path: message
  name: message
  description: A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.
  datatype: string
  max count: 1
property:
  path: code
  name: code
  description: A numeric error code that identifies the error.
  datatype: int
  max count: 1
property:
  path: details
  name: details
  description: A message that provides additional details about the batch error. This string can be empty.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Reserved for internal use.
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this data object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: appealable
  name: appealable
  description: Reserved for future use.
  datatype: boolean
  max count: 1

CampaignManagementApplicationFaultBaseShape
type: NodeShape
target class: CampaignManagementApplicationFaultBase
property:
  path: trackingId
  name: tracking id
  datatype: string
  max count: 1

CampaignManagementApplyAssetGroupListingGroupActionsRequestShape
type: NodeShape
target class: CampaignManagementApplyAssetGroupListingGroupActionsRequest
property:
  path: listingGroupActions
  name: listing group actions
  description: A list of AssetGroupListingGroupAction objects that each contain an Action element and a ListingGroup element. All of the asset group listing group actions must be for the same asset group. You can pass 5,000 AssetGroupListingGroupAction per call and apply a maximum of 20,000 listing groups to each asset group.
  node: CampaignManagementAssetGroupListingGroupActionShape
  class: CampaignManagementAssetGroupListingGroupAction
  node kind: BlankNodeOrIRI

CampaignManagementAssetGroupListingGroupActionShape
type: NodeShape
target class: CampaignManagementAssetGroupListingGroupAction
property:
  path: action
  name: action
  description: The action to be applied for the AssetGroupListingGroup.
  datatype: string
  max count: 1
  in: Add
  in: Delete
  in: Update
property:
  path: listingGroup
  name: listing group
  description: The AssetGroupListingGroup to apply action to. Update is not supported for listing group, To update the order or structure of the listing group, you cannot use the update action. You must delete existing listing groups and then add new listing groups instead.
  node: CampaignManagementAssetGroupListingGroupShape
  class: CampaignManagementAssetGroupListingGroup
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementAssetGroupListingGroupShape
type: NodeShape
target class: CampaignManagementAssetGroupListingGroup
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the AssetGroupListingGroup. Add: Read-only Update: Read-only
  datatype: long
  max count: 1
property:
  path: assetGroupId
  name: asset group id
  description: The identifier of the asset group this listing group belongs to. Add: Required Update: Not supported Delete: Required
  datatype: long
  max count: 1
property:
  path: assetGroupListingType
  name: asset group listing type
  description: The type of listing group, e.g., Subdivision or Unit. Add: Required Update: Not supported Delete: Optional
  datatype: string
  max count: 1
  in: Subdivision
  in: Unit
property:
  path: parentListingGroupId
  name: parent listing group id
  description: The identifier of the parent listing group. This element must be set to null if the listing group node represents the root node of a listing group tree. Add: Required Update: Not supported Delete: Required
  datatype: long
  max count: 1
property:
  path: dimension
  name: dimension
  description: A condition that helps determine whether a product from the Microsoft Merchant Center store gets served as an ad. Multiple product conditions can be specified by creating a tree of AssetGroupListingGroup objects using ApplyAssetGroupListingGroupActions. For a catalog item to be served as an ad, it must meet all conditions. Add: Required Update: Not supported Delete: Optional
  node: CampaignManagementProductConditionShape
  class: CampaignManagementProductCondition
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: isExcluded
  name: is excluded
  description: Set to true If you want to exclude products specified by current. Otherwise, the products will be included. Default value is false. Add: Optional Update: Not supported Delete: Optional
  datatype: boolean
  max count: 1
property:
  path: listingGroupPath
  name: listing group path
  description: The path of a listing group node. Add: Read-only Update: Read-only Delete: Read-only
  datatype: string
  max count: 1

CampaignManagementApplyAssetGroupListingGroupActionsResponseShape
type: NodeShape
target class: CampaignManagementApplyAssetGroupListingGroupActionsResponse
property:
  path: assetGroupListingGroupIds
  name: asset group listing group ids
  description: A list of IDs that for the listing groups that had the action applied. The list of IDs corresponds directly to the list of listing groups in the request. If any listing group action failed, then all remaining listing group actions will fail and all elements in this list will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that weren't successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementApplyCustomerListItemsRequestShape
type: NodeShape
target class: CampaignManagementApplyCustomerListItemsRequest
property:
  path: customerListAudience
  name: customer list audience
  description: The customer list associated with the audience.
  node: CampaignManagementCustomerListShape
  class: CampaignManagementCustomerList
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementCustomerListShape
type: NodeShape
target class: CampaignManagementCustomerList
property:
  path: scope
  name: scope
  description: Scope defines what accounts can use this audience. If scope is set to Account, the audience can only be associated with campaigns and ad groups in one account i.e., via the ParentId. If scope is set to Customer, the audience can be associated with campaigns and ad groups in all of the customer's accounts. Add: Required Update: Optional. You can change the scope from Account to Customer, but you cannot change the scope from Customer to Account.
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: membershipDuration
  name: membership duration
  description: When you create an audience, you can specify how far back in time Microsoft Advertising should look for actions that match your audience definition. The minimum duration is 1 day and the maximum duration allowed is 390 days. You can also set the duration to -1 for no expiration. Add: Optional. If not specified, the membership duration will be set to 30 by default. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: int
  max count: 1
property:
  path: searchSize
  name: search size
  description: The total number of people who are active members of this audience in the Search network. This gives you an idea of how many search users you can target. The audience needs to have at least 300 people before Microsoft Advertising will use it for optimizations. This property will be nil or empty for up to 48 hours while the audience is being built, for example if you add or update the customer list membership duration. Add: Read-only Update: Read-only
  datatype: long
  max count: 1
property:
  path: audienceNetworkSize
  name: audience network size
  description: The total number of people who are active members of this audience in the Audience network. This gives you an idea of how many Audience network users you can target. The audience needs to have at least 300 people before Microsoft Advertising will use it for optimizations. Add: Read-only Update: Read-only
  datatype: long
  max count: 1
property:
  path: supportedCampaignTypes
  name: supported campaign types
  description: The list of campaign types that support this audience. Supported values are Audience, DynamicSearchAds, Search, and Shopping. New campaign types might be added in the future, so you should not take any dependency on a fixed set of values. Add: Read-only Update: Read-only
  datatype: string
property:
  path: customerShare
  name: customer share
  description: Determines the list of customers and accounts that share the audience. Details include audience association counts. Shared UET tags and audiences are only available for pilot customers. For an overview of sharing audiences and UET tags in a customer hierarchy, see the Share Audiences and UET Tags technical guide. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set this element to null or empty to retain any existing customer account shares. To remove all customer account shares, set the CustomerAccountShares element of the CustomerShare object to null or empty. To remove a subset of customer account shares, specify the customer account shares that you want to keep in the CustomerAccountShares element of the CustomerShare object.
  node: CampaignManagementCustomerShareShape
  class: CampaignManagementCustomerShare
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: The Microsoft Advertising identifier of the audience. Add: Read-only Update: Required and read-only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the audience. The name can contain a maximum of 128 characters. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description of the audience. Use a description to help you remember what audience you are targeting. The description can contain a maximum of 1,024 characters. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the audience. This value is CustomerList when you retrieve a customer list audience. For more information about audience types, see the Audience Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: parentId
  name: parent id
  description: The Microsoft Advertising identifier of the account or customer. If the Scope is set to Account, this is the account ID, and otherwise it is the customer ID. Add: Required Update: Read-only. You cannot change the parent ID.
  datatype: long
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for the Audience object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementApplyCustomerListItemsResponseShape
type: NodeShape
target class: CampaignManagementApplyCustomerListItemsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that weren't successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementApplyCustomerListUserDataRequestShape
type: NodeShape
target class: CampaignManagementApplyCustomerListUserDataRequest
property:
  path: customerListUserData
  name: customer list user data
  description: Defines the CustomerListUserData data object. You can specify one user data type in CustomerListItemSubtype. Use CustomerListActionType to specify the action type. Note: The maximum user data for CustomerListItems is 1000.
  node: CampaignManagementCustomerListUserDataShape
  class: CampaignManagementCustomerListUserData
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementCustomerListUserDataShape
type: NodeShape
target class: CampaignManagementCustomerListUserData
property:
  path: audienceId
  name: audience id
  description: The Microsoft Advertising assigned identifier of an audience, for example the customer list ID.
  datatype: long
  max count: 1
property:
  path: customerListItems
  name: customer list items
  description: An array of customer list items. When CustomerListItemSubType is "Email", each item must be a SHA-256 hashed email address (lowercase hexadecimal string of 64 characters). For example, the email test`@contoso`.com should be hashed as a8e34c39d390c30c3ff245256c46c7076cecb7dfcfd60f7534d1037e901fad76.
  datatype: string
property:
  path: customerListItemSubType
  name: customer list item sub type
  description: The user data type of the customer list item.
  datatype: string
  max count: 1
  in: Email
  in: CRM
  in: Phone
property:
  path: actionType
  name: action type
  description: The action type when uploading user data.
  datatype: string
  max count: 1
  in: None
  in: Add
  in: Remove
  in: Replace
property:
  path: acceptCustomerMatchTerm
  name: accept customer match term
  description: Optional flag to accept Customer Match terms for this request. - true: Accept terms and process customer data - false: Reject terms and return error 8003 (CustomerListTermsAndConditionsNotAccepted) - Not set: Fallback to previous behavior in which to accept terms through the Microsoft Advertising UI Add: Optional Update: Optional
  datatype: boolean
  max count: 1

CampaignManagementApplyCustomerListUserDataResponseShape
type: NodeShape
target class: CampaignManagementApplyCustomerListUserDataResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that weren't successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementApplyHotelGroupActionsRequestShape
type: NodeShape
target class: CampaignManagementApplyHotelGroupActionsRequest
property:
  path: criterionActions
  name: criterion actions
  description: A list of up to 5,000 AdGroupCriterionAction objects that each contain an Action element and a BiddableAdGroupCriterion. All of the ad group criterion actions must be for the same ad group. For more information including validation rules, please see Create a Microsoft Shopping campaign with the Campaign Management Service.
  node: CampaignManagementAdGroupCriterionActionShape
  class: CampaignManagementAdGroupCriterionAction
  node kind: BlankNodeOrIRI

CampaignManagementApplyHotelGroupActionsResponseShape
type: NodeShape
target class: CampaignManagementApplyHotelGroupActionsResponse
property:
  path: adGroupCriterionIds
  name: ad group criterion ids
  description: A list of identifiers that identify the criterion that had the action applied. The list of identifiers corresponds directly to the list of criterion in the request. If any criterion action failed, then all remaining criterion actions will fail, and all elements in this list will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request. For criterion which failed due to user error, an actionable error code will be returned. If any criterion action failed, then all remaining criterion actions will fail, and none of the elements in this list will be null. For criterion that might have otherwise succeeded, a generic error will be returned which explains that a related entity failed.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementApplyOfflineConversionAdjustmentsRequestShape
type: NodeShape
target class: CampaignManagementApplyOfflineConversionAdjustmentsRequest
property:
  path: offlineConversionAdjustments
  name: offline conversion adjustments
  description: The offline conversion adjustments to apply.
  node: CampaignManagementOfflineConversionAdjustmentShape
  class: CampaignManagementOfflineConversionAdjustment
  node kind: BlankNodeOrIRI

CampaignManagementOfflineConversionAdjustmentShape
type: NodeShape
target class: CampaignManagementOfflineConversionAdjustment
property:
  path: microsoftClickId
  name: microsoft click id
  description: The MSCLKID for the offline conversion. To ensure that auto-tagging is enabled for Microsoft click ID tracking, use the GetAccountProperties and SetAccountProperties operations. Apply: Optional Note: The MSCLKID is optional when you provide a hashed email address or phone number for enhanced conversions.
  datatype: string
  max count: 1
property:
  path: conversionName
  name: conversion name
  description: The conversion goal name. This name must match an existing conversion goal name, otherwise the offline conversion goal data will not be applied. Apply: Required
  datatype: string
  max count: 1
property:
  path: conversionTime
  name: conversion time
  description: The date and time when the original offline conversion occurred. The date and time must be within the last 90 days, otherwise the operation will fail when you attempt to send Microsoft Advertising the offline conversion data. To be counted by Microsoft Advertising as an offline conversion after successful upload, the following additional requirements must be met: - The date and time of the conversion must be set later than the date and time of the recorded click. - The date and time must be within the conversion window. The ConversionWindowInMinutes property of the OfflineConversionGoal determines the maximum length of time in minutes after a click that conversions will be tracked. For example if three clicks were recorded on April 30th, if the ConversionWindowInMinutes of the OfflineConversionGoal is equal to 30 days (43200 minutes), and if you send Microsoft Advertising the following offline conversions on July 31st, then Microsoft Advertising will only count the one with MicrosoftClickId=2 as an offline conversion. - MicrosoftClickId=1; ConversionTime=2020-04-30T17:02:35.6853793Z - MicrosoftClickId=2; ConversionTime=2020-05-15T17:02:35.6853793Z - MicrosoftClickId=3; ConversionTime=2020-06-15T17:02:35.6853793Z The offline conversion data with MicrosoftClickId=1 will not be uploaded since the conversion date and time is more than 90 days ago, and the offline conversion data with MicrosoftClickId=3 will not be counted because it does not fall within the conversion window (April 30 through May 29). Important: The value must be in Coordinated Universal Time (UTC). This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types. Apply: Required
  datatype: dateTime
  max count: 1
property:
  path: adjustmentTime
  name: adjustment time
  description: The date and time when the adjustment occurred. The adjustment time cannot be earlier than the original offline conversion date and time. Important: The value must be in Coordinated Universal Time (UTC). This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types. Apply: Required
  datatype: dateTime
  max count: 1
property:
  path: adjustmentType
  name: adjustment type
  description: Determines whether to retract or restate the offline conversion. If this value is "Restate", the offline conversion previously attributed to the specified MicrosoftClickId will be adjusted according to the new AdjustmentCurrencyCode, AdjustmentTime, and AdjustmentValue. If this value is "Retract", the offline conversion previously attributed to the specified MicrosoftClickId will be retracted or deleted. Apply: Required
  datatype: string
  max count: 1
property:
  path: adjustmentValue
  name: adjustment value
  description: The adjusted offline conversion value. Apply: Required if AdjustmentType is set to "Restate", and otherwise this field should not be set.
  datatype: double
  max count: 1
property:
  path: adjustmentCurrencyCode
  name: adjustment currency code
  description: The currency code for the restated offline conversion. For more information, see Currencies. Apply: Required if AdjustmentType is set to "Restate", and otherwise this field is ignored. If you do not specify an adjustment currency code with the restatement, then the CurrencyCode element of the goal's ConversionGoalRevenue is used.
  datatype: string
  max count: 1
property:
  path: hashedEmailAddress
  name: hashed email address
  description: The hashed email address using the SHA-256 algorithm for use with enhanced conversions.
  datatype: string
  max count: 1
property:
  path: hashedPhoneNumber
  name: hashed phone number
  description: The hashed phone number according to the E.164 standard for use with enhanced conversions.
  datatype: string
  max count: 1

CampaignManagementApplyOfflineConversionAdjustmentsResponseShape
type: NodeShape
target class: CampaignManagementApplyOfflineConversionAdjustmentsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementApplyOfflineConversionsRequestShape
type: NodeShape
target class: CampaignManagementApplyOfflineConversionsRequest
property:
  path: offlineConversions
  name: offline conversions
  description: The list of offline conversions for the account. You can add a maximum of 1,000 offline conversions per service request. Each offline conversion can be split across multiple click IDs. A single click ID can, however, be associated with multiple conversion goals and also be associated with the same goal multiple times, as long as the conversion time is different. Also, the same conversion can't be applied more than once. If you send Microsoft Advertising duplicates, the first instance will be used and the others will be ignored.
  node: CampaignManagementOfflineConversionShape
  class: CampaignManagementOfflineConversion
  node kind: BlankNodeOrIRI

CampaignManagementOfflineConversionShape
type: NodeShape
target class: CampaignManagementOfflineConversion
property:
  path: microsoftClickId
  name: microsoft click id
  description: The MSCLKID for the offline conversion. To ensure that auto-tagging is enabled for Microsoft click ID tracking, use the GetAccountProperties and SetAccountProperties operations. Apply: Optional Note: The MSCLKID is optional when you provide a hashed email address or phone number for enhanced conversions.
  datatype: string
  max count: 1
property:
  path: conversionName
  name: conversion name
  description: The conversion goal name. This name must match an existing conversion goal name, otherwise the offline conversion goal data will not be applied. Apply: Required
  datatype: string
  max count: 1
property:
  path: conversionTime
  name: conversion time
  description: The date and time when the offline conversion occurred. The date and time must be within the last 90 days, otherwise the operation will fail when you attempt to send Microsoft Advertising the offline conversion data. To be counted by Microsoft Advertising as an offline conversion after successful upload, the following additional requirements must be met: - The date and time of the conversion must be set later than the date and time of the recorded click. - The date and time must be within the conversion window. The ConversionWindowInMinutes property of the OfflineConversionGoal determines the maximum length of time in minutes after a click that conversions will be tracked. For example if three clicks were recorded on April 30th, if the ConversionWindowInMinutes of the OfflineConversionGoal is equal to 30 days (43200 minutes), and if you send Microsoft Advertising the following offline conversions on July 31st, then Microsoft Advertising will only count the one with MicrosoftClickId=2 as an offline conversion. - MicrosoftClickId=1; ConversionTime=2020-04-30T17:02:35.6853793Z - MicrosoftClickId=2; ConversionTime=2020-05-15T17:02:35.6853793Z - MicrosoftClickId=3; ConversionTime=2020-06-15T17:02:35.6853793Z The offline conversion data with MicrosoftClickId=1 will not be uploaded since the conversion date and time is more than 90 days ago, and the offline conversion data with MicrosoftClickId=3 will not be counted because it does not fall within the conversion window (April 30 through May 29). Important: The value must be in Coordinated Universal Time (UTC). This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types. Apply: Required
  datatype: dateTime
  max count: 1
property:
  path: conversionValue
  name: conversion value
  description: The offline conversion value. Apply: Optional. If you do not specify an offline conversion value, then the Value element of the goal's ConversionGoalRevenue is used.
  datatype: double
  max count: 1
property:
  path: conversionCurrencyCode
  name: conversion currency code
  description: The currency code for the offline conversion. For more information, see Currencies. Apply: Optional. If you do not specify an offline conversion currency code, then the CurrencyCode element of the goal's ConversionGoalRevenue is used.
  datatype: string
  max count: 1
property:
  path: externalAttributionCredit
  name: external attribution credit
  description: This field can only be set for conversions actions which use external attribution. It represents the fraction of the conversion that is attributed to each click. Its value must be greater than 0 and less than or equal to 1. A GoalNotEligibleForExternalAttribution error will be returned if this field is used with a non-externally attributed conversion action. Apply: Optional
  datatype: double
  max count: 1
property:
  path: externalAttributionModel
  name: external attribution model
  description: This field can only be set for conversions actions which use external attribution. It specifies the attribution model name. A GoalNotEligibleForExternalAttribution error will be returned if this field is used with a non-externally attributed conversion action. Apply: Optional
  datatype: string
  max count: 1
property:
  path: hashedEmailAddress
  name: hashed email address
  description: The hashed email address using the SHA-256 algorithm for use with enhanced conversions.
  datatype: string
  max count: 1
property:
  path: hashedPhoneNumber
  name: hashed phone number
  description: The hashed phone number according to the E.164 standard for use with enhanced conversions.
  datatype: string
  max count: 1

CampaignManagementApplyOfflineConversionsResponseShape
type: NodeShape
target class: CampaignManagementApplyOfflineConversionsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementApplyOnlineConversionAdjustmentsRequestShape
type: NodeShape
target class: CampaignManagementApplyOnlineConversionAdjustmentsRequest
property:
  path: onlineConversionAdjustments
  name: online conversion adjustments
  description: The online conversion adjustments to apply.
  node: CampaignManagementOnlineConversionAdjustmentShape
  class: CampaignManagementOnlineConversionAdjustment
  node kind: BlankNodeOrIRI

CampaignManagementOnlineConversionAdjustmentShape
type: NodeShape
target class: CampaignManagementOnlineConversionAdjustment
property:
  path: transactionId
  name: transaction id
  description: The ID for this transaction.
  datatype: string
  max count: 1
property:
  path: conversionName
  name: conversion name
  description: The conversion goal name. This name must match an existing conversion goal name, otherwise the online conversion goal data will not be applied. Apply: Required
  datatype: string
  max count: 1
property:
  path: adjustmentTime
  name: adjustment time
  description: The date and time when the adjustment occurred. The adjustment time cannot be earlier than the original offline conversion date and time. Important: The value must be in Coordinated Universal Time (UTC). This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types. Apply: Required
  datatype: dateTime
  max count: 1
property:
  path: adjustmentType
  name: adjustment type
  description: Determines whether to retract or restate the online conversion. If this value is "Restate", the offline conversion previously attributed to the specified MicrosoftClickId will be adjusted according to the new AdjustmentCurrencyCode, AdjustmentTime, and AdjustmentValue. If this value is "Retract", the offline conversion previously attributed to the specified MicrosoftClickId will be retracted or deleted. Apply: Required
  datatype: string
  max count: 1
property:
  path: adjustmentValue
  name: adjustment value
  description: The adjusted online conversion value. Apply: Required if AdjustmentType is set to "Restate", and otherwise this field should not be set.
  datatype: double
  max count: 1
property:
  path: adjustmentCurrencyCode
  name: adjustment currency code
  description: The currency code for the restated online conversion. For more information, see Currencies. Apply: Required if AdjustmentType is set to "Restate", and otherwise this field is ignored. If you do not specify an adjustment currency code with the restatement, then the CurrencyCode element of the goal's ConversionGoalRevenue is used.
  datatype: string
  max count: 1

CampaignManagementApplyOnlineConversionAdjustmentsResponseShape
type: NodeShape
target class: CampaignManagementApplyOnlineConversionAdjustmentsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementApplyProductPartitionActionsRequestShape
type: NodeShape
target class: CampaignManagementApplyProductPartitionActionsRequest
property:
  path: criterionActions
  name: criterion actions
  description: A list of up to 5,000 AdGroupCriterionAction objects that each contain an Action element and either a BiddableAdGroupCriterion or NegativeAdGroupCriterion. All of the ad group criterion actions must be for the same ad group. For more information including validation rules, please see Create a Microsoft Shopping campaign with the Campaign Management Service.
  node: CampaignManagementAdGroupCriterionActionShape
  class: CampaignManagementAdGroupCriterionAction
  node kind: BlankNodeOrIRI

CampaignManagementApplyProductPartitionActionsResponseShape
type: NodeShape
target class: CampaignManagementApplyProductPartitionActionsResponse
property:
  path: adGroupCriterionIds
  name: ad group criterion ids
  description: A list of identifiers that identify the criterion that had the action applied. The list of identifiers corresponds directly to the list of criterion in the request. If any criterion action failed, then all remaining criterion actions will fail, and all elements in this list will be null.
  datatype: long
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request. For criterion which failed due to user error, an actionable error code will be returned. If any criterion action failed, then all remaining criterion actions will fail, and none of the elements in this list will be null. For criterion that might have otherwise succeeded, a generic error will be returned which explains that a related entity failed.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementAppSettingShape
type: NodeShape
target class: CampaignManagementAppSetting
property:
  path: type
  name: type
  description: The type of setting. For more information, see Setting Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: appStore
  name: app store
  description: The app store where the app is distributed.
  datatype: string
  max count: 1
property:
  path: appId
  name: app id
  description: The unique identifier of the mobile app.
  datatype: string
  max count: 1

CampaignManagementAssetBaseShape
type: NodeShape
target class: CampaignManagementAssetBase
property:
  path: id
  name: id
  datatype: long
  max count: 1
property:
  path: name
  name: name
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementAssetGroupEditorialReasonShape
type: NodeShape
target class: CampaignManagementAssetGroupEditorialReason
property:
  path: reasonCode
  name: reason code
  description: A code that identifies the reason for the failure. For a list of possible reason codes, see Editorial Reason Codes.
  datatype: int
  max count: 1
property:
  path: location
  name: location
  description: The component of the asset group that failed editorial review.
  datatype: string
  max count: 1
property:
  path: term
  name: term
  description: The term that failed editorial review. This element will not be set if a combination of terms caused the failure or if the failure was based on a policy violation.
  datatype: string
  max count: 1
property:
  path: publisherCountries
  name: publisher countries
  description: The list of publisher countries or regions whose editorial guidelines do not allow the specified term.
  datatype: string

CampaignManagementAssetGroupEditorialReasonCollectionShape
type: NodeShape
target class: CampaignManagementAssetGroupEditorialReasonCollection
property:
  path: assetGroupId
  name: asset group id
  description: The identifier of the asset group that failed editorial review.
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: The identifier of the associated campaign.
  datatype: long
  max count: 1
property:
  path: reasons
  name: reasons
  description: A list of AssetGroupEditorialReason objects that identify the component of an asset group that failed editorial review, and the reason for the failure.
  node: CampaignManagementAssetGroupEditorialReasonShape
  class: CampaignManagementAssetGroupEditorialReason
  node kind: BlankNodeOrIRI
property:
  path: appealStatus
  name: appeal status
  description: A value that determines whether you can appeal the issues found by the editorial review.
  datatype: string
  max count: 1
  in: None
  in: Appealable
  in: AppealPending
  in: NotAppealable

CampaignManagementAudienceBaseShape
type: NodeShape
target class: CampaignManagementAudienceBase
property:
  path: scope
  name: scope
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: membershipDuration
  name: membership duration
  datatype: int
  max count: 1
property:
  path: searchSize
  name: search size
  datatype: long
  max count: 1
property:
  path: audienceNetworkSize
  name: audience network size
  datatype: long
  max count: 1
property:
  path: supportedCampaignTypes
  name: supported campaign types
  datatype: string
property:
  path: customerShare
  name: customer share
  node: CampaignManagementCustomerShareShape
  class: CampaignManagementCustomerShare
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  datatype: long
  max count: 1
property:
  path: name
  name: name
  datatype: string
  max count: 1
property:
  path: description
  name: description
  datatype: string
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: parentId
  name: parent id
  datatype: long
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementAudienceCriterionShape
type: NodeShape
target class: CampaignManagementAudienceCriterion
property:
  path: type
  name: type
  description: The type of the criterion. This value is Audience when you retrieve an audience criterion. For more information about criterion types, see the Criterion Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: audienceId
  name: audience id
  description: The Microsoft Advertising identifier of the Audience. Add: Required Update: Read-only. You must leave this element null or the audience must already be associated with the specified entity. To associate a different audience with the entity, you must add a new audience criterion and optionally delete any existing audience criteria.
  datatype: long
  max count: 1
property:
  path: audienceType
  name: audience type
  description: The audience type. Add: Read-only Update: Read-only
  datatype: string
  max count: 1

CampaignManagementAudienceDimensionShape
type: NodeShape
target class: CampaignManagementAudienceDimension
property:
  path: type
  name: type
  description: The type of audience. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Age
  in: Gender
  in: Audience
  in: Profile
property:
  path: audiences
  name: audiences
  description: A list of audiences. The supported audience types are: - CombinedList - CustomAudience - InMarketAudience - ProductAudience - RemarketingList - SimilarRemarketingList - CustomerList There is a maximum of 2,000 audiences in an AudienceDimension. Add: Required Update: Optional. To remove existing values, set it to null or empty; to remove a subset of audience segments, specify the audience segments that you want to keep and it will replace the existing audience segments.
  node: CampaignManagementAudienceInfoShape
  class: CampaignManagementAudienceInfo
  node kind: BlankNodeOrIRI

CampaignManagementAudienceGroupAssetGroupAssociationShape
type: NodeShape
target class: CampaignManagementAudienceGroupAssetGroupAssociation
property:
  path: assetGroupId
  name: asset group id
  description: The ID of the asset group. Set: Required Delete: Required
  datatype: long
  max count: 1
property:
  path: audienceGroupId
  name: audience group id
  description: The ID of the audience group. Set: Required Delete: Required
  datatype: long
  max count: 1

CampaignManagementAudienceGroupDimensionBaseShape
type: NodeShape
target class: CampaignManagementAudienceGroupDimensionBase
property:
  path: type
  name: type
  datatype: string
  max count: 1
  in: Age
  in: Gender
  in: Audience
  in: Profile

CampaignManagementAudioFilterShape
type: NodeShape
target class: CampaignManagementAudioFilter
property:
  path: categories
  name: categories
  description: Reserved.
  datatype: string
property:
  path: audioNames
  name: audio names
  description: Reserved.
  datatype: string

CampaignManagementAuditPointResultShape
type: NodeShape
target class: CampaignManagementAuditPointResult
property:
  path: key
  name: key
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: severity
  name: severity
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: timestamp
  name: timestamp
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: details
  name: details
  description: Reserved.
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementBaseDomainSettingShape
type: NodeShape
target class: CampaignManagementBaseDomainSetting
property:
  path: type
  name: type
  description: The type of setting. This value is BaseDomainSetting when you retrieve the setting. For more information, see Setting Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: baseDomain
  name: base domain
  description: The fundamental part of the URL (e.g., contoso.com). Note: BaseDomain is initially set automatically, you can't set it. Add: Read only. Update: Read only.
  datatype: string
  max count: 1

CampaignManagementBatchErrorBaseShape
type: NodeShape
target class: CampaignManagementBatchErrorBase
property:
  path: fieldPath
  name: field path
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  datatype: string
  max count: 1
property:
  path: message
  name: message
  datatype: string
  max count: 1
property:
  path: code
  name: code
  datatype: int
  max count: 1
property:
  path: details
  name: details
  datatype: string
  max count: 1
property:
  path: index
  name: index
  datatype: int
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementBatchErrorCollectionBaseShape
type: NodeShape
target class: CampaignManagementBatchErrorCollectionBase
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: fieldPath
  name: field path
  datatype: string
  max count: 1
property:
  path: batchErrors
  name: batch errors
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI
property:
  path: message
  name: message
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  datatype: string
  max count: 1
property:
  path: code
  name: code
  datatype: int
  max count: 1
property:
  path: details
  name: details
  datatype: string
  max count: 1
property:
  path: index
  name: index
  datatype: int
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementBiddableAdGroupCriterionShape
type: NodeShape
target class: CampaignManagementBiddableAdGroupCriterion
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group to apply the criterion to. Add: Required Update: Required
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: A status value that determines whether the criterion applies for the ad group. For most biddable ad group criterions the only supported status value is Active. For exceptions, see Webpage Usage below. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: criterion
  name: criterion
  description: The criterion to apply to the ad group. The criterion helps determine whether ads in the ad group are served. For a list of available criterion types, see AdGroupCriterionType. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  or:
    node: CampaignManagementAgeCriterionShape
    class: CampaignManagementAgeCriterion
  or:
    node: CampaignManagementAudienceCriterionShape
    class: CampaignManagementAudienceCriterion
  or:
    node: CampaignManagementChannelPlacementCriterionShape
    class: CampaignManagementChannelPlacementCriterion
  or:
    node: CampaignManagementCriterionShape
    class: CampaignManagementCriterion
  or:
    node: CampaignManagementCriterionBaseShape
    class: CampaignManagementCriterionBase
  or:
    node: CampaignManagementCustomLinkedInCriterionShape
    class: CampaignManagementCustomLinkedInCriterion
  or:
    node: CampaignManagementDayTimeCriterionShape
    class: CampaignManagementDayTimeCriterion
  or:
    node: CampaignManagementDealCriterionShape
    class: CampaignManagementDealCriterion
  or:
    node: CampaignManagementDeviceCriterionShape
    class: CampaignManagementDeviceCriterion
  or:
    node: CampaignManagementGenderCriterionShape
    class: CampaignManagementGenderCriterion
  or:
    node: CampaignManagementGenreCriterionShape
    class: CampaignManagementGenreCriterion
  or:
    node: CampaignManagementHotelAdvanceBookingWindowCriterionShape
    class: CampaignManagementHotelAdvanceBookingWindowCriterion
  or:
    node: CampaignManagementHotelCheckInDateCriterionShape
    class: CampaignManagementHotelCheckInDateCriterion
  or:
    node: CampaignManagementHotelCheckInDayCriterionShape
    class: CampaignManagementHotelCheckInDayCriterion
  or:
    node: CampaignManagementHotelDateSelectionTypeCriterionShape
    class: CampaignManagementHotelDateSelectionTypeCriterion
  or:
    node: CampaignManagementHotelGroupShape
    class: CampaignManagementHotelGroup
  or:
    node: CampaignManagementHotelLengthOfStayCriterionShape
    class: CampaignManagementHotelLengthOfStayCriterion
  or:
    node: CampaignManagementLocationCriterionShape
    class: CampaignManagementLocationCriterion
  or:
    node: CampaignManagementLocationIntentCriterionShape
    class: CampaignManagementLocationIntentCriterion
  or:
    node: CampaignManagementPlacementCriterionShape
    class: CampaignManagementPlacementCriterion
  or:
    node: CampaignManagementProductPartitionShape
    class: CampaignManagementProductPartition
  or:
    node: CampaignManagementProductScopeShape
    class: CampaignManagementProductScope
  or:
    node: CampaignManagementProfileCriterionShape
    class: CampaignManagementProfileCriterion
  or:
    node: CampaignManagementRadiusCriterionShape
    class: CampaignManagementRadiusCriterion
  or:
    node: CampaignManagementStoreCriterionShape
    class: CampaignManagementStoreCriterion
  or:
    node: CampaignManagementTopicCriterionShape
    class: CampaignManagementTopicCriterion
  or:
    node: CampaignManagementWebpageShape
    class: CampaignManagementWebpage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the ad group criterion. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad group criterion. This value is BiddableAdGroupCriterion when you retrieve a biddable ad group criterion. For more information about ad group criterion types, see the AdGroupCriterion Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: criterionBid
  name: criterion bid
  description: The bid to use in the auction. If the inherited Criterion is a Webpage criterion, then you must use a FixedBid. If the inherited Criterion is a ProductPartition, then you must use a FixedBid unless the Sponsored Products BidOption is set to BidBoost (for details see ProductPartition Usage below). For all other biddable ad group criterions use the BidMultiplier. If you do not use the correct object type, then your requested bid will be ignored: If the bid is required, the operation will fail; If the bid is optional, the default bid will be used. Add: Requirements vary depending on the inherited Criterion type. The bid is optional and will be set to the default of 0 if not included for AgeCriterion, DayTimeCriterion, DeviceCriterion, GenderCriterion, LocationCriterion, ProfileCriterion, RadiusCriterion, AudienceCriterion, and Webpage criterions. The bid is not applicable for LocationIntentCriterion (The service will not return any error and the bid will be ignored even if you include it). When you add a ProductPartition with the ApplyProductPartitionActions operation the bid is required unless the product partition type is Subdivision, in which case the bid is not allowed. Update: Requirements vary depending on the inherited Criterion type. The bid is required for AgeCriterion, DayTimeCriterion, DeviceCriterion, GenderCriterion, LocationCriterion, ProfileCriterion, and RadiusCriterion. The bid is not applicable for LocationIntentCriterion (The service will not return any error and the bid will be ignored even if you include it). For AudienceCriterion and Webpage criterions the bid is optional, and If no value is set for the update, this setting is not changed. When you update a ProductPartition with the ApplyProductPartitionActions operation the bid is optional, and If no value is set for the update, this setting is not changed.
  or:
    node: CampaignManagementBidMultiplierShape
    class: CampaignManagementBidMultiplier
  or:
    node: CampaignManagementCriterionBidShape
    class: CampaignManagementCriterionBid
  or:
    node: CampaignManagementCriterionBidBaseShape
    class: CampaignManagementCriterionBidBase
  or:
    node: CampaignManagementFixedBidShape
    class: CampaignManagementFixedBid
  or:
    node: CampaignManagementRateBidShape
    class: CampaignManagementRateBid
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: destinationUrl
  name: destination url
  description: The URL of the webpage that the user is taken to when they click the ad. This element is only used if the inherited Criterion is a ProductPartition criterion. For details see ProductPartition Usage below.
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: Tracking templates are where you can specify URL tracking parameters that are used in tandem with your final URL or landing page. We recommend that you add the tracking template at the account level and then it will be applied to all URLs for lower level entities such as campaigns, ad groups, and ads. To learn more, see the Microsoft Advertising help articles URL Tracking with Upgraded URLs. This element is only used if the inherited Criterion is either a ProductPartition or Webpage criterion. For details see ProductPartition Usage and Webpage Usage below.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. This element is only used if the inherited Criterion is either a ProductPartition or Webpage criterion. For details see ProductPartition Usage and Webpage Usage below.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. This element is only used if the inherited Criterion is either a ProductPartition or Webpage criterion. For details see ProductPartition Usage and Webpage Usage below.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: For future use.
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: For future use.
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  description: For future use.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: editorialStatus
  name: editorial status
  description: For future use.
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: criterionCashback
  name: criterion cashback
  description: Defines the CriterionCashback data object.
  or:
    node: CampaignManagementCashbackAdjustmentShape
    class: CampaignManagementCashbackAdjustment
  or:
    node: CampaignManagementCriterionCashbackShape
    class: CampaignManagementCriterionCashback
  or:
    node: CampaignManagementCriterionCashbackBaseShape
    class: CampaignManagementCriterionCashbackBase
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementBiddableCampaignCriterionShape
type: NodeShape
target class: CampaignManagementBiddableCampaignCriterion
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign to apply the criterion to. Add: Required Update: Required
  datatype: long
  max count: 1
property:
  path: criterion
  name: criterion
  description: The criterion to apply to the campaign. The criterion helps determine whether ads in the campaign are served. For a list of available criterion types, see CampaignCriterionType. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  or:
    node: CampaignManagementAgeCriterionShape
    class: CampaignManagementAgeCriterion
  or:
    node: CampaignManagementAudienceCriterionShape
    class: CampaignManagementAudienceCriterion
  or:
    node: CampaignManagementChannelPlacementCriterionShape
    class: CampaignManagementChannelPlacementCriterion
  or:
    node: CampaignManagementCriterionShape
    class: CampaignManagementCriterion
  or:
    node: CampaignManagementCriterionBaseShape
    class: CampaignManagementCriterionBase
  or:
    node: CampaignManagementCustomLinkedInCriterionShape
    class: CampaignManagementCustomLinkedInCriterion
  or:
    node: CampaignManagementDayTimeCriterionShape
    class: CampaignManagementDayTimeCriterion
  or:
    node: CampaignManagementDealCriterionShape
    class: CampaignManagementDealCriterion
  or:
    node: CampaignManagementDeviceCriterionShape
    class: CampaignManagementDeviceCriterion
  or:
    node: CampaignManagementGenderCriterionShape
    class: CampaignManagementGenderCriterion
  or:
    node: CampaignManagementGenreCriterionShape
    class: CampaignManagementGenreCriterion
  or:
    node: CampaignManagementHotelAdvanceBookingWindowCriterionShape
    class: CampaignManagementHotelAdvanceBookingWindowCriterion
  or:
    node: CampaignManagementHotelCheckInDateCriterionShape
    class: CampaignManagementHotelCheckInDateCriterion
  or:
    node: CampaignManagementHotelCheckInDayCriterionShape
    class: CampaignManagementHotelCheckInDayCriterion
  or:
    node: CampaignManagementHotelDateSelectionTypeCriterionShape
    class: CampaignManagementHotelDateSelectionTypeCriterion
  or:
    node: CampaignManagementHotelGroupShape
    class: CampaignManagementHotelGroup
  or:
    node: CampaignManagementHotelLengthOfStayCriterionShape
    class: CampaignManagementHotelLengthOfStayCriterion
  or:
    node: CampaignManagementLocationCriterionShape
    class: CampaignManagementLocationCriterion
  or:
    node: CampaignManagementLocationIntentCriterionShape
    class: CampaignManagementLocationIntentCriterion
  or:
    node: CampaignManagementPlacementCriterionShape
    class: CampaignManagementPlacementCriterion
  or:
    node: CampaignManagementProductPartitionShape
    class: CampaignManagementProductPartition
  or:
    node: CampaignManagementProductScopeShape
    class: CampaignManagementProductScope
  or:
    node: CampaignManagementProfileCriterionShape
    class: CampaignManagementProfileCriterion
  or:
    node: CampaignManagementRadiusCriterionShape
    class: CampaignManagementRadiusCriterion
  or:
    node: CampaignManagementStoreCriterionShape
    class: CampaignManagementStoreCriterion
  or:
    node: CampaignManagementTopicCriterionShape
    class: CampaignManagementTopicCriterion
  or:
    node: CampaignManagementWebpageShape
    class: CampaignManagementWebpage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: status
  name: status
  description: A status value that determines whether the criterion applies for the campaign. Currently the only supported status for biddable campaign criterions is Active. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the campaign criterion. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the campaign criterion. This value is BiddableCampaignCriterion when you retrieve a biddable campaign criterion. For more information about campaign criterion types, see the CampaignCriterion Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: criterionBid
  name: criterion bid
  description: The bid to use in the auction. If the inherited Criterion is a ProductScope criterion, then you can use a FixedBid. For all other biddable campaign criterions use the BidMultiplier. If you do not use the correct object type, then your requested bid will be ignored: If the bid is required, the operation will fail; If the bid is optional, the default bid will be used. Add: Requirements vary depending on the inherited Criterion type. The bid is optional and will be set to the default of 0 if not included for AgeCriterion, DayTimeCriterion, DeviceCriterion, GenderCriterion, LocationCriterion, ProfileCriterion, and RadiusCriterion. The bid is not applicable for LocationIntentCriterion and ProductScope (The service will not return any error and the bid will be ignored even if you include it). Update: Requirements vary depending on the inherited Criterion type. The bid is required for AgeCriterion, DayTimeCriterion, DeviceCriterion, GenderCriterion, LocationCriterion, ProfileCriterion, and RadiusCriterion. The bid is not applicable for LocationIntentCriterion and ProductScope (The service will not return any error and the bid will be ignored even if you include it).
  or:
    node: CampaignManagementBidMultiplierShape
    class: CampaignManagementBidMultiplier
  or:
    node: CampaignManagementCriterionBidShape
    class: CampaignManagementCriterionBid
  or:
    node: CampaignManagementCriterionBidBaseShape
    class: CampaignManagementCriterionBidBase
  or:
    node: CampaignManagementFixedBidShape
    class: CampaignManagementFixedBid
  or:
    node: CampaignManagementRateBidShape
    class: CampaignManagementRateBid
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: criterionCashback
  name: criterion cashback
  description: Defines the CriterionCashback data object.
  or:
    node: CampaignManagementCashbackAdjustmentShape
    class: CampaignManagementCashbackAdjustment
  or:
    node: CampaignManagementCriterionCashbackShape
    class: CampaignManagementCriterionCashback
  or:
    node: CampaignManagementCriterionCashbackBaseShape
    class: CampaignManagementCriterionCashbackBase
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementBiddingSchemeBaseShape
type: NodeShape
target class: CampaignManagementBiddingSchemeBase
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementBidMultiplierShape
type: NodeShape
target class: CampaignManagementBidMultiplier
property:
  path: type
  name: type
  description: The type of the criterion bid. This value is BidMultiplier when you retrieve a bid multiplier. For more information about criterion types, see the CriterionBid Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: multiplier
  name: multiplier
  description: The percentage amount that you want to adjust the bid for the corresponding criterion. If the campaign uses MaxClicks, MaxConversions, TargetCpa, or TargetRoas bid strategy types, then the multiplier will inform rather than directly modify or override the automated bid. For most criterion types the valid bid multiplier range is -90 through 900. For exceptions, see DeviceCriterion Usage and LocationIntentCriterion Usage below. Although this element supports a double data type, you should use whole integer values i.e., -90 through 900, for parity with the web application. Add: Required Update: Required
  datatype: double
  max count: 1

CampaignManagementBMCStoreShape
type: NodeShape
target class: CampaignManagementBMCStore
property:
  path: id
  name: id
  description: The unique identifier for the Microsoft Merchant Center store.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Defines the name of the store as defined in the Microsoft Merchant Center.
  datatype: string
  max count: 1
property:
  path: isActive
  name: is active
  description: Value will be true if the store is active, and otherwise the value is false.
  datatype: boolean
  max count: 1
property:
  path: isProductAdsEnabled
  name: is product ads enabled
  description: Reserved for internal use.
  datatype: boolean
  max count: 1
property:
  path: hasCatalog
  name: has catalog
  description: Value will be true if the store has a catalog of items, and otherwise the value is false.
  datatype: boolean
  max count: 1
property:
  path: subType
  name: sub type
  description: The Microsoft Merchant Center store sub type. This element is only applicable for Microsoft Merchant Center stores that support Shopping Campaigns for Brands, and will be nil for all other stores. If the subtype is set to CoOp, then you have linked from a partner's store via Shopping Campaigns for Brands. When your partner retrieves the same store via GetBMCStoresByCustomerId the subtype would be nil, since from their perspective the store is not restricted to Shopping Campaigns for Brands. If the subtype is set to GlobalStore, then it is the global store to use for all Shopping Campaigns for Brands under the current manager account.
  datatype: string
  max count: 1
  in: CoOp
  in: GlobalStore
property:
  path: storeUrl
  name: store url
  description: The store's destination URL. The destination URL is the web page where people are directed to when they click your ad.
  datatype: string
  max count: 1

CampaignManagementBrandItemShape
type: NodeShape
target class: CampaignManagementBrandItem
property:
  path: type
  name: type
  description: The type of the shared list item. This value is NegativeKeyword when you retrieve a negative keyword. For more information about shared list item types, see SharedListItem Data Object Remarks. Add: Read-only
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: brandId
  name: brand id
  description: The ID of the brand.
  datatype: long
  max count: 1

CampaignManagementBrandListShape
type: NodeShape
target class: CampaignManagementBrandList
property:
  path: itemCount
  name: item count
  description: The number of SharedListItem objects that are added to this shared list. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the shared entity. Add: Read-only Update: Required
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the shared entity. The maximum string length is 255. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the shared entity. This value is NegativeKeywordList when you retrieve a NegativeKeywordList. This value is PlacementExclusionList when you retrieve a PlacementExclusionList. This value is AccountNegativeKeywordList when you retrieve an AccountNegativeKeywordList. For more information about shared entity types, see SharedEntity Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: associationCount
  name: association count
  description: The number of active associations between this shared entity and another entity such as campaign or ad account. For a NegativeKeywordList, the maximum number of active associations between the negative keyword list and campaign is 20. For a PlacementExclusionList, the maximum number of active associations between the website exclusion list and ad account is undefined. Add: Read-only Update: Read-only
  datatype: int
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementCallAdExtensionShape
type: NodeShape
target class: CampaignManagementCallAdExtension
property:
  path: status
  name: status
  description: The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Deleted
property:
  path: scheduling
  name: scheduling
  description: Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads. Add: Optional Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. To remove all scheduling set this element to an empty Schedule object.
  node: CampaignManagementScheduleShape
  class: CampaignManagementSchedule
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: devicePreference
  name: device preference
  description: Not supported for this ad extension type.
  datatype: long
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad extension. Add: Read-only Update: Read-only and Required
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad extension. This value is CallAdExtension when you retrieve a call ad extension. Add: Read-only Update: Read-only For more information about ad extension types, see the Ad Extension Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Tracks the number of times the ad extension has been updated. The version is set to 1 when the ad extension is created, and increments by one after each update. Add: Not allowed Update: Not allowed
  datatype: int
  max count: 1
property:
  path: phoneNumber
  name: phone number
  description: The clickable phone number to include in the ad. The phone number can contain a maximum of 35 characters and must be valid for the specified country or region. If the campaign includes call and location ad extensions, this phone number will override the phone number specified in the location ad extensions. Note that the phone number may be reformatted. For example, if you set phone number to 4255551212, it would be reformatted to (425) 555-1212. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: countryCode
  name: country code
  description: The country code where the phone number is registered. The country code must contain a 2 character country code. The supported country code values include AR, AT, AU, BR, CA, CH, CL, CO, DE, DK, ES, FI, FR, GB, HK, ID, IE, IN, IT, MX, MY, NL, NZ, NO, PE, PH, SE, SG, TH, TW, US, VE, and VN. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: isCallOnly
  name: is call only
  description: The option to show both your phone number and website, or just your phone number, to people seeing your ads on a smartphone. You might want to show only your phone number if your business requires that you talk to each customer. Set this property to true if you want the ad extension to only show the phone number without a link to your website, and otherwise if you want the ad extension include a link to your website in addition to the phone number set it to false. Add: Optional. If you do not specify this element or leave it empty, the default value of false will be set and the ad extension will include a link to your website in addition to the phone number. Update: Optional
  datatype: boolean
  max count: 1
property:
  path: isCallTrackingEnabled
  name: is call tracking enabled
  description: Determines whether call tracking is enabled for the call ad extension. Call tracking is only supported in the United States and United Kingdom. Set this property to true to enable call tracking, and otherwise set it to false. Add: Optional. If you do not specify this element or leave it empty, the default value of false will be set. Update: Optional
  datatype: boolean
  max count: 1
property:
  path: requireTollFreeTrackingNumber
  name: require toll free tracking number
  description: You can either use your own phone number or use a Microsoft Advertising forwarding phone number. A Microsoft Advertising forwarding phone number is a unique phone number that is routed to your business phone number. With a Microsoft Advertising forwarding number, you can track all calls from your ad so that you can analyze the ad's performance. This element determines whether a toll-free Microsoft Advertising forwarding phone number should be created for call tracking. This element can only be set if IsCallTrackingEnabled is also true. Prior to August 2017, clients could set this property to true if a Microsoft Advertising forwarding phone number should be created for call tracking. Since August 2017, clients can no longer create a new toll-free Microsoft Advertising forwarding phone number. If you set this value true then the operation will succeed; however, a toll-free number will not be created and when you retrieve the call ad extension this property will be set to false. If a toll-free forwarding number was provisioned prior to August 2017 then this property will be true if the number is still active when you retrieve the call ad extension. Add: Optional. If you do not specify this element or leave it empty, the default value of false will be set. Update: Optional
  datatype: boolean
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. There are currently no forward compatibility changes for the AdExtension object. Add: Read-only Update: Read-only
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementCalloutAdExtensionShape
type: NodeShape
target class: CampaignManagementCalloutAdExtension
property:
  path: status
  name: status
  description: The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Deleted
property:
  path: scheduling
  name: scheduling
  description: Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads. Add: Optional Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. To remove all scheduling set this element to an empty Schedule object.
  node: CampaignManagementScheduleShape
  class: CampaignManagementSchedule
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: devicePreference
  name: device preference
  description: Not supported for this ad extension type.
  datatype: long
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad extension. Add: Read-only Update: Read-only and Required
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad extension. This value is CalloutAdExtension when you retrieve a callout ad extension. Add: Read-only Update: Read-only For more information about ad extension types, see the Ad Extension Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Tracks the number of times the ad extension has been updated. The version is set to 1 when the ad extension is created, and increments by one after each update. Add: Not allowed Update: Not allowed
  datatype: int
  max count: 1
property:
  path: text
  name: text
  description: Additional callout text about your business, products, or services to include in a text ad. The callout extension text must be different than the text of your ad. The length of this string must be between 1 and 25 characters. Note that for Traditional Chinese characters, the length of this string must be between 1 and 12 characters. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. There are currently no forward compatibility changes for the AdExtension object. Add: Read-only Update: Read-only
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementCallToActionSettingShape
type: NodeShape
target class: CampaignManagementCallToActionSetting
property:
  path: type
  name: type
  description: The type of setting. This value is CallToActionSetting when you retrieve the setting. For more information, see Setting Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: automatedCallToActionOptOut
  name: automated call to action opt out
  description: Determines whether to opt out of automatic selection of call to action ad asset for the multimedia ads in the campaign. When opted in, we will use artificial intelligence during ad delivery to choose the call to action asset and ignore the ad's call to action setting. Note: Not everyone has this feature yet. If you don't, don't worry - it's coming soon! Add: Optional. The default value of false will be set if not otherwise specified. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: boolean
  max count: 1
property:
  path: callToActionOptOut
  name: call to action opt out
  description: Determines whether to opt out of call to action ad asset for the audience ads in the campaign. Add: Optional. The default value of false will be set if not otherwise specified. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: boolean
  max count: 1

CampaignManagementCampaignCriterionBaseShape
type: NodeShape
target class: CampaignManagementCampaignCriterionBase
property:
  path: campaignId
  name: campaign id
  datatype: long
  max count: 1
property:
  path: criterion
  name: criterion
  or:
    node: CampaignManagementAgeCriterionShape
    class: CampaignManagementAgeCriterion
  or:
    node: CampaignManagementAudienceCriterionShape
    class: CampaignManagementAudienceCriterion
  or:
    node: CampaignManagementChannelPlacementCriterionShape
    class: CampaignManagementChannelPlacementCriterion
  or:
    node: CampaignManagementCriterionShape
    class: CampaignManagementCriterion
  or:
    node: CampaignManagementCriterionBaseShape
    class: CampaignManagementCriterionBase
  or:
    node: CampaignManagementCustomLinkedInCriterionShape
    class: CampaignManagementCustomLinkedInCriterion
  or:
    node: CampaignManagementDayTimeCriterionShape
    class: CampaignManagementDayTimeCriterion
  or:
    node: CampaignManagementDealCriterionShape
    class: CampaignManagementDealCriterion
  or:
    node: CampaignManagementDeviceCriterionShape
    class: CampaignManagementDeviceCriterion
  or:
    node: CampaignManagementGenderCriterionShape
    class: CampaignManagementGenderCriterion
  or:
    node: CampaignManagementGenreCriterionShape
    class: CampaignManagementGenreCriterion
  or:
    node: CampaignManagementHotelAdvanceBookingWindowCriterionShape
    class: CampaignManagementHotelAdvanceBookingWindowCriterion
  or:
    node: CampaignManagementHotelCheckInDateCriterionShape
    class: CampaignManagementHotelCheckInDateCriterion
  or:
    node: CampaignManagementHotelCheckInDayCriterionShape
    class: CampaignManagementHotelCheckInDayCriterion
  or:
    node: CampaignManagementHotelDateSelectionTypeCriterionShape
    class: CampaignManagementHotelDateSelectionTypeCriterion
  or:
    node: CampaignManagementHotelGroupShape
    class: CampaignManagementHotelGroup
  or:
    node: CampaignManagementHotelLengthOfStayCriterionShape
    class: CampaignManagementHotelLengthOfStayCriterion
  or:
    node: CampaignManagementLocationCriterionShape
    class: CampaignManagementLocationCriterion
  or:
    node: CampaignManagementLocationIntentCriterionShape
    class: CampaignManagementLocationIntentCriterion
  or:
    node: CampaignManagementPlacementCriterionShape
    class: CampaignManagementPlacementCriterion
  or:
    node: CampaignManagementProductPartitionShape
    class: CampaignManagementProductPartition
  or:
    node: CampaignManagementProductScopeShape
    class: CampaignManagementProductScope
  or:
    node: CampaignManagementProfileCriterionShape
    class: CampaignManagementProfileCriterion
  or:
    node: CampaignManagementRadiusCriterionShape
    class: CampaignManagementRadiusCriterion
  or:
    node: CampaignManagementStoreCriterionShape
    class: CampaignManagementStoreCriterion
  or:
    node: CampaignManagementTopicCriterionShape
    class: CampaignManagementTopicCriterion
  or:
    node: CampaignManagementWebpageShape
    class: CampaignManagementWebpage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: status
  name: status
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: id
  name: id
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementCampaignFrequencyCapSettingShape
type: NodeShape
target class: CampaignManagementCampaignFrequencyCapSetting
property:
  path: type
  name: type
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: timeGranularity
  name: time granularity
  description: Reserved.
  datatype: string
  max count: 1
  in: HOUR
  in: DAY
  in: WEEK
property:
  path: capValue
  name: cap value
  description: Reserved.
  datatype: int
  max count: 1

CampaignManagementCampaignNegativeSitesShape
type: NodeShape
target class: CampaignManagementCampaignNegativeSites
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign to which the negative site URLs belong.
  datatype: long
  max count: 1
property:
  path: negativeSites
  name: negative sites
  description: A list of URLs of the websites where you do not want your ads displayed. This element can include a maximum of 2,500 URLs. Each URL must specify the domain name e.g., contoso.com which can include up to three subdomains and two subdirectories. The subdomain count includes the www prefix. For example one.two.three.contoso.com/1/2, www.two.three.contoso.com/1/2, and one.two.contoso.co.uk/1/2 are valid URLs, whereas one.two.three.contoso.co.uk/1/2 (too many subdomains) and one.two.three.contoso.com/1/2/3 (too many subdirectories) are not. Duplicate URLs in the list are not added. You can only exclude websites for syndicated search websites. The ad group's network must be set to OwnedAndOperatedAndSyndicatedSearch. For more information about network distribution, see Network. Negative site URLs specified at the ad group level are used instead of any negative site URLs specified at the campaign level. If you associate any website exclusion lists (Placement Exclusion List or Account Placement Exclusion List) with an ad account, the list of negative sites are used in addition to the campaign negative sites or ad group negative sites. To remove campaign negative site URLs, set this element to null.
  datatype: string

CampaignManagementCampaignSizeShape
type: NodeShape
target class: CampaignManagementCampaignSize
property:
  path: size
  name: size
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  datatype: long
  max count: 1

CampaignManagementCashbackAdjustmentShape
type: NodeShape
target class: CampaignManagementCashbackAdjustment
property:
  path: type
  name: type
  description: The type of criterion cashback.
  datatype: string
  max count: 1
property:
  path: cashbackPercent
  name: cashback percent
  description: The percent to receive in cashback.
  datatype: double
  max count: 1

CampaignManagementCategoryResultShape
type: NodeShape
target class: CampaignManagementCategoryResult
property:
  path: key
  name: key
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: auditPoints
  name: audit points
  description: Reserved.
  node: CampaignManagementAuditPointResultShape
  class: CampaignManagementAuditPointResult
  node kind: BlankNodeOrIRI

CampaignManagementChannelPlacementCriterionShape
type: NodeShape
target class: CampaignManagementChannelPlacementCriterion
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: channelPlacementId
  name: channel placement id
  datatype: long
  max count: 1
property:
  path: channelPlacementName
  name: channel placement name
  datatype: string
  max count: 1
property:
  path: channelId
  name: channel id
  datatype: int
  max count: 1
property:
  path: channelName
  name: channel name
  datatype: string
  max count: 1
property:
  path: subChannelId
  name: sub channel id
  datatype: int
  max count: 1
property:
  path: subChannelName
  name: sub channel name
  datatype: string
  max count: 1

CampaignManagementClipchampTemplateInfoShape
type: NodeShape
target class: CampaignManagementClipchampTemplateInfo
property:
  path: templateId
  name: template id
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: templateName
  name: template name
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: templateDescription
  name: template description
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: duration
  name: duration
  description: Reserved.
  datatype: int
  max count: 1
property:
  path: aspectRatio
  name: aspect ratio
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: themes
  name: themes
  description: Reserved.
  datatype: string
property:
  path: numberOfImages
  name: number of images
  description: Reserved.
  datatype: int
  max count: 1
property:
  path: numberOfText
  name: number of text
  description: Reserved.
  datatype: int
  max count: 1
property:
  path: numberOfLogos
  name: number of logos
  description: Reserved.
  datatype: int
  max count: 1
property:
  path: templateThumbnailUrl
  name: template thumbnail url
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: templatePreviewUrl
  name: template preview url
  description: Reserved.
  datatype: string
  max count: 1

CampaignManagementCombinedListShape
type: NodeShape
target class: CampaignManagementCombinedList
property:
  path: scope
  name: scope
  description: Scope defines what accounts can use this audience. If scope is set to Account, the audience can only be associated with campaigns and ad groups in one account i.e., via the ParentId. If scope is set to Customer, the audience can be associated with campaigns and ad groups in all of the customer's accounts. Add: Required Update: Optional. You can change the scope from Account to Customer, but you cannot change the scope from Customer to Account.
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: membershipDuration
  name: membership duration
  description: This element is not supported for combined list audiences. Add: Not supported Update: Not supported
  datatype: int
  max count: 1
property:
  path: searchSize
  name: search size
  description: The total number of people who are active members of this audience in the Search network. This gives you an idea of how many search users you can target. The audience needs to have at least 300 people before Microsoft Advertising will use it for optimizations. This property will be nil or empty for up to 24 hours while the audience is being built, for example if you add or update the combined list membership duration, rule, or tag identifier. This property will be nil or empty if the UET tag associated with the combined list has a status of Unverified or Inactive, because the combined list can't receive the customer information from your website that it needs to build the list. Add: Read-only Update: Read-only
  datatype: long
  max count: 1
property:
  path: audienceNetworkSize
  name: audience network size
  description: The total number of people who are active members of this audience in the Audience network. This gives you an idea of how many Audience network users you can target. The audience needs to have at least 300 people before Microsoft Advertising will use it for optimizations. Add: Read-only Update: Read-only
  datatype: long
  max count: 1
property:
  path: supportedCampaignTypes
  name: supported campaign types
  description: The list of campaign types that support this audience. Supported values are Audience, DynamicSearchAds, Search, and Shopping. New campaign types might be added in the future, so you should not take any dependency on a fixed set of values. Add: Read-only Update: Read-only
  datatype: string
property:
  path: customerShare
  name: customer share
  description: This element is not supported for combined list audiences. Add: Not supported Update: Not supported
  node: CampaignManagementCustomerShareShape
  class: CampaignManagementCustomerShare
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: The Microsoft Advertising identifier of the audience. Add: Read-only Update: Required and read-only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the audience. The name can contain a maximum of 128 characters. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description of the audience. Use a description to help you remember what audience you are targeting. The description can contain a maximum of 1,024 characters. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the audience. This value is CombinedList when you retrieve a combined list audience. For more information about audience types, see the Audience Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: parentId
  name: parent id
  description: The Microsoft Advertising identifier of the account or customer. If the Scope is set to Account, this is the account ID, and otherwise it is the customer ID. Add: Required Update: Read-only. You cannot change the parent ID.
  datatype: long
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for the Audience object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: combinationRules
  name: combination rules
  description: Logical conditions used to determine who to add to your combined list. Each list can include up to 100 combination rules or sets of logical conditions, and each CombinationRule can contain up to 100 audience IDs. For details, please see the CombinationRule Remarks. Add: Required Update: Required. If you want to keep any of the previous rules, then you must explicitly set them again during update.
  node: CampaignManagementCombinationRuleShape
  class: CampaignManagementCombinationRule
  node kind: BlankNodeOrIRI

CampaignManagementCommissionBiddingSchemeShape
type: NodeShape
target class: CampaignManagementCommissionBiddingScheme
property:
  path: type
  name: type
  description: The type of bidding scheme that is set for this campaign, ad group, or keyword. For more information about bidding scheme types, see the Remarks.
  datatype: string
  max count: 1
property:
  path: commissionRate
  name: commission rate
  description: The commission rate charged to the advertiser when someone books a hotel and stays there.
  datatype: double
  max count: 1

CampaignManagementCompanyShape
type: NodeShape
target class: CampaignManagementCompany
property:
  path: profileId
  name: profile id
  description: The company name profile identifier that you can use with ProfileCriterion.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The company name.
  datatype: string
  max count: 1
property:
  path: logoUrl
  name: logo url
  description: The full https path for the company's logo image.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The company name profile status. Possible status values include Active and Inactive.
  datatype: string
  max count: 1

CampaignManagementCompanyListShape
type: NodeShape
target class: CampaignManagementCompanyList
property:
  path: id
  name: id
  description: Reserved.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Reserved.
  datatype: string
  max count: 1
  in: Building
  in: Ready
  in: ReachTooSmall
property:
  path: reach
  name: reach
  description: Reserved.
  datatype: long
  max count: 1
property:
  path: companyNames
  name: company names
  description: Reserved.
  node: CampaignManagementCompanyNameShape
  class: CampaignManagementCompanyName
  node kind: BlankNodeOrIRI
property:
  path: total
  name: total
  description: Reserved.
  datatype: int
  max count: 1
property:
  path: matched
  name: matched
  description: Reserved.
  datatype: int
  max count: 1

CampaignManagementConversionGoalBaseShape
type: NodeShape
target class: CampaignManagementConversionGoalBase
property:
  path: name
  name: name
  datatype: string
  max count: 1
property:
  path: status
  name: status
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: scope
  name: scope
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: countType
  name: count type
  datatype: string
  max count: 1
  in: All
  in: Unique
property:
  path: revenue
  name: revenue
  node: CampaignManagementConversionGoalRevenueShape
  class: CampaignManagementConversionGoalRevenue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: conversionWindowInMinutes
  name: conversion window in minutes
  datatype: int
  max count: 1
property:
  path: tagId
  name: tag id
  datatype: long
  max count: 1
property:
  path: trackingStatus
  name: tracking status
  datatype: string
  max count: 1
  in: TagUnverified
  in: NoRecentConversions
  in: RecordingConversions
  in: TagInactive
  in: InactiveDueToTagUnavailable
property:
  path: excludeFromBidding
  name: exclude from bidding
  datatype: boolean
  max count: 1
property:
  path: viewThroughConversionWindowInMinutes
  name: view through conversion window in minutes
  datatype: int
  max count: 1
property:
  path: goalCategory
  name: goal category
  datatype: string
  max count: 1
  in: Unknown
  in: None
  in: Purchase
  in: AddToCart
  in: BeginCheckout
  in: Subscribe
  in: SubmitLeadForm
  in: BookAppointment
  in: Signup
  in: RequestQuote
  in: GetDirections
  in: OutboundClick
  in: Contact
  in: PageView
  in: Download
  in: Other
property:
  path: attributionModelType
  name: attribution model type
  datatype: string
  max count: 1
  in: LastClick
  in: LastTouch
  in: DataDriven
property:
  path: isEnhancedConversionsEnabled
  name: is enhanced conversions enabled
  datatype: boolean
  max count: 1
property:
  path: isAutoGoal
  name: is auto goal
  datatype: boolean
  max count: 1
property:
  path: id
  name: id
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementCoOpSettingShape
type: NodeShape
target class: CampaignManagementCoOpSetting
property:
  path: type
  name: type
  description: The type of the setting. This value is CoOp when you retrieve a CoOp setting. For more information about setting types, see the Setting Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: bidOption
  name: bid option
  description: Determines whether or not to amplify your partner's bid. A bid value ad group allows you to bid on products that your merchandising partner doesn't target. If this element is set to BidValue, the auction will use use a FixedBid for product groups that have a CriterionBid. A bid boost allows you to amplify your partner's bid. If this element is set to BidBoost, the auction will use use a BidMultiplier for product groups that have a CriterionBid. You should only use BidBoost if your partner uses BidValue. Add: If this element is not set, the default bid option is BidValue. Update: Read-only. If you attempt to change the previous bid option an error will be returned.
  datatype: string
  max count: 1
  in: BidValue
  in: BidBoost
property:
  path: bidBoostValue
  name: bid boost value
  description: The default bid boost percentage that you'll see in the Microsoft Advertising web application for new product groups. This ad group level target setting is not used directly in the auction. The product group bids are used to boost your partner's bid. Add: Required if the BidOption is set to BidBoost, and otherwise you may not set this element. Update: Required if the BidOption is set to BidBoost, and otherwise you may not set this element.
  datatype: double
  max count: 1
property:
  path: bidMaxValue
  name: bid max value
  description: The fixed bid maximum. Add: Required if the BidOption is set to BidBoost, and otherwise you may not set this element. Update: Optional if the BidOption is set to BidBoost, and otherwise you may not set this element.
  datatype: double
  max count: 1

CampaignManagementCostPerSaleBiddingSchemeShape
type: NodeShape
target class: CampaignManagementCostPerSaleBiddingScheme
property:
  path: type
  name: type
  description: The type of the bidding scheme. This value is CostPerSaleBiddingScheme when you retrieve a cost per sale bidding scheme. For more information about bidding scheme types, see the BiddingScheme Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: targetCostPerSale
  name: target cost per sale
  description: The target cost per sale that you want used by Microsoft Advertising to maximize conversions.
  datatype: double
  max count: 1

CampaignManagementCreateAssetGroupRecommendationRequestShape
type: NodeShape
target class: CampaignManagementCreateAssetGroupRecommendationRequest
property:
  path: finalUrls
  name: final urls
  description: An array of URLs of the web pages used to create recommended ad assets.
  datatype: string
property:
  path: prompt
  name: prompt
  description: Optional description of the product or service that you want to target with the specific campaign.
  datatype: string
  max count: 1
property:
  path: textTone
  name: text tone
  description: Optional tone for recommended text assets
  datatype: string
  max count: 1
  in: Friendly
  in: Persuasive
  in: Cute
  in: Inspiring
property:
  path: returnAdditionalFields
  name: return additional fields
  description: Additional fields for the latest features of create asset group recommendation.
  datatype: string
  max count: 1
  in: None
  in: ImageSuggestionMetadata
  in: MediaRefineResults
  in: PromptBrandWarning

CampaignManagementCreateAssetGroupRecommendationResponseShape
type: NodeShape
target class: CampaignManagementCreateAssetGroupRecommendationResponse
property:
  path: assetGroup
  name: asset group
  description: An asset group object containing recommended text assets.
  node: CampaignManagementAssetGroupShape
  class: CampaignManagementAssetGroup
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: imageSuggestions
  name: image suggestions
  description: An array of images recommended to be included in the asset group.
  node: CampaignManagementAdRecommendationImageSuggestionShape
  class: CampaignManagementAdRecommendationImageSuggestion
  node kind: BlankNodeOrIRI
property:
  path: promptBrandWarning
  name: prompt brand warning
  description: Whether the brand is detected in the request prompt.
  datatype: string
  max count: 1

CampaignManagementCreateBrandKitRecommendationRequestShape
type: NodeShape
target class: CampaignManagementCreateBrandKitRecommendationRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account.
  datatype: long
  max count: 1
property:
  path: finalUrl
  name: final url
  description: The final URL of the brand kit.
  datatype: string
  max count: 1

CampaignManagementCreateBrandKitRecommendationResponseShape
type: NodeShape
target class: CampaignManagementCreateBrandKitRecommendationResponse
property:
  path: brandKit
  name: brand kit
  description: The brand kit data object.
  node: CampaignManagementBrandKitShape
  class: CampaignManagementBrandKit
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementCreateResponsiveAdRecommendationRequestShape
type: NodeShape
target class: CampaignManagementCreateResponsiveAdRecommendationRequest
property:
  path: adSubType
  name: ad sub type
  description: Optional: The ad sub type used to create a recommendation.
  datatype: string
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: An array of URLs of the web pages used to create recommended ad assets.
  datatype: string
property:
  path: prompt
  name: prompt
  description: Optional: Description of the product or service that you want to target with the specific campaign.
  datatype: string
  max count: 1
property:
  path: textTone
  name: text tone
  description: Optional: Tone for recommended text assets.
  datatype: string
  max count: 1
  in: Friendly
  in: Persuasive
  in: Cute
  in: Inspiring
property:
  path: videoType
  name: video type
  description: The video type, CTV or OLV.
  datatype: string
  max count: 1
  in: OLV
  in: CTV
property:
  path: brandKitId
  name: brand kit id
  description: Optional: The identifier of the brand kit.
  datatype: long
  max count: 1
property:
  path: returnAdditionalFields
  name: return additional fields
  description: Additional fields for the latest features of create responsive ad recommendation.
  datatype: string
  max count: 1
  in: None
  in: ImageSuggestionMetadata
  in: MediaRefineResults
  in: PromptBrandWarning

CampaignManagementCreateResponsiveAdRecommendationResponseShape
type: NodeShape
target class: CampaignManagementCreateResponsiveAdRecommendationResponse
property:
  path: responsiveAd
  name: responsive ad
  description: A responsive ad object containing recommended text assets.
  node: CampaignManagementResponsiveAdShape
  class: CampaignManagementResponsiveAd
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: imageSuggestions
  name: image suggestions
  description: An array of images recommended to be included in the responsive ad.
  node: CampaignManagementAdRecommendationImageSuggestionShape
  class: CampaignManagementAdRecommendationImageSuggestion
  node kind: BlankNodeOrIRI
property:
  path: videoSuggestions
  name: video suggestions
  description: An array of videos recommended to be included in the responsive ad.
  node: CampaignManagementAdRecommendationVideoSuggestionShape
  class: CampaignManagementAdRecommendationVideoSuggestion
  node kind: BlankNodeOrIRI
property:
  path: promptBrandWarning
  name: prompt brand warning
  description: Whether the brand is detected in the request prompt.
  datatype: string
  max count: 1
property:
  path: jobInfo
  name: job info
  description: The job information for the video recommendation job.
  node: CampaignManagementAdRecommendationJobInfoShape
  class: CampaignManagementAdRecommendationJobInfo
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementResponsiveAdShape
type: NodeShape
target class: CampaignManagementResponsiveAd
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad. Add: Read-only Update: Required and Read-Only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad. This value is ResponsiveAd when you retrieve a responsive ad. For more information about ad types, see the Ad Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Text
  in: Image
  in: Product
  in: AppInstall
  in: ExpandedText
  in: DynamicSearch
  in: ResponsiveAd
  in: ResponsiveSearch
  in: Hotel
property:
  path: status
  name: status
  description: The status of the ad. You can set the ad status to Active or Paused. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Inactive
  in: Active
  in: Paused
  in: Deleted
property:
  path: editorialStatus
  name: editorial status
  description: The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: devicePreference
  name: device preference
  description: Not supported for this ad type.
  datatype: long
  max count: 1
property:
  path: adFormatPreference
  name: ad format preference
  description: Not supported for this ad type.
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all landing page URLs. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: The landing page URL. The domain portion of the URL in combination with the path 1 and path 2 strings cannot exceed 67 characters. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. - You may not specify FinalMobileUrls if the device preference is set to mobile. Also note that if this ad's TrackingUrlTemplate or UrlCustomParameters element are set, then at least one final URL is required. This URL is used only if the keyword does not specify a final URL. Add: Required Update: Optional
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The mobile landing page URL. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. - You may not specify FinalMobileUrls if the device preference is set to mobile. This URL is used only if the keyword does not specify a final mobile URL. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty list, the previous setting will be deleted.
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  description: Not supported for this ad type.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: headline
  name: headline
  description: Headlines are the most prominent text that appears in your ad, so you should make the most out of the available characters. We require multiple headlines so the ad can flexibly display across a variety of publishers and placements. The length of the string is limited to 30 characters. Add: Required for video ads. Not applicable for multimedia ads and audience ads. Update: Optional. Deprecated for multimedia and audience ads. Use Headlines instead.
  datatype: string
  max count: 1
property:
  path: longHeadlineString
  name: long headline string
  description: Headlines are the most prominent text that appears in your ad, so you should make the most out of the available characters. We require multiple headlines so the ad can flexibly display across a variety of publishers and placements. The length of the string is limited to 90 characters. Add: Optional. Ignored when LongHeadlines is provided. We will fill in LongHeadlines with LongHeadlineString if LongHeadlines is empty. Not applicable for multimedia ads. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: text
  name: text
  description: This text will appear below or adjacent to your ad's long or short headline, depending on the ad placement. You have more character space to work with in the ad text than in the headline. So once the imagery and headline have a potential customer's attention, the ad text needs to convince them to click it. What sets your product or service apart? The text must contain at least one word. The length of the string is limited to 90 characters. The text cannot contain the newline (\n) character. Add: Required for video ads. Not applicable for multimedia ads and audience ads. Update: Optional for video ads. Use Descriptions instead for audience ads or multimedia ads (deprecated).
  datatype: string
  max count: 1
property:
  path: businessName
  name: business name
  description: The name of the business. Your business's name may appear in your ad, depending on the ad placement. The length of the string is limited to 25 characters. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: callToAction
  name: call to action
  description: A brief, punchy reason for customers to click your ad right now. This is displayed on your call to action button. Add: Not applicable for audience ads; Required for multimedia ads Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Unknown
  in: ActNow
  in: ApplyNow
  in: BetNow
  in: BidNow
  in: BookACar
  in: BookHotel
  in: BookNow
  in: Browse
  in: BuyNow
  in: ChatNow
  in: Compare
  in: ContactUs
  in: Coupon
  in: Donate
  in: Download
  in: EmailNow
  in: EnrollNow
  in: Explore
  in: FileNow
  in: FindJob
  in: FreePlay
  in: FreeQuote
  in: FreeTrial
  in: GetDeals
  in: GetOffer
  in: GetQuote
  in: JoinNow
  in: LearnMore
  in: ListenNow
  in: LogIn
  in: Message
  in: NewCars
  in: OrderNow
  in: PlayGame
  in: PlayNow
  in: PostJob
  in: Register
  in: RentACar
  in: RentNow
  in: Reserve
  in: Sale
  in: SaveNow
  in: Schedule
  in: SeeMenu
  in: SeeMore
  in: SeeOffer
  in: SellNow
  in: ShopNow
  in: Showtimes
  in: SignIn
  in: SignUp
  in: StartFree
  in: StartNow
  in: Subscribe
  in: TestDrive
  in: TryNow
  in: UsedCars
  in: ViewCars
  in: ViewNow
  in: ViewPlans
  in: VisitSite
  in: VoteNow
  in: Watch
  in: WatchMore
  in: WatchNow
  in: Directions
  in: FindStore
  in: SwitchNow
  in: VisitStore
  in: RenewNow
  in: Reorder
  in: Default
  in: NoButton
  in: Install

CampaignManagementCreateResponsiveSearchAdRecommendationRequestShape
type: NodeShape
target class: CampaignManagementCreateResponsiveSearchAdRecommendationRequest
property:
  path: finalUrls
  name: final urls
  description: An array of URLs of the web pages used to create recommended ad assets.
  datatype: string
property:
  path: prompt
  name: prompt
  description: Optional description of the product or service that you want to target with the specific campaign.
  datatype: string
  max count: 1
property:
  path: textTone
  name: text tone
  description: Optional tone for recommended text assets.
  datatype: string
  max count: 1
  in: Friendly
  in: Persuasive
  in: Cute
  in: Inspiring

CampaignManagementCreateResponsiveSearchAdRecommendationResponseShape
type: NodeShape
target class: CampaignManagementCreateResponsiveSearchAdRecommendationResponse
property:
  path: responsiveSearchAd
  name: responsive search ad
  description: A responsive search ad object containing recommended text assets.
  node: CampaignManagementResponsiveSearchAdShape
  class: CampaignManagementResponsiveSearchAd
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementResponsiveSearchAdShape
type: NodeShape
target class: CampaignManagementResponsiveSearchAd
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad. Add: Read-only Update: Required and Read-Only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad. This value is ResponsiveSearch when you retrieve a responsive search ad. For more information about ad types, see the Ad Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Text
  in: Image
  in: Product
  in: AppInstall
  in: ExpandedText
  in: DynamicSearch
  in: ResponsiveAd
  in: ResponsiveSearch
  in: Hotel
property:
  path: status
  name: status
  description: The status of the ad. You can set the ad status to Active or Paused. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Inactive
  in: Active
  in: Paused
  in: Deleted
property:
  path: editorialStatus
  name: editorial status
  description: The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: devicePreference
  name: device preference
  description: Not supported for this ad type.
  datatype: long
  max count: 1
property:
  path: adFormatPreference
  name: ad format preference
  description: Not supported for this ad type.
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all landing page URLs. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: The landing page URL. The domain portion of the URL in combination with the path 1 and path 2 strings cannot exceed 67 characters. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. - You may not specify FinalMobileUrls if the device preference is set to mobile. Also note that if this ad's TrackingUrlTemplate or UrlCustomParameters element are set, then at least one final URL is required. This URL is used only if the keyword does not specify a final URL. Add: Required Update: Optional
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The mobile landing page URL. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. - You may not specify FinalMobileUrls if the device preference is set to mobile. This URL is used only if the keyword does not specify a final mobile URL. Add: Optional Update: Optional
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  description: Not supported for this ad type.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: headlines
  name: headlines
  description: The list of ad titles that Bing can use to optimize the ad layout. Unless you pin one of the headlines to a specific position, Bing will optimize the ad layout dynamically with the best headlines and descriptions for the user's search query. From a data model perspective the desriptions and headlines are each stored as text assets i.e., one TextAsset per AssetLink. The same asset can be used by multiple ads. For example if "Seamless Integration" is a text asset, it will have the same asset identifier across all ads in the same Microsoft Advertising account. You must set between 3-15 headlines. Each headline's Text must contain at least one word. For efficient use of resources we recommend that you use dynamic text strings such as {keyword} instead of creating new ad copy for each keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. The maximum input length of each headline's Text is 1,000 characters including dynamic text strings, and of those 1,000 no more than 30 final characters are allowed after substitution. The ad will fail to display or default text will be used if the length exceeds 30 characters after dynamic text substitution occurs. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 500 characters including dynamic text strings, and of those 500 no more than 15 final characters are allowed after substitution. The ad will fail to display or default text will be used if the length exceeds 15 characters after dynamic text substitution occurs. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The Text cannot contain the newline (\n) character. The text can contain IF functions. Add: Required Update: Optional. To retain all of the existing a…
  node: CampaignManagementAssetLinkShape
  class: CampaignManagementAssetLink
  node kind: BlankNodeOrIRI
property:
  path: descriptions
  name: descriptions
  description: The list of descriptions that Bing can use to optimize the ad layout. To maximize impressions across all ad formats the descriptions might not always be shown in your ad. Unless you pin one of the descriptions to a specific position, Bing will optimize the ad layout dynamically with the best headlines and descriptions for the user's search query. From a data model perspective the desriptions and headlines are each stored as text assets i.e., one TextAsset per AssetLink. The same asset can be used by multiple ads. For example if "Seamless Integration" is a text asset, it will have the same asset identifier across all ads in the same Microsoft Advertising account. You must set between 2-4 descriptions. Each description's Text must contain at least one word. For efficient use of resources we recommend that you use dynamic text strings such as {keyword} instead of creating new ad copy for each keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. The maximum input length of each description's Text is 1,000 characters including dynamic text strings, and of those 1,000 no more than 90 final characters are allowed after substitution. The ad will fail to display or default text will be used if the length exceeds 90 characters after dynamic text substitution occurs. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 500 characters including dynamic text strings, and of those 500 no more than 45 final characters are allowed after substitution. The ad will fail to display or default text will be used if the length exceeds 45 characters after dynamic text substitution occurs. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The Text cannot contain the newline…
  node: CampaignManagementAssetLinkShape
  class: CampaignManagementAssetLink
  node kind: BlankNodeOrIRI
property:
  path: domain
  name: domain
  description: The URL that will be displayed instead of the final URL. The final URL will still be used for the landing page URL. Reserved for limited pilot usage e.g. pharmaceutical customers. The domain portion of the URL in combination with the path 1 and path 2 strings cannot exceed 67 characters. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: path1
  name: path1
  description: The first part of the optional path that will be appended to the domain portion of your display URL. The domain portion of your display URL e.g. https://www.contoso.com will be generated from the domain of your Final URL (FinalUrls element). Then if you have specified a value for Path1 it will be appended to the display URL. If you have also specified a value for Path2, then it will also be appended to the display URL after Path1. For example if your FinalUrls contains https://www.contoso.com, Path1 is set to subdirectory1, and Path2 is set to subdirectory2, then the URL displayed will be https://www.contoso.com/subdirectory1/subdirectory2. The path can contain dynamic parameters such as {MatchType}. For a list of supported parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use?. The maximum input length is 1,000 characters if you include dynamic text strings. No more than 15 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of the final URL domain and the paths combined exceed 67 characters. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 1,000 characters if you include dynamic text strings. No more than 7 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of the final URL domain and the paths combined exceed 33 characters. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The path cannot contain the forward slash (/) or newline (\n) characters. If the path includes a space, it will be replaced with an underscore (_) when the ad is shown. The path can contain IF functions. Add: Optional Update: Optional. If no value is set for the update,…
  datatype: string
  max count: 1
property:
  path: path2
  name: path2
  description: The second part of the optional path that will be appended to the domain portion of your display URL. The domain portion of your display URL e.g. https://www.contoso.com will be generated from the domain of your Final URL (FinalUrls element). Then if you have specified a value for Path1 it will be appended to the display URL. If you have also specified a value for Path2, then it will also be appended to the display URL after Path1. For example if your FinalUrls contains https://www.contoso.com, Path1 is set to subdirectory1, and Path2 is set to subdirectory2, then the URL displayed will be https://www.contoso.com/subdirectory1/subdirectory2. You can only specify Path2 if Path1 is also set. The path can contain dynamic parameters such as {MatchType}. For a list of supported parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use?. The maximum input length is 1,000 characters if you include dynamic text strings. No more than 15 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of the final URL domain and the paths combined exceed 67 characters. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 1,000 characters if you include dynamic text strings. No more than 7 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of the final URL domain and the paths combined exceed 33 characters. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The path cannot contain the forward slash (/) or newline (\n) characters. If the path includes a space, it will be replaced with an underscore (_) when the ad is shown. The path can contain IF functions. Add: Optional Up…
  datatype: string
  max count: 1

CampaignManagementCriterionBaseShape
type: NodeShape
target class: CampaignManagementCriterionBase
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementCriterionBidBaseShape
type: NodeShape
target class: CampaignManagementCriterionBidBase
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementCriterionCashbackBaseShape
type: NodeShape
target class: CampaignManagementCriterionCashbackBase
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementCustomAudienceShape
type: NodeShape
target class: CampaignManagementCustomAudience
property:
  path: scope
  name: scope
  description: Scope defines what accounts can use this audience. For a custom audience the only supported scope is Customer, and the audience can be associated with campaigns and ad groups in all of the customer's accounts. Add: Not supported Update: Not supported
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: membershipDuration
  name: membership duration
  description: The membership duration determines how far back in time Microsoft Advertising should look for actions that match your custom audience definition in order to add people to your list. For a custom audience the membership duration is not set in the Microsoft Advertising web application, and Microsoft Advertising defers to your custom audience provider settings. When you request the custom audience via Bing Ads API, the returned membership duration will be null. Add: Not supported Update: Not supported
  datatype: int
  max count: 1
property:
  path: searchSize
  name: search size
  description: The total number of people who are active members of this audience in the Search network. This gives you an idea of how many search users you can target. The audience needs to have at least 300 people before Microsoft Advertising will use it for optimizations. This property will be nil or empty for up to 24 hours while the audience is being built, for example if you have imported new custom audiences from DMP, it takes 24 hours to build the audience, and in the meantime this property will be nil or empty. Add: Not supported Update: Read-only
  datatype: long
  max count: 1
property:
  path: audienceNetworkSize
  name: audience network size
  description: The total number of people who are active members of this audience in the Audience network. This gives you an idea of how many Audience network users you can target. The audience needs to have at least 300 people before Microsoft Advertising will use it for optimizations. Add: Not supported Update: Read-only
  datatype: long
  max count: 1
property:
  path: supportedCampaignTypes
  name: supported campaign types
  description: The list of campaign types that support this audience. Supported values are Audience, DynamicSearchAds, Search, and Shopping. New campaign types might be added in the future, so you should not take any dependency on a fixed set of values. Add: Not supported Update: Read-only
  datatype: string
property:
  path: customerShare
  name: customer share
  description: This element is not supported for custom audiences. Add: Not supported Update: Not supported
  node: CampaignManagementCustomerShareShape
  class: CampaignManagementCustomerShare
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: The Microsoft Advertising identifier of the audience. Add: Not supported Update: Required and read-only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the audience. The name can contain a maximum of 128 characters. Add: Not supported Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description of the audience. Use a description to help you remember what audience you are targeting. The description can contain a maximum of 1,024 characters. Add: Not supported Update: Optional. If no value is set for the update, this setting is not changed. To remove the previous setting, set this elemment to an empty string value ("").
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the audience. This value is Custom when you retrieve a custom audience. For more information about audience types, see the Audience Data Object Remarks. Add: Not supported Update: Read-only
  datatype: string
  max count: 1
property:
  path: parentId
  name: parent id
  description: The Microsoft Advertising identifier of the customer that contains the custom audience. Add: Not supported Update: Not supported
  datatype: long
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for the Audience object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementCustomEventsRuleShape
type: NodeShape
target class: CampaignManagementCustomEventsRule
property:
  path: type
  name: type
  description: The type of the remarketing rule. For more information about remarketing rule types, see the RemarketingRule Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: categoryOperator
  name: category operator
  description: The operator that can be applied to the value of the Category element. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include CategoryOperator and Category during update, any existing CategoryOperator and Category settings will be deleted.
  datatype: string
  max count: 1
  in: None
  in: Equals
  in: Contains
  in: BeginsWith
  in: EndsWith
  in: NotEquals
  in: DoesNotContain
  in: DoesNotBeginWith
  in: DoesNotEndWith
property:
  path: category
  name: category
  description: The category of event you want to track. For example, 'video'. If this element is specified during an add or update operation, then the CategoryOperator element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include CategoryOperator and Category during update, any existing CategoryOperator and Category settings will be deleted.
  datatype: string
  max count: 1
property:
  path: actionOperator
  name: action operator
  description: The operator that can be applied to the value of the Action element. If this element is specified during an add or update operation, then the Action element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ActionOperator and Action during update, any existing ActionOperator and Action settings will be deleted.
  datatype: string
  max count: 1
  in: None
  in: Equals
  in: Contains
  in: BeginsWith
  in: EndsWith
  in: NotEquals
  in: DoesNotContain
  in: DoesNotBeginWith
  in: DoesNotEndWith
property:
  path: action
  name: action
  description: The type of user interaction you want to track. For example 'play' or 'pause'. If this element is specified during an add or update operation, then the ActionOperator element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ActionOperator and Action during update, any existing ActionOperator and Action settings will be deleted.
  datatype: string
  max count: 1
property:
  path: labelOperator
  name: label operator
  description: The operator that can be applied to the value of the Label element. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include LabelOperator and Label during update, any existing LabelOperator and Label settings will be deleted.
  datatype: string
  max count: 1
  in: None
  in: Equals
  in: Contains
  in: BeginsWith
  in: EndsWith
  in: NotEquals
  in: DoesNotContain
  in: DoesNotBeginWith
  in: DoesNotEndWith
property:
  path: label
  name: label
  description: The name of the element that caused the action. For example 'trailer' or 'behindthescenes'. If this element is specified during an add or update operation, then the LabelOperator element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include LabelOperator and Label during update, any existing LabelOperator and Label settings will be deleted.
  datatype: string
  max count: 1
property:
  path: valueOperator
  name: value operator
  description: The operator that can be applied to the value of the Value element. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ValueOperator and Value during update, any existing ValueOperator and Value settings will be deleted.
  datatype: string
  max count: 1
  in: None
  in: Equals
  in: GreaterThan
  in: LessThan
  in: GreaterThanEqualTo
  in: LessThanEqualTo
  in: NotEquals
property:
  path: value
  name: value
  description: A positive integer value associated with that event. For example the value could be the duration of time that the video played. If this element is specified during an add or update operation, then the ValueOperator element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ValueOperator and Value during update, any existing ValueOperator and Value settings will be deleted
  datatype: double
  max count: 1

CampaignManagementCustomLinkedInCriterionShape
type: NodeShape
target class: CampaignManagementCustomLinkedInCriterion
property:
  path: type
  name: type
  description: The type of the criterion. This value is CustomLinkedIn when you retrieve a custom LinkedIn criterion. For more information about criterion types, see the Criterion Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: profileId
  name: profile id
  description: The LinkedIn profile ID.
  datatype: long
  max count: 1
property:
  path: profile
  name: profile
  description: The LinkedIn profile.
  datatype: string
  max count: 1
property:
  path: profileType
  name: profile type
  description: The LinkedIn profile type.
  datatype: string
  max count: 1

CampaignManagementCustomSegmentShape
type: NodeShape
target class: CampaignManagementCustomSegment
property:
  path: scope
  name: scope
  description: Scope defines what accounts can use this audience. If scope is set to Account, the audience can only be associated with campaigns and ad groups in one account i.e., via the ParentId. If scope is set to Customer, the audience can be associated with campaigns and ad groups in all of the customer's accounts.
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: membershipDuration
  name: membership duration
  description: When you create an audience, you can specify how far back in time Microsoft Advertising should look for actions that match your audience definition. The minimum duration is 1 day and the maximum duration allowed is 180 days.
  datatype: int
  max count: 1
property:
  path: searchSize
  name: search size
  description: The total number of people who are active members of this audience in the Search network. This gives you an idea of how many search users you can target. Please see more details in documentation for the objects that inherit this element e.g., RemarketingList.
  datatype: long
  max count: 1
property:
  path: audienceNetworkSize
  name: audience network size
  description: The total number of people who are active members of this audience in the Audience network. This gives you an idea of how many Audience network users you can target. Please see more details in documentation for the objects that inherit this element e.g., RemarketingList.
  datatype: long
  max count: 1
property:
  path: supportedCampaignTypes
  name: supported campaign types
  description: The list of campaign types that support this audience. Supported values are Audience, DynamicSearchAds, Search, and Shopping. New campaign types might be added in the future, so you should not take any dependency on a fixed set of values.
  datatype: string
property:
  path: customerShare
  name: customer share
  description: Determines the list of customers and accounts that share the audience. Details include audience association counts. This element is only supported with a RemarketingList. Audiences of other types cannot be shared in the customer hierarchy.
  node: CampaignManagementCustomerShareShape
  class: CampaignManagementCustomerShare
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: The Microsoft Advertising identifier of the audience.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the audience. The name can contain a maximum of 128 characters.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description of the audience. Use a description to help you remember what audience you are targeting. The description can contain a maximum of 1,024 characters.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the segment.
  datatype: string
  max count: 1
property:
  path: parentId
  name: parent id
  description: The Microsoft Advertising identifier of the account or customer. If the Scope is set to Account, this is the account ID, and otherwise it is the customer ID.
  datatype: long
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: customSegmentCatalogList
  name: custom segment catalog list
  description: A list of custom segment catalogs. Add: Required Update: Optional, if no value is set for the update, this setting isn't changed.
  node: CampaignManagementCustomSegmentCatalogShape
  class: CampaignManagementCustomSegmentCatalog
  node kind: BlankNodeOrIRI
property:
  path: editorialStatus
  name: editorial status
  description: The custom segment editorial status. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Unknown
  in: Rejected
  in: Pending
  in: PartialApproved
  in: Approved

CampaignManagementDailySummaryShape
type: NodeShape
target class: CampaignManagementDailySummary
property:
  path: uploadDate
  name: upload date
  description: The date of the report in local time.
  datatype: dateTime
  max count: 1
property:
  path: fileUrl
  name: file url
  description: The URL of the report.
  datatype: string
  max count: 1
property:
  path: fileUrlExpiryTimeUtc
  name: file url expiry time utc
  description: The expiry time of the report in UTC time.
  datatype: dateTime
  max count: 1
property:
  path: successCount
  name: success count
  description: The number of successful conversions.
  datatype: int
  max count: 1
property:
  path: failureCount
  name: failure count
  description: The number of failed conversions.
  datatype: int
  max count: 1

CampaignManagementDataTableAdExtensionShape
type: NodeShape
target class: CampaignManagementDataTableAdExtension
property:
  path: status
  name: status
  datatype: string
  max count: 1
  in: Active
  in: Deleted
property:
  path: scheduling
  name: scheduling
  node: CampaignManagementScheduleShape
  class: CampaignManagementSchedule
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: devicePreference
  name: device preference
  datatype: long
  max count: 1
property:
  path: id
  name: id
  datatype: long
  max count: 1
property:
  path: type
  name: type
  datatype: string
  max count: 1
property:
  path: version
  name: version
  datatype: int
  max count: 1
property:
  path: name
  name: name
  datatype: string
  max count: 1
property:
  path: nameUrl
  name: name url
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementDayTimeCriterionShape
type: NodeShape
target class: CampaignManagementDayTimeCriterion
property:
  path: type
  name: type
  description: The type of the criterion. This value is DayTime when you retrieve a day and time criterion. For more information about criterion types, see the Criterion Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: day
  name: day
  description: The day of the week to target. For example, you can target the ads to run only on Friday or Saturday. Add: Required Update: Not allowed. If you specify this element it must match the existing setting.
  datatype: string
  max count: 1
  in: Sunday
  in: Monday
  in: Tuesday
  in: Wednesday
  in: Thursday
  in: Friday
  in: Saturday
property:
  path: fromHour
  name: from hour
  description: The starting hour range to target. The possible values range from 0 to 23. Add: Required Update: Not allowed. If you specify this element it must match the existing setting.
  datatype: int
  max count: 1
property:
  path: fromMinute
  name: from minute
  description: The starting minute of the hour to target. Add: Required Update: Not allowed. If you specify this element it must match the existing setting.
  datatype: string
  max count: 1
  in: Zero
  in: Fifteen
  in: Thirty
  in: FortyFive
property:
  path: toHour
  name: to hour
  description: The ending hour range to target. Supported values range from 0 to 24. If the ToHour is set to 24, the ToMinute must be Zero. Add: Required Update: Not allowed. If you specify this element it must match the existing setting.
  datatype: int
  max count: 1
property:
  path: toMinute
  name: to minute
  description: The ending minute of the hour to target. Add: Required Update: Not allowed. If you specify this element it must match the existing setting.
  datatype: string
  max count: 1
  in: Zero
  in: Fifteen
  in: Thirty
  in: FortyFive

CampaignManagementDealCriterionShape
type: NodeShape
target class: CampaignManagementDealCriterion
property:
  path: type
  name: type
  description: The type of the criterion. This value is Deal when you retrieve a deal criterion. For more information about criterion types, see the Criterion Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: dealId
  name: deal id
  description: The Microsoft Advertising identifier of the Deal.
  datatype: long
  max count: 1

CampaignManagementDeleteAdExtensionsAssociationsRequestShape
type: NodeShape
target class: CampaignManagementDeleteAdExtensionsAssociationsRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account that owns the extensions.
  datatype: long
  max count: 1
property:
  path: adExtensionIdToEntityIdAssociations
  name: ad extension id to entity id associations
  description: The list of ad extensions that are associated with campaigns or ad groups before calling this operation. You can specify a maximum of 100 associations to delete or remove.
  node: CampaignManagementAdExtensionIdToEntityIdAssociationShape
  class: CampaignManagementAdExtensionIdToEntityIdAssociation
  node kind: BlankNodeOrIRI
property:
  path: associationType
  name: association type
  description: The entity type or types associated with an ad extension.
  datatype: string
  max count: 1
  in: Campaign
  in: AdGroup
  in: Account

CampaignManagementDeleteAdExtensionsAssociationsResponseShape
type: NodeShape
target class: CampaignManagementDeleteAdExtensionsAssociationsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteAdExtensionsRequestShape
type: NodeShape
target class: CampaignManagementDeleteAdExtensionsRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account that owns the extensions.
  datatype: long
  max count: 1
property:
  path: adExtensionIds
  name: ad extension ids
  description: The identifiers of the extensions to delete. You can specify a maximum of 100 identifiers.
  datatype: long

CampaignManagementDeleteAdExtensionsResponseShape
type: NodeShape
target class: CampaignManagementDeleteAdExtensionsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteAdGroupCriterionsRequestShape
type: NodeShape
target class: CampaignManagementDeleteAdGroupCriterionsRequest
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group that has the criterions you want to delete.
  datatype: long
  max count: 1
property:
  path: criterionType
  name: criterion type
  description: The type of criterion to delete, for example Webpage. You can specify only one criterion type value per call. To add, delete, or update target criterions i.e., age, company name, day and time, device, gender, industry, job function, location, location intent, placement, radius, and topic criterions, you must specify the CriterionType value as Targets. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these target criterions via GetAdGroupCriterionsByIds you must request the specific type individually i.e., Age, CompanyName, DayTime, Device, Gender, Industry, JobFunction, Location, LocationIntent, Placement, Radius, and Topic. To add, delete, or update audience criterions i.e., custom audiences, in-market audiences, and remarketing lists, you must specify the CriterionType value as Audience. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these audience criterions via GetAdGroupCriterionsByIds you must request the specific type individually i.e., CustomAudience, InMarketAudience, ProductAudience, and RemarketingList. You cannot delete a ProductPartition with this operation. Instead, you should use ApplyProductPartitionActions.
  datatype: string
  max count: 1
property:
  path: adGroupCriterionIds
  name: ad group criterion ids
  description: A list of unique identifiers that identify the criterions to delete. You can include up to 1,000 ad group criterion identifiers per request.
  datatype: long

CampaignManagementDeleteAdGroupCriterionsResponseShape
type: NodeShape
target class: CampaignManagementDeleteAdGroupCriterionsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteAdGroupsRequestShape
type: NodeShape
target class: CampaignManagementDeleteAdGroupsRequest
property:
  path: campaignId
  name: campaign id
  description: The campaign that contains the ad groups to delete.
  datatype: long
  max count: 1
property:
  path: adGroupIds
  name: ad group ids
  description: A maximum of 1,000 identifiers of the ad groups to delete.
  datatype: long

CampaignManagementDeleteAdGroupsResponseShape
type: NodeShape
target class: CampaignManagementDeleteAdGroupsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteAdsRequestShape
type: NodeShape
target class: CampaignManagementDeleteAdsRequest
property:
  path: adGroupId
  name: ad group id
  description: The ID of the ad group that contains the ads to delete.
  datatype: long
  max count: 1
property:
  path: adIds
  name: ad ids
  description: The IDs of the ads to delete. You can specify a maximum of 50 IDs.
  datatype: long

CampaignManagementDeleteAdsResponseShape
type: NodeShape
target class: CampaignManagementDeleteAdsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteAssetGroupsRequestShape
type: NodeShape
target class: CampaignManagementDeleteAssetGroupsRequest
property:
  path: campaignId
  name: campaign id
  description: The ID of the performance max campaign.
  datatype: long
  max count: 1
property:
  path: assetGroupIds
  name: asset group ids
  description: Array of asset group IDs to update for the specified campaign. A maximum of 100 asset groups can be specified in a single call.
  datatype: long

CampaignManagementDeleteAssetGroupsResponseShape
type: NodeShape
target class: CampaignManagementDeleteAssetGroupsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteAudienceGroupAssetGroupAssociationsRequestShape
type: NodeShape
target class: CampaignManagementDeleteAudienceGroupAssetGroupAssociationsRequest
property:
  path: audienceGroupAssetGroupAssociations
  name: audience group asset group associations
  description: The list of Audience Group associations to be deleted. The maximum size of the list is 100 items per service request.
  node: CampaignManagementAudienceGroupAssetGroupAssociationShape
  class: CampaignManagementAudienceGroupAssetGroupAssociation
  node kind: BlankNodeOrIRI

CampaignManagementDeleteAudienceGroupAssetGroupAssociationsResponseShape
type: NodeShape
target class: CampaignManagementDeleteAudienceGroupAssetGroupAssociationsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteAudienceGroupsRequestShape
type: NodeShape
target class: CampaignManagementDeleteAudienceGroupsRequest
property:
  path: audienceGroupIds
  name: audience group ids
  description: Array of audience group IDs to be deleted. The maximum size of the list is 100 items per service request.
  datatype: long

CampaignManagementDeleteAudienceGroupsResponseShape
type: NodeShape
target class: CampaignManagementDeleteAudienceGroupsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteAudiencesRequestShape
type: NodeShape
target class: CampaignManagementDeleteAudiencesRequest
property:
  path: audienceIds
  name: audience ids
  description: The IDs of the audiences to delete. You can specify a maximum of 100 IDs. You cannot delete InMarketAudience objects.
  datatype: long

CampaignManagementDeleteAudiencesResponseShape
type: NodeShape
target class: CampaignManagementDeleteAudiencesResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteBidStrategiesRequestShape
type: NodeShape
target class: CampaignManagementDeleteBidStrategiesRequest
property:
  path: bidStrategyIds
  name: bid strategy ids
  description: The identifiers of bid strategies to delete from the account's portfolio bid strategy library. You can include a maximum of 100 IDs in a single call. The account is determined by the required CustomerAccountId header element.
  datatype: long
property:
  path: scope
  name: scope
  description: A nullable field used to delete bid strategy IDs in the request for the specified scope. If no scope is provided, the default is Account. If a bid strategy ID in the request belongs to the Account scope but the request scope is set to Customer, the call for those bid strategy IDs will fail with a PortfolioBidStrategyIdInvalid error.
  datatype: string
  max count: 1
  in: Account
  in: Customer

CampaignManagementDeleteBidStrategiesResponseShape
type: NodeShape
target class: CampaignManagementDeleteBidStrategiesResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteBrandKitsRequestShape
type: NodeShape
target class: CampaignManagementDeleteBrandKitsRequest
property:
  path: accountId
  name: account id
  description: The Microsoft Advertising identifier of the account.
  datatype: long
  max count: 1
property:
  path: brandKitIds
  name: brand kit ids
  description: The identifiers of the BrandKits to delete.
  datatype: long

CampaignManagementDeleteBrandKitsResponseShape
type: NodeShape
target class: CampaignManagementDeleteBrandKitsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteBudgetsRequestShape
type: NodeShape
target class: CampaignManagementDeleteBudgetsRequest
property:
  path: budgetIds
  name: budget ids
  description: A maximum of 100 budget identifiers to delete from the account's shared budget library. The account is determined by the required CustomerAccountId header element.
  datatype: long

CampaignManagementDeleteBudgetsResponseShape
type: NodeShape
target class: CampaignManagementDeleteBudgetsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteCampaignConversionGoalsRequestShape
type: NodeShape
target class: CampaignManagementDeleteCampaignConversionGoalsRequest
property:
  path: campaignConversionGoal
  name: campaign conversion goal
  description: An array of the base object of a campaign conversion goal.
  node: CampaignManagementCampaignConversionGoalShape
  class: CampaignManagementCampaignConversionGoal
  node kind: BlankNodeOrIRI

CampaignManagementDeleteCampaignConversionGoalsResponseShape
type: NodeShape
target class: CampaignManagementDeleteCampaignConversionGoalsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteCampaignCriterionsRequestShape
type: NodeShape
target class: CampaignManagementDeleteCampaignCriterionsRequest
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign that owns the criterions to delete.
  datatype: long
  max count: 1
property:
  path: criterionType
  name: criterion type
  description: The type of criterion to delete, for example Webpage. You can specify only one criterion type value per call. To add, delete, or update target criterions i.e., age, day and time, device, gender, location, location intent, and radius criterions, you must specify the CriterionType value as Targets. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these target criterions via GetCampaignCriterionsByIds you must request the specific type individually i.e., Age, DayTime, Device, Gender, Location, LocationIntent, and Radius.
  datatype: string
  max count: 1
property:
  path: campaignCriterionIds
  name: campaign criterion ids
  description: A list of unique system identifiers corresponding to the campaign criterions that you want to delete. You can include up to 100 campaign criterion identifiers per request.
  datatype: long

CampaignManagementDeleteCampaignCriterionsResponseShape
type: NodeShape
target class: CampaignManagementDeleteCampaignCriterionsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteCampaignsRequestShape
type: NodeShape
target class: CampaignManagementDeleteCampaignsRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account that contains the campaigns to delete.
  datatype: long
  max count: 1
property:
  path: campaignIds
  name: campaign ids
  description: A maximum of 100 campaign identifiers to delete.
  datatype: long

CampaignManagementDeleteCampaignsResponseShape
type: NodeShape
target class: CampaignManagementDeleteCampaignsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteDataExclusionsRequestShape
type: NodeShape
target class: CampaignManagementDeleteDataExclusionsRequest
property:
  path: accountId
  name: account id
  description: The account ID.
  datatype: long
  max count: 1
property:
  path: dataExclusionIds
  name: data exclusion ids
  description: The IDs of the data exclusions to delete.
  datatype: long

CampaignManagementDeleteDataExclusionsResponseShape
type: NodeShape
target class: CampaignManagementDeleteDataExclusionsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteExperimentsRequestShape
type: NodeShape
target class: CampaignManagementDeleteExperimentsRequest
property:
  path: experimentIds
  name: experiment ids
  description: A maximum of 100 experiment identifiers to delete.
  datatype: long

CampaignManagementDeleteExperimentsResponseShape
type: NodeShape
target class: CampaignManagementDeleteExperimentsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

https://relay.inferal.com/ontology/microsoftads/CampaignManagementDeleteHTML5sRequestShape
type: NodeShape
target class: CampaignManagementDeleteHTML5sRequest
property:
  path: hTML5AssetIds
  name: h tml5asset ids
  description: Array of HTML5 asset IDs to delete from the specified campaign.
  datatype: long

https://relay.inferal.com/ontology/microsoftads/CampaignManagementDeleteHTML5sResponseShape
type: NodeShape
target class: CampaignManagementDeleteHTML5sResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that weren't successful.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteImportJobsRequestShape
type: NodeShape
target class: CampaignManagementDeleteImportJobsRequest
property:
  path: importJobIds
  name: import job ids
  description: The identifiers of the import jobs to delete.
  datatype: long
property:
  path: importType
  name: import type
  description: The type of import job to delete. To delete GoogleImportJob objects, set this element to "GoogleImportJob".
  datatype: string
  max count: 1

CampaignManagementDeleteImportJobsResponseShape
type: NodeShape
target class: CampaignManagementDeleteImportJobsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteKeywordsRequestShape
type: NodeShape
target class: CampaignManagementDeleteKeywordsRequest
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group that contains the keywords to delete.
  datatype: long
  max count: 1
property:
  path: keywordIds
  name: keyword ids
  description: A maximum of 1,000 keywords identifiers to delete.
  datatype: long

CampaignManagementDeleteKeywordsResponseShape
type: NodeShape
target class: CampaignManagementDeleteKeywordsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteLabelAssociationsRequestShape
type: NodeShape
target class: CampaignManagementDeleteLabelAssociationsRequest
property:
  path: entityType
  name: entity type
  description: Indicates the entity type associated with the label. The supported entity type values are Campaign, AdGroup, Ad, and Keyword.
  datatype: string
  max count: 1
  in: None
  in: Campaign
  in: AdGroup
  in: Ad
  in: Keyword
  in: AssetGroup
  in: TextAsset
  in: ImageAsset
property:
  path: labelAssociations
  name: label associations
  description: The list of label associations to delete. Each label association includes label and entity identifiers. The maximum size of the list is 100 items per service request.
  node: CampaignManagementLabelAssociationShape
  class: CampaignManagementLabelAssociation
  node kind: BlankNodeOrIRI

CampaignManagementLabelAssociationShape
type: NodeShape
target class: CampaignManagementLabelAssociation
property:
  path: labelId
  name: label id
  description: The identifier of the label. Set: Required Delete: Required
  datatype: long
  max count: 1
property:
  path: entityId
  name: entity id
  description: The identifier of an entity associated with the label. Supported entity types for labels are campaign, ad group, ad, and keyword. The entity type is specified in the request message of each DeleteLabelAssociations, GetLabelAssociationsByEntityIds, GetLabelAssociationsByLabelIds, and SetLabelAssociations operation. Each entity can be associated with a maximum of 50 labels. For example Campaign A can be associated with up to 50 labels. Set: Required Delete: Required
  datatype: long
  max count: 1

CampaignManagementDeleteLabelAssociationsResponseShape
type: NodeShape
target class: CampaignManagementDeleteLabelAssociationsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any associations that were not successfully retrieved. The list of errors corresponds directly to the list of associations in the request. Items of the list may be returned as null. For each list index where an association was successfully retrieved, the corresponding error element will be null. Ideally all associations are retrieved successfully and all elements in this list are null.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteLabelsRequestShape
type: NodeShape
target class: CampaignManagementDeleteLabelsRequest
property:
  path: labelIds
  name: label ids
  description: The identifiers of labels to delete. The maximum size of the list is 100 items per service request.
  datatype: long

CampaignManagementDeleteLabelsResponseShape
type: NodeShape
target class: CampaignManagementDeleteLabelsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteLinkedInSegmentsRequestShape
type: NodeShape
target class: CampaignManagementDeleteLinkedInSegmentsRequest
property:
  path: linkedInSegmentIds
  name: linked in segment ids
  description: Array of LinkedIn segment IDs to delete from the specified campaign.
  datatype: long

CampaignManagementDeleteLinkedInSegmentsResponseShape
type: NodeShape
target class: CampaignManagementDeleteLinkedInSegmentsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteListItemsFromSharedListRequestShape
type: NodeShape
target class: CampaignManagementDeleteListItemsFromSharedListRequest
property:
  path: listItemIds
  name: list item ids
  description: The list of identifiers of negative keywords to delete from the negative keyword list, or the negative sites to delete from the website exclusion list. The list can contain a maximum of 5,000 items per service call.
  datatype: long
property:
  path: sharedList
  name: shared list
  description: The negative keyword list or website exclusion list. If the SharedEntityScope is either empty or set to Account, and if the SharedList is a NegativeKeywordList, then the ListItemIds must identify negative keyword (NegativeKeyword) objects. If the SharedEntityScope is set to Customer, and if the SharedList is a PlacementExclusionList, then the ListItemIds must identify negative site (NegativeSite) objects.
  or:
    node: CampaignManagementAccountContentNegativeKeywordListShape
    class: CampaignManagementAccountContentNegativeKeywordList
  or:
    node: CampaignManagementAccountNegativeKeywordListShape
    class: CampaignManagementAccountNegativeKeywordList
  or:
    node: CampaignManagementAccountPlacementExclusionListShape
    class: CampaignManagementAccountPlacementExclusionList
  or:
    node: CampaignManagementAccountPlacementInclusionListShape
    class: CampaignManagementAccountPlacementInclusionList
  or:
    node: CampaignManagementBrandListShape
    class: CampaignManagementBrandList
  or:
    node: CampaignManagementNegativeKeywordListShape
    class: CampaignManagementNegativeKeywordList
  or:
    node: CampaignManagementPlacementExclusionListShape
    class: CampaignManagementPlacementExclusionList
  or:
    node: CampaignManagementSharedListShape
    class: CampaignManagementSharedList
  or:
    node: CampaignManagementSharedListBaseShape
    class: CampaignManagementSharedListBase
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: sharedEntityScope
  name: shared entity scope
  description: Indicates whether the shared entity is available at the ad account (Account) or manager account (Customer) level. This element is optional and defaults to Account scope. The ad account scope is only applicable for negative keyword lists. Set this element to Customer to delete negative sites from a website exclusion list in your manager account (customer) shared library.
  datatype: string
  max count: 1
  in: Account
  in: Customer

CampaignManagementDeleteListItemsFromSharedListResponseShape
type: NodeShape
target class: CampaignManagementDeleteListItemsFromSharedListResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteMediaRequestShape
type: NodeShape
target class: CampaignManagementDeleteMediaRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account that owns the media library.
  datatype: long
  max count: 1
property:
  path: mediaIds
  name: media ids
  description: A maximum of 100 media identifiers to delete from the account's media library. You cannot delete media that is associated or assigned to an ImageAdExtension or ResponsiveAd object. Otherwise this operation will return the 4024 CampaignServiceMediaIsAssociated error.
  datatype: long

CampaignManagementDeleteMediaResponseShape
type: NodeShape
target class: CampaignManagementDeleteMediaResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any media that were not successfully deleted. The list of errors corresponds directly to the list of media in the request. Items of the list may be returned as null. For each list index where media was successfully deleted, the corresponding error element will be null. Ideally all media are deleted successfully and all elements in this list are null.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteNegativeKeywordsFromEntitiesRequestShape
type: NodeShape
target class: CampaignManagementDeleteNegativeKeywordsFromEntitiesRequest
property:
  path: entityNegativeKeywords
  name: entity negative keywords
  description: An array of negative keyword with associated entity such as a campaign or ad group. The EntityType specified within each EntityNegativeKeyword must be set to the same value. This array can contain a maximum of 1 EntityNegativeKeyword element, which contains up to 20,000 negative keywords.
  node: CampaignManagementEntityNegativeKeywordShape
  class: CampaignManagementEntityNegativeKeyword
  node kind: BlankNodeOrIRI

CampaignManagementDeleteNegativeKeywordsFromEntitiesResponseShape
type: NodeShape
target class: CampaignManagementDeleteNegativeKeywordsFromEntitiesResponse
property:
  path: nestedPartialErrors
  name: nested partial errors
  description: An array of BatchErrorCollection objects that contain details for any criterion that were not successfully deleted. The top level error within each BatchErrorCollection object corresponds to potential campaign or ad group errors. The nested list of BatchError objects would include any errors specific to the negative keywords that you attempted to delete from the campaign or ad group. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorCollectionShape
    class: CampaignManagementBatchErrorCollection
  or:
    node: CampaignManagementBatchErrorCollectionBaseShape
    class: CampaignManagementBatchErrorCollectionBase
  or:
    node: CampaignManagementEditorialErrorCollectionShape
    class: CampaignManagementEditorialErrorCollection
  node kind: BlankNodeOrIRI

CampaignManagementDeleteSeasonalityAdjustmentsRequestShape
type: NodeShape
target class: CampaignManagementDeleteSeasonalityAdjustmentsRequest
property:
  path: accountId
  name: account id
  description: The account ID.
  datatype: long
  max count: 1
property:
  path: seasonalityAdjustmentIds
  name: seasonality adjustment ids
  description: The IDs of the seasonality adjustments to delete.
  datatype: long

CampaignManagementDeleteSeasonalityAdjustmentsResponseShape
type: NodeShape
target class: CampaignManagementDeleteSeasonalityAdjustmentsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array BatchError that contains details for any request items that were not successful. The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteSharedEntitiesRequestShape
type: NodeShape
target class: CampaignManagementDeleteSharedEntitiesRequest
property:
  path: sharedEntities
  name: shared entities
  description: The negative keyword lists or website exclusion lists to delete. If the SharedEntityScope is either empty or set to Account, then the SharedEntities must be negative keyword list (NegativeKeywordList) objects. If the SharedEntityScope is set to Customer, then the SharedEntities must be website exclusion list (PlacementExclusionList) objects. The list can contain a maximum of 20 elements.
  or:
    node: CampaignManagementAccountContentNegativeKeywordListShape
    class: CampaignManagementAccountContentNegativeKeywordList
  or:
    node: CampaignManagementAccountNegativeKeywordListShape
    class: CampaignManagementAccountNegativeKeywordList
  or:
    node: CampaignManagementAccountPlacementExclusionListShape
    class: CampaignManagementAccountPlacementExclusionList
  or:
    node: CampaignManagementAccountPlacementInclusionListShape
    class: CampaignManagementAccountPlacementInclusionList
  or:
    node: CampaignManagementBrandListShape
    class: CampaignManagementBrandList
  or:
    node: CampaignManagementNegativeKeywordListShape
    class: CampaignManagementNegativeKeywordList
  or:
    node: CampaignManagementPlacementExclusionListShape
    class: CampaignManagementPlacementExclusionList
  or:
    node: CampaignManagementSharedEntityShape
    class: CampaignManagementSharedEntity
  or:
    node: CampaignManagementSharedListShape
    class: CampaignManagementSharedList
  or:
    node: CampaignManagementSharedListBaseShape
    class: CampaignManagementSharedListBase
  node kind: BlankNodeOrIRI
property:
  path: sharedEntityScope
  name: shared entity scope
  description: Indicates whether the shared entity is available at the ad account (Account) or manager account (Customer) level. This element is optional and defaults to Account scope. The ad account scope is only applicable for negative keyword lists. Set this element to Customer to delete website exclusion lists in your manager account (customer) shared library.
  datatype: string
  max count: 1
  in: Account
  in: Customer

CampaignManagementDeleteSharedEntitiesResponseShape
type: NodeShape
target class: CampaignManagementDeleteSharedEntitiesResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteSharedEntityAssociationsRequestShape
type: NodeShape
target class: CampaignManagementDeleteSharedEntityAssociationsRequest
property:
  path: associations
  name: associations
  description: The list of negative keyword list to campaign associations, or website exclusion list to ad account associations. This array can contain a maximum of 10,000 elements.
  node: CampaignManagementSharedEntityAssociationShape
  class: CampaignManagementSharedEntityAssociation
  node kind: BlankNodeOrIRI
property:
  path: sharedEntityScope
  name: shared entity scope
  description: Indicates whether the shared entity is available at the ad account (Account) or manager account (Customer) level. This element is optional and defaults to Account scope. The ad account scope is only applicable for negative keyword list to campaign associations. Set this element to Customer to delete website exclusion list to ad account associations in your manager account (customer) shared library.
  datatype: string
  max count: 1
  in: Account
  in: Customer

CampaignManagementSharedEntityAssociationShape
type: NodeShape
target class: CampaignManagementSharedEntityAssociation
property:
  path: sharedEntityId
  name: shared entity id
  description: The identifier of the shared entity.
  datatype: long
  max count: 1
property:
  path: sharedEntityType
  name: shared entity type
  description: The type of shared entity. This element must be set to "NegativeKeywordList" for negative keyword list to campaign associations in your ad account shared library. This element must be set to "PlacementExclusionList" for website exclusion list to ad account associations in your manager account (customer) shared library. This element must be set to "BrandList" for brand list-to-campaign associations.
  datatype: string
  max count: 1
property:
  path: entityId
  name: entity id
  description: The identifier of the campaign or ad account (according to EntityType) that is associated with the shared entity.
  datatype: long
  max count: 1
property:
  path: entityType
  name: entity type
  description: The type of entity. This element must be set to "Campaign" for negative keyword list to campaign associations in your ad account shared library. This element must be set to "Account" for website exclusion list to ad account associations in your manager account (customer) shared library. This element must be set to "Campaign" for brand list-to-campaign associations.
  datatype: string
  max count: 1
property:
  path: sharedEntityCustomerId
  name: shared entity customer id
  description: Determines the owner of a website exclusion list. This read-only element is only available for PlacementExclusionList associations. Only the users of the manager account (customer) that owns a website exclusion list can update or delete the list, add or delete list items, and associate the list with ad accounts. If your ad account is associated with a website exclusion list that you do not own, you can disassociate the list from your account, but the list and list items are read-only.
  datatype: long
  max count: 1
property:
  path: isExclusion
  name: is exclusion
  description: For brand list-to-campaign associations, indicates whether the associated brand list is applied as an exclusion list (true) or an inclusion list (false). This field is reserved for all other association types.
  datatype: boolean
  max count: 1
property:
  path: status
  name: status
  description: Reserved.
  datatype: string
  max count: 1

CampaignManagementDeleteSharedEntityAssociationsResponseShape
type: NodeShape
target class: CampaignManagementDeleteSharedEntityAssociationsResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any associations that were not successfully deleted. The list of errors corresponds directly to the list of associations in the request. Items of the list may be returned as null. For each list index where an association was successfully deleted, the corresponding error element will be null. Ideally all associations are deleted successfully and all elements in this list are null.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeleteVideosRequestShape
type: NodeShape
target class: CampaignManagementDeleteVideosRequest
property:
  path: videoIds
  name: video ids
  description: The identifiers of videos to delete. The maximum size of the list is 100 items per service request.
  datatype: long

CampaignManagementDeleteVideosResponseShape
type: NodeShape
target class: CampaignManagementDeleteVideosResponse
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementDeviceCriterionShape
type: NodeShape
target class: CampaignManagementDeviceCriterion
property:
  path: type
  name: type
  description: The type of the criterion. This value is Device when you retrieve a device criterion. For more information about criterion types, see the Criterion Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: deviceName
  name: device name
  description: The name of the device to target. The following are the possible device names that you can specify. - Computers - Smartphones - Tablets Three separate bids for Computers, Tablets, and Smartphones should always be specified together. If you do not add individual device criterions representing each of the three device types, the missing device criterions will be added with the default bid adjustment of zero. Add: Required. Three separate criterions for Computers, Smartphones, and Tablets should be specified together in the same add criterions request. If you do not add individual device criterions representing each of the three device types, no device criterions will be added to the campaign or ad group. Update: Not allowed. If you specify this element it must match the existing setting.
  datatype: string
  max count: 1
property:
  path: oSName
  name: o sname
  description: Reserved for internal use. If you specify this element the add and update operations will not fail, but the OS names will not be set. When you retrieve this object, the OSName element will be nil. Add: Not allowed. Update: Not allowed.
  datatype: string
  max count: 1

CampaignManagementDiagnosticCardDataShape
type: NodeShape
target class: CampaignManagementDiagnosticCardData
property:
  path: metadata
  name: metadata
  description: Reserved.
  node: CampaignManagementHealthCheckMetadataShape
  class: CampaignManagementHealthCheckMetadata
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: checkpointsData
  name: checkpoints data
  description: Reserved.
  node: CampaignManagementHealthCheckDataShape
  class: CampaignManagementHealthCheckData
  node kind: BlankNodeOrIRI

CampaignManagementHealthCheckMetadataShape
type: NodeShape
target class: CampaignManagementHealthCheckMetadata
property:
  path: healthCheckName
  name: health check name
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckDisplayName
  name: health check display name
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckDescription
  name: health check description
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckSubType
  name: health check sub type
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckCategory
  name: health check category
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckSeverity
  name: health check severity
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckCategoryDisplayName
  name: health check category display name
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckColumnsMetadata
  name: health check columns metadata
  description: Reserved.
  node: CampaignManagementHealthCheckColumnMetadataShape
  class: CampaignManagementHealthCheckColumnMetadata
  node kind: BlankNodeOrIRI

CampaignManagementHealthCheckColumnMetadataShape
type: NodeShape
target class: CampaignManagementHealthCheckColumnMetadata
property:
  path: key
  name: key
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: title
  name: title
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckActionLinksMetadata
  name: health check action links metadata
  description: Reserved.
  node: CampaignManagementHealthCheckActionLinkMetadataShape
  class: CampaignManagementHealthCheckActionLinkMetadata
  node kind: BlankNodeOrIRI

CampaignManagementHealthCheckActionLinkMetadataShape
type: NodeShape
target class: CampaignManagementHealthCheckActionLinkMetadata
property:
  path: linkName
  name: link name
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: linkTemplate
  name: link template
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: linkType
  name: link type
  description: Reserved.
  datatype: string
  max count: 1

CampaignManagementHealthCheckDataShape
type: NodeShape
target class: CampaignManagementHealthCheckData
property:
  path: healthCheckEntity
  name: health check entity
  description: Reserved.
  node: CampaignManagementHealthCheckEntityShape
  class: CampaignManagementHealthCheckEntity
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: healthCheckName
  name: health check name
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckDataVersion
  name: health check data version
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckJsonData
  name: health check json data
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: healthCheckSubEntityResults
  name: health check sub entity results
  description: Reserved.
  node: CampaignManagementHealthCheckSubEntityDataShape
  class: CampaignManagementHealthCheckSubEntityData
  node kind: BlankNodeOrIRI
  max count: 1

CampaignManagementHealthCheckEntityShape
type: NodeShape
target class: CampaignManagementHealthCheckEntity
property:
  path: healthCheckEntityId
  name: health check entity id
  description: Reserved.
  datatype: long
  max count: 1
property:
  path: healthCheckEntityLevel
  name: health check entity level
  description: Reserved.
  datatype: string
  max count: 1

CampaignManagementHealthCheckSubEntityDataShape
type: NodeShape
target class: CampaignManagementHealthCheckSubEntityData
property:
  path: subEntityHealthIssueCount
  name: sub entity health issue count
  description: Reserved.
  datatype: int
  max count: 1
property:
  path: subEntityLevel
  name: sub entity level
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: subEntityIds
  name: sub entity ids
  description: Reserved.
  datatype: long

CampaignManagementDiagnosticCategoryDataShape
type: NodeShape
target class: CampaignManagementDiagnosticCategoryData
property:
  path: categoryKey
  name: category key
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: categoryDisplayName
  name: category display name
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: categorySeverity
  name: category severity
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: categoryStatus
  name: category status
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: actionLinks
  name: action links
  description: Reserved.
  node: CampaignManagementHealthCheckActionLinkMetadataShape
  class: CampaignManagementHealthCheckActionLinkMetadata
  node kind: BlankNodeOrIRI

CampaignManagementDiagnosticsEntityShape
type: NodeShape
target class: CampaignManagementDiagnosticsEntity
property:
  path: id
  name: id
  description: The diagnostic entity ID.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The diagnostic entity type.
  datatype: string
  max count: 1
property:
  path: subType
  name: sub type
  description: The diagnostic entity sub type.
  datatype: string
  max count: 1

CampaignManagementDiagnosticsFilterShape
type: NodeShape
target class: CampaignManagementDiagnosticsFilter
property:
  path: key
  name: key
  description: The name of the filter.
  datatype: string
  max count: 1
property:
  path: values
  name: values
  description: The values of the filter.
  datatype: string

CampaignManagementDiagnosticsRequestStatusShape
type: NodeShape
target class: CampaignManagementDiagnosticsRequestStatus
property:
  path: status
  name: status
  description: The diagnostic request status.
  datatype: string
  max count: 1
property:
  path: errors
  name: errors
  description: An array of OperationError objects corresponding to errors encountered during the system processing of the bulk file after your download request was submitted.
  node: CampaignManagementOperationErrorShape
  class: CampaignManagementOperationError
  node kind: BlankNodeOrIRI

CampaignManagementDiagnosticsSettingsShape
type: NodeShape
target class: CampaignManagementDiagnosticsSettings
property:
  path: enableCache
  name: enable cache
  description: The cache is enabled if True.
  datatype: boolean
  max count: 1
property:
  path: lastCheckTimeUTC
  name: last check time utc
  description: The last-checked time in UTC.
  datatype: string
  max count: 1
property:
  path: enablePilot
  name: enable pilot
  description: The pilot is enabled if True.
  datatype: boolean
  max count: 1

CampaignManagementDiagnosticTileDataShape
type: NodeShape
target class: CampaignManagementDiagnosticTileData
property:
  path: title
  name: title
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: headline
  name: headline
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Reserved.
  datatype: string
  max count: 1
property:
  path: progressPercent
  name: progress percent
  description: Reserved.
  datatype: int
  max count: 1

CampaignManagementDisclaimerAdExtensionShape
type: NodeShape
target class: CampaignManagementDisclaimerAdExtension
property:
  path: status
  name: status
  description: The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions.
  datatype: string
  max count: 1
  in: Active
  in: Deleted
property:
  path: scheduling
  name: scheduling
  description: Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads.
  node: CampaignManagementScheduleShape
  class: CampaignManagementSchedule
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: devicePreference
  name: device preference
  description: This element determines whether the preference is for the ad extension to be displayed on mobile devices or all devices. To specify a preference for mobile devices, set this element to 30001. To specify all devices, set this element to 0 (zero) or leave the element nil. By default, this element will be nil. This element is only applicable for the AppAdExtension and SitelinkAdExtension types.
  datatype: long
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad extension.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad extension. This value is DisclaimerAdExtension when you retrieve a location ad extension. Add: Read-only Update: Read-only For more information about ad extension types, see the Ad Extension Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Tracks the number of times the ad extension has been updated. The version is set to 1 when the ad extension is created, and increments by one after each update.
  datatype: int
  max count: 1
property:
  path: name
  name: name
  description: The name of the disclaimer. This is only used for reporting to help identify the extension. Max. length: 35 characters.
  datatype: string
  max count: 1
property:
  path: title
  name: title
  description: The title of the popup in popup layout. Max. length: 75 characters
  datatype: string
  max count: 1
property:
  path: popupText
  name: popup text
  description: Required text if the disclaimer is in popup layout. Max. length: 500 characters.
  datatype: string
  max count: 1
property:
  path: lineText
  name: line text
  description: Required text if the disclaimer is in additionalLine layout. Max. length: 80 characters.
  datatype: string
  max count: 1
property:
  path: disclaimerLayout
  name: disclaimer layout
  description: The layout of the disclaimer. Can either be additionalLine or popup.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: The landing page URL. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 list items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 list items for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The landing page URL for mobile devices. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 list items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 list items for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty list, the previous setting will be deleted.
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  description: For future use.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 3 CustomParameter objects that you include within the CustomParameters object, and any additional custom parameters will be ignored. Each CustomParameter includes Key and Value elements. For customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635), Microsoft Advertising will accept the first 8 custom parameter key and value pairs that you include, and if you include more than 8 custom parameters an error will be returned. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all FinalUrls and FinalMobileUrls. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementDisclaimerSettingShape
type: NodeShape
target class: CampaignManagementDisclaimerSetting
property:
  path: type
  name: type
  description: The type of setting. For more information, see Setting Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: disclaimerAdsEnabled
  name: disclaimer ads enabled
  description: This is a disclaimer ad when set to true. Note: This will always be a disclaimer ad once this is set to true. You can only set DiscalimerAdsEnabled during ad creation.
  datatype: boolean
  max count: 1

CampaignManagementDurationGoalShape
type: NodeShape
target class: CampaignManagementDurationGoal
property:
  path: name
  name: name
  description: The conversion goal name. The maximum length of the name is 100, and the name must be unique among all conversion goals belonging to the same customer. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Defines the possible user-determined status values of a conversion goal. These are the status values that a user can decide to set, for example a goal can be set to Paused if you no longer wish to track conversions for that goal. For status values that can be set by the system, for example whether or not the UET tag is verified, see the TrackingStatus element. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: scope
  name: scope
  description: Determines if the goal applies to all accounts or only the account specified in the required CustomerAccountId header element. If you have multiple Microsoft Advertising accounts, you can track conversions across all of those accounts. If you associate a goal with one account, conversions will be tracked for that account only. Possible values are Account and Customer. If not specified, the scope will be set to Customer by default. Once you set scope, you can't change it. If you want to change the scope, you need to create a new conversion goal and pause the old one. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: countType
  name: count type
  description: This determines how your conversions are recorded within your chosen conversion window. There are two choices, and if you do not set a value the default is All: - All: All conversions that happen after an ad click will be counted. This is a common choice for sales. - Unique: Only one conversion that happens after an ad click will be counted. This is a common choice for leads. For example: You track two conversions: leads and sales. You pick Unique for leads and All for sales. When one ad click turns into two leads and two sales, it's counted as three conversions: one for the unique lead, and two for all the sales. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: All
  in: Unique
property:
  path: revenue
  name: revenue
  description: Determines how much each conversion is worth to your business. When adding a conversion goal if you do not specify any revenue tracking preferences, then each ConversionGoalRevenue will be set to their respective default values. When updating a conversion goal, if the Revenue element is nil or empty then none of the nested properties will be updated. However, if this element is not nil or empty then you are effectively replacing any existing revenue properties. The VariableValue option is not available for duration conversion goals. Add: Optional Update: Optional
  node: CampaignManagementConversionGoalRevenueShape
  class: CampaignManagementConversionGoalRevenue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: conversionWindowInMinutes
  name: conversion window in minutes
  description: The conversion window is the length of time in minutes after a click that you want to track conversions. If you set this value to 43200 minutes (30 days), then conversions that happen within 30 days after a click are tracked. Past conversions aren't affected. The minimum value supported is 1 minute, although keep in mind that a shorter conversion window will reduce the number of conversions your account records. The maximum value supported is 129600 minutes (90 days). Add: Optional Update: Optional
  datatype: int
  max count: 1
property:
  path: tagId
  name: tag id
  description: The unique Microsoft Advertising identifier of the UET tag that you added to your website to allow Microsoft Advertising to collect actions people take on your website. Before you take a dependency on the tag ID, please note that the UET tag can be shared with or from another customer. Shared UET tags and audiences are only available for pilot customers. For an overview of sharing audiences and UET tags in a customer hierarchy, see the Share Audiences and UET Tags technical guide. Add: Required Update: Optional
  datatype: long
  max count: 1
property:
  path: trackingStatus
  name: tracking status
  description: Defines the possible system-determined status values of a conversion goal. These are the status values that can be set by the system, for example the system sets the status to TagUnverified if the UET tag has not yet been verified. For status values that a user can decide to set, for example setting the status to Paused if you no longer wish to track conversions for that goal, see the Status element. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: TagUnverified
  in: NoRecentConversions
  in: RecordingConversions
  in: TagInactive
  in: InactiveDueToTagUnavailable
property:
  path: excludeFromBidding
  name: exclude from bidding
  description: Determines whether or not to exclude data otherwise related to this conversion goal from a subset of performance report columns. This element is only available for customers who are enabled for the Include in Conversions feature (GetCustomerPilotFeatures returns 574). If this element is set to true, data otherwise related to this conversion goal will be excluded from the Conversions, ConversionRate, CostPerConversion, ReturnOnAdSpend, RevenuePerConversion, and Revenue report columns. Also, if you use an automated bidding bid strategy, setting this property true will result in the goal's conversions no longer factoring into automated bidding calculations. Setting this property "true" is effectively the same as unchecking "Include in Conversions" in the Microsoft Advertising web application. Regardless of this element value, the AllConversions, AllConversionRate, AllCostPerConversion, AllReturnOnAdSpend, AllRevenuePerConversion, and AllRevenue report columns will include data for all conversion goals. By default this element is false, and data related to this conversion goal are included in all report columns. For more information, see Report Attributes and Performance Statistics and the help article Conversion goals: "Conversions" versus "All conversions". Add: Optional Update: Optional
  datatype: boolean
  max count: 1
property:
  path: viewThroughConversionWindowInMinutes
  name: view through conversion window in minutes
  description: The view-through conversion window is the length of time in minutes after a click that you want to track view-through conversions. If you set this value to 43200 minutes (30 days), then view-through conversions that happen within 30 days after a click are tracked. Past conversions aren't affected. The minimum value supported is 1 minute, although keep in mind that a shorter conversion window will reduce the number of conversions your account records. The maximum value supported is 43200 minutes (30 days). The IncludeViewThroughConversions account property must also be set to true for view-through conversions to be tracked. This element is not returned by default. To get this element, include the ViewThroughConversionWindowInMinutes value in the ReturnAdditionalFields element when you call the GetConversionGoalsByIds and GetConversionGoalsByTagIds service operations. Add: Optional Update: Optional
  datatype: int
  max count: 1
property:
  path: goalCategory
  name: goal category
  description: The category used to segment the conversion goal. Categorize your conversion goals however makes sense for your business. Goal categories don't affect performance - they are here to help you segment your goals and their performance metrics. The supported category values vary by conversion goal type. Duration goals only support the Other category. Add: Optional. If you leave this element nil or empty, the default category will be set to Other. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Unknown
  in: None
  in: Purchase
  in: AddToCart
  in: BeginCheckout
  in: Subscribe
  in: SubmitLeadForm
  in: BookAppointment
  in: Signup
  in: RequestQuote
  in: GetDirections
  in: OutboundClick
  in: Contact
  in: PageView
  in: Download
  in: Other
property:
  path: attributionModelType
  name: attribution model type
  description: Determines which attribution model, _LastTouch_ or _LastClick_, is used with a conversion goal.
  datatype: string
  max count: 1
  in: LastClick
  in: LastTouch
  in: DataDriven
property:
  path: isEnhancedConversionsEnabled
  name: is enhanced conversions enabled
  description: Determines whether enhanced conversions are enabled for a conversion goal.
  datatype: boolean
  max count: 1
property:
  path: isAutoGoal
  name: is auto goal
  description: Only available for event goal.
  datatype: boolean
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the conversion goal. Add: Read-only Update: Required and Read-Only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the conversion goal. This value is Duration when you retrieve a duration goal. For more information about conversion goal types, see the ConversionGoal Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: minimumDurationInSeconds
  name: minimum duration in seconds
  description: The minimum amount of time in seconds that the user must spend on your website to track as a conversion. If you don't specify a value, the default value is 0, and the possible range is 0 through 86,399 (1 second less than a full 24 hour day). Add: Optional Update: Optional
  datatype: int
  max count: 1

CampaignManagementDynamicFeedSettingShape
type: NodeShape
target class: CampaignManagementDynamicFeedSetting
property:
  path: type
  name: type
  description: The type of setting. For more information, see Remarks.
  datatype: string
  max count: 1
property:
  path: feedId
  name: feed id
  description: The ID of the feed.
  datatype: long
  max count: 1

CampaignManagementDynamicSearchAdShape
type: NodeShape
target class: CampaignManagementDynamicSearchAd
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad. Add: Read-only Update: Required and Read-Only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad. This value is DynamicSearch when you retrieve an dynamic search ad. For more information about ad types, see the Ad Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Text
  in: Image
  in: Product
  in: AppInstall
  in: ExpandedText
  in: DynamicSearch
  in: ResponsiveAd
  in: ResponsiveSearch
  in: Hotel
property:
  path: status
  name: status
  description: The status of the ad. You can set the ad status to Active or Paused. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Inactive
  in: Active
  in: Paused
  in: Deleted
property:
  path: editorialStatus
  name: editorial status
  description: The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: devicePreference
  name: device preference
  description: Not supported for this ad type.
  datatype: long
  max count: 1
property:
  path: adFormatPreference
  name: ad format preference
  description: Not supported for this ad type.
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all landing page URLs. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: Not supported for this ad type.
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: Not supported for this ad type.
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  description: Not supported for this ad type.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Currently there are no supported forward compatibility map key and value pairs for dynamic search ads.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: text
  name: text
  description: The first part of the ad description. The text must contain at least one word. The maximum input length of the copy is 90 characters. Note that for ad groups that use Traditional Chinese the maximum input length of the copy is 45 characters. The text can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The text cannot contain the newline (\n) character. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: textPart2
  name: text part2
  description: The second part of the ad description. The text must contain at least one word. The maximum input length of the copy is 90 characters. Note that for ad groups that use Traditional Chinese the maximum input length of the copy is 45 characters. The text can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The text cannot contain the newline (\n) character. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: path1
  name: path1
  description: The first part of the optional path that will be appended to the domain portion of your display URL. The display URL e.g. www.contoso.com will be generated from the domain of your display URL. Then if you have specified a value for Path 1 it will be appended to the display URL. If you have also specified a value for Path 2, then it will also be appended to the display URL after Path 1. For example if your domain is contoso.com, Path 1 is set to subdirectory1, and Path 2 is set to subdirectory2, then the URL displayed will be www.contoso.com/subdirectory1/subdirectory2. The maximum input length of the path is 15 characters. Note that for languages with double-width characters e.g. Traditional Chinese the maximum input length of the path is 7 characters. The path can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The path cannot contain the forward slash (/) or newline (\n) characters. If the path includes a space, it will be replaced with an underscore (_) when the ad is shown. Add: Optional Update: Optional
  datatype: string
  max count: 1
property:
  path: path2
  name: path2
  description: The second part of the optional path that will be appended to the domain portion of your display URL. The display URL e.g. www.contoso.com will be generated from the domain of your dynamic search ads campaign level settings. Then if you have specified a value for Path 1 it will be appended to the display URL. If you have also specified a value for Path 2, then it will also be appended to the display URL after Path 1. For example if your domain is contoso.com, Path 1 is set to subdirectory1, and Path 2 is set to subdirectory2, then the URL displayed will be www.contoso.com/subdirectory1/subdirectory2. You can only specify Path2 if Path1 is also set. The maximum input length of the path is 15 characters. Note that for languages with double-width characters e.g. Traditional Chinese the maximum input length of the path is 7 characters. The path can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The path cannot contain the forward slash (/) or newline (\n) characters. If the path includes a space, it will be replaced with an underscore (_) when the ad is shown. Add: Optional Update: Optional
  datatype: string
  max count: 1

CampaignManagementDynamicSearchAdsSettingShape
type: NodeShape
target class: CampaignManagementDynamicSearchAdsSetting
property:
  path: type
  name: type
  description: The type of the setting. This value is DynamicSearchAds when you retrieve a dynamic search ads setting. For more information about setting types, see the Setting Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: domainName
  name: domain name
  description: The website name corresponding to the pages you want your ads to target. The maximum length of the domain is 2,048 characters. You do not need to include the http, https, or www prefix.
  datatype: string
  max count: 1
property:
  path: language
  name: language
  description: The language of the website pages that you want to target for dynamic search ads. Your website language determines where your ads are eligible to appear. For example, a German-language ad can appear in Germany, Austria, and Switzerland, but not in Spain. If your website contains pages in multiple languages and you want to advertise all of these pages, you should create a separate campaign for each language. The supported domain languages are Dutch, English, French, German, Italian, Spanish, and Swedish. Note, if you set the campaign Languages or ad group Language, they will be ignored. Add: Required Update: Read-only and required. You cannot update the domain or language, but you must include the current domain and language when updating other properties such as Source.
  datatype: string
  max count: 1
property:
  path: source
  name: source
  description: Determines whether to use Bing's index, advertiser supplied URLs, or both. By default only Bing's index is used. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: All
  in: SystemIndex
  in: AdvertiserSuppliedUrls
property:
  path: pageFeedIds
  name: page feed ids
  description: The page feed identifiers for dynamic search ads. The Source determines whether or not Microsoft Advertising will use the associated page feeds. See the Page Feeds technical guide for an implementation overview. Add: Optional Update: Optional. You cannot delete page feed IDs, but you can replace the previous set with a new set.
  datatype: long
property:
  path: dynamicDescriptionEnabled
  name: dynamic description enabled
  description: Determines whether to automatically generate dynamic search ad text in addition to the ad text you provide. During ad delivery, we will use artificial intelligence to choose the best ad text available from these options. Add: Optional. The default value of false will be set if not otherwise specified. Update: Optional. If no value is set for the update, this setting is not changed. Note: Not everyone has this feature yet. If you don't, don't worry - it's coming soon!
  datatype: boolean
  max count: 1

CampaignManagementEditorialApiFaultDetailShape
type: NodeShape
target class: CampaignManagementEditorialApiFaultDetail
property:
  path: trackingId
  name: tracking id
  description: The identifier of the log entry that contains the details of the API call.
  datatype: string
  max count: 1
property:
  path: editorialErrors
  name: editorial errors
  description: An array of editorial errors that contains the details that explain why the criterion or ad extension was disapproved.
  node: CampaignManagementEditorialErrorShape
  class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI
property:
  path: batchErrors
  name: batch errors
  description: An array of batch errors that identifies the items in the batch of items in the request message that caused the operation to fail. Each object contains the details that explain why the item caused the failure.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI
property:
  path: operationErrors
  name: operation errors
  description: An array of operation errors that contains the details that explain why the service operation failed when the error is not related to a specific item in the batch of items.
  node: CampaignManagementOperationErrorShape
  class: CampaignManagementOperationError
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  datatype: string
  max count: 1

CampaignManagementEditorialErrorCollectionShape
type: NodeShape
target class: CampaignManagementEditorialErrorCollection
property:
  path: index
  name: index
  description: The zero-based top level list index in the request message that failed.
  datatype: int
  max count: 1
property:
  path: disapprovedText
  name: disapproved text
  description: The text that caused the entity to be disapproved. For text length violations, this element specifies the number of characters by which the specified text exceeds the maximum.
  datatype: string
  max count: 1
property:
  path: reasonCode
  name: reason code
  description: A numeric code that identifies the error. For more information, see Editorial Reason Codes.
  datatype: int
  max count: 1
property:
  path: location
  name: location
  description: The element or property of the entity that caused the entity to be disapproved.
  datatype: string
  max count: 1
property:
  path: publisherCountry
  name: publisher country
  description: The corresponding country or region for the flagged editorial issue.
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this data object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: fieldPath
  name: field path
  description: The name of the data object's element where the error occurred. This value is subject to change, so you should not take a dependency on the current string format. This element is not supported for all errors.
  datatype: string
  max count: 1
property:
  path: batchErrors
  name: batch errors
  description: A list of batch errors corresponding to the nested list index.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI
property:
  path: message
  name: message
  description: A message that describes the error for the top level list index.
  datatype: string
  max count: 1
property:
  path: errorCode
  name: error code
  description: A symbolic string constant that identifies the error for the top level list index.
  datatype: string
  max count: 1
property:
  path: code
  name: code
  description: A numeric error code that identifies the error for the top level list index.
  datatype: int
  max count: 1
property:
  path: details
  name: details
  description: A message that provides additional details about the batch error for the top level list index. This string can be empty.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Reserved for internal use.
  datatype: string
  max count: 1
property:
  path: appealable
  name: appealable
  description: Reserved for future use.
  datatype: boolean
  max count: 1

CampaignManagementEditorialReasonShape
type: NodeShape
target class: CampaignManagementEditorialReason
property:
  path: reasonCode
  name: reason code
  description: A code that identifies the reason for the failure. For a list of possible reason codes, see Editorial Reason Codes.
  datatype: int
  max count: 1
property:
  path: location
  name: location
  description: The component of the ad or keyword that failed editorial review.
  datatype: string
  max count: 1
property:
  path: term
  name: term
  description: The term that failed editorial review. This element cannot be set if a combination of terms caused the failure or if the failure was based on a policy violation.
  datatype: string
  max count: 1
property:
  path: publisherCountries
  name: publisher countries
  description: A list of countries or regions where the ad or keyword failed editorial review. Each string in the list contains a two character country or region code.
  datatype: string

CampaignManagementEditorialReasonCollectionShape
type: NodeShape
target class: CampaignManagementEditorialReasonCollection
property:
  path: adOrKeywordId
  name: ad or keyword id
  description: Identifies the ad or keyword that failed editorial review. Note: AdOrKeywordId is the ID of the asset.
  datatype: long
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: Identifies the ad group which is the parent of the ad or keyword that failed editorial review. Note: AdGroupId is always 0 for an asset since it doesn't belong to an ad group.
  datatype: long
  max count: 1
property:
  path: reasons
  name: reasons
  description: An array of editorial reasons that you can use to determine the component of an ad or keyword that failed editorial review, and the reason for the failure.
  node: CampaignManagementEditorialReasonShape
  class: CampaignManagementEditorialReason
  node kind: BlankNodeOrIRI
property:
  path: appealStatus
  name: appeal status
  description: A value that determines whether you can appeal the issues found by the editorial review. Note: AppealStatus is based on information in the catalog.AssetEditorialStatus table. It's a combination of Appealability and IsAppealPending.
  datatype: string
  max count: 1
  in: None
  in: Appealable
  in: AppealPending
  in: NotAppealable

CampaignManagementEnhancedCpcBiddingSchemeShape
type: NodeShape
target class: CampaignManagementEnhancedCpcBiddingScheme
property:
  path: type
  name: type
  description: The type of the bidding scheme. This value is EnhancedCpcBiddingScheme when you retrieve an enhanced CPC bidding scheme. For more information about bidding scheme types, see the BiddingScheme Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1

CampaignManagementEntityResultShape
type: NodeShape
target class: CampaignManagementEntityResult
property:
  path: id
  name: id
  description: The entity ID.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The entity type.
  datatype: string
  max count: 1
property:
  path: subType
  name: sub type
  description: The entity sub type.
  datatype: string
  max count: 1
property:
  path: categories
  name: categories
  description: The entity categories.
  node: CampaignManagementCategoryResultShape
  class: CampaignManagementCategoryResult
  node kind: BlankNodeOrIRI

CampaignManagementEventGoalShape
type: NodeShape
target class: CampaignManagementEventGoal
property:
  path: name
  name: name
  description: The conversion goal name. The maximum length of the name is 100, and the name must be unique among all conversion goals belonging to the same customer. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Defines the possible user-determined status values of a conversion goal. These are the status values that a user can decide to set, for example a goal can be set to Paused if you no longer wish to track conversions for that goal. For status values that can be set by the system, for example whether or not the UET tag is verified, see the TrackingStatus element. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Active
  in: Paused
  in: Deleted
property:
  path: scope
  name: scope
  description: Determines if the goal applies to all accounts or only the account specified in the required CustomerAccountId header element. If you have multiple Microsoft Advertising accounts, you can track conversions across all of those accounts. If you associate a goal with one account, conversions will be tracked for that account only. Possible values are Account and Customer. If not specified, the scope will be set to Customer by default. Once you set scope, you can't change it. If you want to change the scope, you need to create a new conversion goal and pause the old one. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Account
  in: Customer
property:
  path: countType
  name: count type
  description: This determines how your conversions are recorded within your chosen conversion window. There are two choices, and if you do not set a value the default is All: - All: All conversions that happen after an ad click will be counted. This is a common choice for sales. - Unique: Only one conversion that happens after an ad click will be counted. This is a common choice for leads. For example: You track two conversions: leads and sales. You pick Unique for leads and All for sales. When one ad click turns into two leads and two sales, it's counted as three conversions: one for the unique lead, and two for all the sales. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: All
  in: Unique
property:
  path: revenue
  name: revenue
  description: Determines how much each conversion is worth to your business. When adding a conversion goal if you do not specify any revenue tracking preferences, then each ConversionGoalRevenue will be set to their respective default values. When updating a conversion goal, if the Revenue element is nil or empty then none of the nested properties will be updated. However, if this element is not nil or empty then you are effectively replacing any existing revenue properties. Add: Optional Update: Optional
  node: CampaignManagementConversionGoalRevenueShape
  class: CampaignManagementConversionGoalRevenue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: conversionWindowInMinutes
  name: conversion window in minutes
  description: The conversion window is the length of time in minutes after a click that you want to track conversions. If you set this value to 43200 minutes (30 days), then conversions that happen within 30 days after a click are tracked. Past conversions aren't affected. The minimum value supported is 1 minute, although keep in mind that a shorter conversion window will reduce the number of conversions your account records. The maximum value supported is 129600 minutes (90 days). Add: Optional Update: Optional
  datatype: int
  max count: 1
property:
  path: tagId
  name: tag id
  description: The unique Microsoft Advertising identifier of the UET tag that you added to your website to allow Microsoft Advertising to collect actions people take on your website. Before you take a dependency on the tag ID, please note that the UET tag can be shared with or from another customer. Shared UET tags and audiences are only available for pilot customers. For an overview of sharing audiences and UET tags in a customer hierarchy, see the Share Audiences and UET Tags technical guide. Add: Required Update: Optional
  datatype: long
  max count: 1
property:
  path: trackingStatus
  name: tracking status
  description: Defines the possible system-determined status values of a conversion goal. These are the status values that can be set by the system, for example the system sets the status to TagUnverified if the UET tag has not yet been verified. For status values that a user can decide to set, for example setting the status to Paused if you no longer wish to track conversions for that goal, see the Status element. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: TagUnverified
  in: NoRecentConversions
  in: RecordingConversions
  in: TagInactive
  in: InactiveDueToTagUnavailable
property:
  path: excludeFromBidding
  name: exclude from bidding
  description: Determines whether or not to exclude data otherwise related to this conversion goal from a subset of performance report columns. This element is only available for customers who are enabled for the Include in Conversions feature (GetCustomerPilotFeatures returns 574). If this element is set to true, data otherwise related to this conversion goal will be excluded from the Conversions, ConversionRate, CostPerConversion, ReturnOnAdSpend, RevenuePerConversion, and Revenue report columns. Also, if you use an automated bidding bid strategy, setting this property true will result in the goal's conversions no longer factoring into automated bidding calculations. Setting this property "true" is effectively the same as unchecking "Include in Conversions" in the Microsoft Advertising web application. Regardless of this element value, the AllConversions, AllConversionRate, AllCostPerConversion, AllReturnOnAdSpend, AllRevenuePerConversion, and AllRevenue report columns will include data for all conversion goals. By default this element is false, and data related to this conversion goal are included in all report columns. For more information, see Report Attributes and Performance Statistics and the help article Conversion goals: "Conversions" versus "All conversions". Add: Optional Update: Optional
  datatype: boolean
  max count: 1
property:
  path: viewThroughConversionWindowInMinutes
  name: view through conversion window in minutes
  description: The view-through conversion window is the length of time in minutes after a click that you want to track view-through conversions. If you set this value to 43200 minutes (30 days), then view-through conversions that happen within 30 days after a click are tracked. Past conversions aren't affected. The minimum value supported is 1 minute, although keep in mind that a shorter conversion window will reduce the number of conversions your account records. The maximum value supported is 43200 minutes (30 days). The IncludeViewThroughConversions account property must also be set to true for view-through conversions to be tracked. This element is not returned by default. To get this element, include the ViewThroughConversionWindowInMinutes value in the ReturnAdditionalFields element when you call the GetConversionGoalsByIds and GetConversionGoalsByTagIds service operations. Add: Optional Update: Optional
  datatype: int
  max count: 1
property:
  path: goalCategory
  name: goal category
  description: The category used to segment the conversion goal. Categorize your conversion goals however makes sense for your business. Goal categories don't affect performance - they are here to help you segment your goals and their performance metrics. The supported category values vary by conversion goal type. Event goals support the AddToCart, BeginCheckout, BookAppointment, Contact, GetDirections, Other, OutboundClick, PageView, Purchase, RequestQuote, Signup, SubmitLeadForm, and Subscribe categories. Add: Required as of June 2021. Previously if you left this element nil or empty, the default category was set to None. Update: Optional if the conversion goal already has a category set other than None. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
  in: Unknown
  in: None
  in: Purchase
  in: AddToCart
  in: BeginCheckout
  in: Subscribe
  in: SubmitLeadForm
  in: BookAppointment
  in: Signup
  in: RequestQuote
  in: GetDirections
  in: OutboundClick
  in: Contact
  in: PageView
  in: Download
  in: Other
property:
  path: attributionModelType
  name: attribution model type
  description: Determines which attribution model, _LastTouch_ or _LastClick_, is used with a conversion goal.
  datatype: string
  max count: 1
  in: LastClick
  in: LastTouch
  in: DataDriven
property:
  path: isEnhancedConversionsEnabled
  name: is enhanced conversions enabled
  description: Determines whether enhanced conversions are enabled for a conversion goal.
  datatype: boolean
  max count: 1
property:
  path: isAutoGoal
  name: is auto goal
  description: Determines whether this goal is a simplified conversion goal. For the EventGoal columns ActionExpression, ActionOperator, CategoryExpression, CategoryOperator, LabelExpression, LabelOperator, Value, and ValueOperator: Advertisers can't manually specify values.Microsoft Advertising automatically generates compatible values based on the associated conversion event.
  datatype: boolean
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier for the conversion goal. Add: Read-only Update: Required and Read-Only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the conversion goal. This value is Event when you retrieve an event goal. For more information about conversion goal types, see the ConversionGoal Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: categoryExpression
  name: category expression
  description: The category of event you want to track. For example, 'video'. If this element is specified during an add or update operation, then the CategoryOperator element is also required. The string cannot exceed the maximum length of 100. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and ActionExpression), (CategoryOperator and CategoryExpression), (LabelOperator and LabelExpression), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include CategoryOperator and CategoryExpression during update, any existing CategoryOperator and CategoryExpression settings will be deleted.
  datatype: string
  max count: 1
property:
  path: categoryOperator
  name: category operator
  description: The operator that can be applied to the value of the CategoryExpression element. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and ActionExpression), (CategoryOperator and CategoryExpression), (LabelOperator and LabelExpression), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include CategoryOperator and CategoryExpression during update, any existing CategoryOperator and CategoryExpression settings will be deleted.
  datatype: string
  max count: 1
  in: Equals
  in: BeginsWith
  in: RegularExpression
  in: Contains
property:
  path: actionExpression
  name: action expression
  description: The type of user interaction you want to track. For example 'play' or 'pause'. If this element is specified during an add or update operation, then the ActionOperator element is also required. The string cannot exceed the maximum length of 100. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and ActionExpression), (CategoryOperator and CategoryExpression), (LabelOperator and LabelExpression), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ActionOperator and ActionExpression during update, any existing ActionOperator and ActionExpression settings will be deleted.
  datatype: string
  max count: 1
property:
  path: actionOperator
  name: action operator
  description: The operator that can be applied to the value of the ActionExpression element. If this element is specified during an add or update operation, then the ActionExpression element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and ActionExpression), (CategoryOperator and CategoryExpression), (LabelOperator and LabelExpression), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ActionOperator and ActionExpression during update, any existing ActionOperator and ActionExpression settings will be deleted.
  datatype: string
  max count: 1
  in: Equals
  in: BeginsWith
  in: RegularExpression
  in: Contains
property:
  path: labelExpression
  name: label expression
  description: The name of the element that caused the action. For example 'trailer' or 'behindthescenes'. If this element is specified during an add or update operation, then the LabelOperator element is also required. The string cannot exceed the maximum length of 100. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and ActionExpression), (CategoryOperator and CategoryExpression), (LabelOperator and LabelExpression), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include LabelOperator and LabelExpression during update, any existing LabelOperator and LabelExpression settings will be deleted.
  datatype: string
  max count: 1
property:
  path: labelOperator
  name: label operator
  description: The operator that can be applied to the value of the LabelExpression element. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and ActionExpression), (CategoryOperator and CategoryExpression), (LabelOperator and LabelExpression), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include LabelOperator and LabelExpression during update, any existing LabelOperator and LabelExpression settings will be deleted.
  datatype: string
  max count: 1
  in: Equals
  in: BeginsWith
  in: RegularExpression
  in: Contains
property:
  path: valueOperator
  name: value operator
  description: The operator that can be applied to the value of the Value element. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and ActionExpression), (CategoryOperator and CategoryExpression), (LabelOperator and LabelExpression), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ValueOperator and Value during update, any existing ValueOperator and Value settings will be deleted.
  datatype: string
  max count: 1
  in: Equals
  in: LessThan
  in: GreaterThan
property:
  path: value
  name: value
  description: A numerical value associated with that event. For example the value could be the duration of time that the video played. If this element is specified during an add or update operation, then the ValueOperator element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and ActionExpression), (CategoryOperator and CategoryExpression), (LabelOperator and LabelExpression), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ValueOperator and Value during update, any existing ValueOperator and Value settings will be deleted
  datatype: double
  max count: 1

CampaignManagementExpandedTextAdShape
type: NodeShape
target class: CampaignManagementExpandedTextAd
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad. Add: Read-only Update: Required and Read-Only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad. This value is ExpandedText when you retrieve an expanded text ad. For more information about ad types, see the Ad Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Text
  in: Image
  in: Product
  in: AppInstall
  in: ExpandedText
  in: DynamicSearch
  in: ResponsiveAd
  in: ResponsiveSearch
  in: Hotel
property:
  path: status
  name: status
  description: The status of the ad. You can set the ad status to Active or Paused. Add: Optional Update: Optional
  datatype: string
  max count: 1
  in: Inactive
  in: Active
  in: Paused
  in: Deleted
property:
  path: editorialStatus
  name: editorial status
  description: The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: devicePreference
  name: device preference
  description: Not supported for this ad type.
  datatype: long
  max count: 1
property:
  path: adFormatPreference
  name: ad format preference
  description: The Ad Format Preference is used to indicate whether or not you prefer the ad copy to be shown to users as a search or audience ad. Search ads tend to be written as a call to action, whereas audience ads should be written in more of an informational style. While you have the option to use expanded text ads as audience ads, designating an ad as Audience ads preferred format allows you to optimize its messaging for native delivery. IMPORTANT: You must define at least one expanded text ad per ad group that does not prefer audience ads, otherwise the ad copy of all expanded text ads will be eligible for both search and audience ads. Possible values are AudienceAd and All. If set to All, the ad will be eligible for both search and audience ad formats. If set to AudienceAd, the ad will only be eligible for the audience ad format. Add: Optional. If you do not set this element, by default the ad format preference will be set to All. Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all landing page URLs. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: The landing page URL. The domain portion of the URL in combination with the path 1 and path 2 strings cannot exceed 67 characters. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. - You may not specify FinalMobileUrls if the device preference is set to mobile. Also note that if this ad's TrackingUrlTemplate or UrlCustomParameters element are set, then at least one final URL is required. This URL is used only if the keyword does not specify a final URL. Add: Required Update: Optional
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The mobile landing page URL. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. - You may not specify FinalMobileUrls if the device preference is set to mobile. This URL is used only if the keyword does not specify a final mobile URL. Add: Optional Update: Optional
  datatype: string
property:
  path: finalAppUrls
  name: final app urls
  description: Not supported for this ad type.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: titlePart1
  name: title part1
  description: The first part of the ad title. The three title parts will be automatically separated by a space, vertical bar, and space (" | ") when the ad is shown. Each part of the title must contain at least one word. For efficient use of resources we recommend that you use dynamic text strings such as {keyword} instead of creating new ad copy for each keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. The title can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The maximum input length is 1,000 characters if you include dynamic text strings. No more than 30 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of all three title parts exceed 90 characters after dynamic text substitution occurs. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 500 characters if you include dynamic text strings. No more than 15 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of all three title parts exceed 45 characters after dynamic text substitution occurs. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The title cannot contain the newline (\n) character. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: titlePart2
  name: title part2
  description: The second part of the ad title. The three title parts will be automatically separated by a space, vertical bar, and space (" | ") when the ad is shown. Each part of the title must contain at least one word. For efficient use of resources we recommend that you use dynamic text strings such as {keyword} instead of creating new ad copy for each keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. The title can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The maximum input length is 1,000 characters if you include dynamic text strings. No more than 30 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of all three title parts exceed 90 characters after dynamic text substitution occurs. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 500 characters if you include dynamic text strings. No more than 15 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of all three title parts exceed 45 characters after dynamic text substitution occurs. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The title cannot contain the newline (\n) character. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: text
  name: text
  description: The first part of the ad description that can show in your ad. To maximize impressions across all ad formats the description might not always be shown in your ad. The text must contain at least one word. For efficient use of resources we recommend that you use dynamic text strings such as {keyword} instead of creating new ad copy for each keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. The text can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The maximum input length is 1,000 characters if you include dynamic text strings. No more than 90 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of both text parts exceed 180 characters after dynamic text substitution occurs. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 500 characters if you include dynamic text strings. No more than 45 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of both text parts exceed 90 characters after dynamic text substitution occurs. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The text cannot contain the newline (\n) character. Add: Required Update: Optional
  datatype: string
  max count: 1
property:
  path: path1
  name: path1
  description: The first part of the optional path that will be appended to the domain portion of your display URL. The domain portion of your display URL e.g. https://www.contoso.com will be generated from the domain of your Final URL (FinalUrls element). Then if you have specified a value for Path1 it will be appended to the display URL. If you have also specified a value for Path2, then it will also be appended to the display URL after Path1. For example if your FinalUrls contains https://www.contoso.com, Path1 is set to subdirectory1, and Path2 is set to subdirectory2, then the URL displayed will be https://www.contoso.com/subdirectory1/subdirectory2. The path can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The path can contain dynamic parameters such as {MatchType}. For a list of supported parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use?. The maximum input length is 1,000 characters if you include dynamic text strings. No more than 15 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of the final URL domain and the paths combined exceed 67 characters. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 1,000 characters if you include dynamic text strings. No more than 7 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of the final URL domain and the paths combined exceed 33 characters. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The p…
  datatype: string
  max count: 1
property:
  path: path2
  name: path2
  description: The second part of the optional path that will be appended to the domain portion of your display URL. The domain portion of your display URL e.g. https://www.contoso.com will be generated from the domain of your Final URL (FinalUrls element). Then if you have specified a value for Path1 it will be appended to the display URL. If you have also specified a value for Path2, then it will also be appended to the display URL after Path1. For example if your FinalUrls contains https://www.contoso.com, Path1 is set to subdirectory1, and Path2 is set to subdirectory2, then the URL displayed will be https://www.contoso.com/subdirectory1/subdirectory2. You can only specify Path2 if Path1 is also set. The path can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The path can contain dynamic parameters such as {MatchType}. For a list of supported parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use?. The maximum input length is 1,000 characters if you include dynamic text strings. No more than 15 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of the final URL domain and the paths combined exceed 67 characters. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 1,000 characters if you include dynamic text strings. No more than 7 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of the final URL domain and the paths combined exceed 33 characters. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chi…
  datatype: string
  max count: 1
property:
  path: domain
  name: domain
  description: The URL that will be displayed instead of the final URL. The final URL will still be used for the landing page URL. Reserved for limited pilot usage e.g. pharmaceutical customers. The domain portion of the URL in combination with the path 1 and path 2 strings cannot exceed 67 characters. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: titlePart3
  name: title part3
  description: The third part of the ad title. The three title parts will be automatically separated by a space, vertical bar, and space (" | ") when the ad is shown. Each part of the title must contain at least one word. For efficient use of resources we recommend that you use dynamic text strings such as {keyword} instead of creating new ad copy for each keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. The title can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The maximum input length is 1,000 characters if you include dynamic text strings. No more than 30 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of all three title parts exceed 90 characters after dynamic text substitution occurs. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 500 characters if you include dynamic text strings. No more than 15 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of all three title parts exceed 45 characters after dynamic text substitution occurs. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The title cannot contain the newline (\n) character. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: textPart2
  name: text part2
  description: The second part of the ad description that can show in your ad. To maximize impressions across all ad formats the description might not always be shown in your ad. The text must contain at least one word. For efficient use of resources we recommend that you use dynamic text strings such as {keyword} instead of creating new ad copy for each keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. The text can contain IF and countdown functions. Regardless of the total length of all unsubstituted countdown parameters, the final displayed countdown will always use 8 characters out of the total characters available. For more details see Countdown Customizers. The maximum input length is 1,000 characters if you include dynamic text strings. No more than 90 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of both text parts exceed 180 characters after dynamic text substitution occurs. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 500 characters if you include dynamic text strings. No more than 45 final (not dynamic text) characters can be input. The ad will fail to display or the default text will be used if the length of both text parts exceed 90 characters after dynamic text substitution occurs. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as well as Emojis. The text cannot contain the newline (\n) character. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1

CampaignManagementFileImportJobShape
type: NodeShape
target class: CampaignManagementFileImportJob
property:
  path: name
  name: name
  description: The name of the import job
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the import job.
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the import job. This value is FileImportJob when you retrieve a File import job. For more information about import job types, see the ImportJob Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of the import job.
  datatype: string
  max count: 1
property:
  path: notificationType
  name: notification type
  description: Determines whether and how often you want to receive email notifications about the import job results.
  datatype: string
  max count: 1
property:
  path: createdByUserId
  name: created by user id
  description: The unique identifier of the Microsoft Advertising user who created the import job.
  datatype: long
  max count: 1
property:
  path: createdByUserName
  name: created by user name
  description: The login user name of the Microsoft Advertising user who created the import job.
  datatype: string
  max count: 1
property:
  path: frequency
  name: frequency
  description: Determines whether the import job should be run once or scheduled on a recurring basis. To run the import job now, this element should be nil or empty.
  node: CampaignManagementFrequencyShape
  class: CampaignManagementFrequency
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: lastRunTimeInUTC
  name: last run time in utc
  description: The most recent import date and time for this job. The date and time is expressed in Coordinated Universal Time (UTC).
  datatype: dateTime
  max count: 1
property:
  path: createdDateTimeInUTC
  name: created date time in utc
  description: The date and time when the import job was created. The date and time is expressed in Coordinated Universal Time (UTC).
  datatype: dateTime
  max count: 1
property:
  path: importOption
  name: import option
  description: The import options that are available via API.
  or:
    node: CampaignManagementFileImportOptionShape
    class: CampaignManagementFileImportOption
  or:
    node: CampaignManagementGoogleImportOptionShape
    class: CampaignManagementGoogleImportOption
  or:
    node: CampaignManagementImportOptionShape
    class: CampaignManagementImportOption
  or:
    node: CampaignManagementImportOptionBaseShape
    class: CampaignManagementImportOptionBase
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: notificationEmail
  name: notification email
  description: The email address where import results should be sent. This element is not returned by default. To get this element, include the NotificationEmail value in the ReturnAdditionalFields element when you call the GetImportJobsByIds and GetImportResults service operations.
  datatype: string
  max count: 1
property:
  path: fileUrl
  name: file url
  description: Reserved for future use.
  datatype: string
  max count: 1
property:
  path: fileSource
  name: file source
  description: Reserved for future use.
  datatype: string
  max count: 1

CampaignManagementFileImportOptionShape
type: NodeShape
target class: CampaignManagementFileImportOption
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  description: The type of the import option. This value is FileImportOption when you retrieve a File import option. For more information about import option types, see the ImportOption Data Object Remarks.
  datatype: string
  max count: 1

CampaignManagementFilterLinkAdExtensionShape
type: NodeShape
target class: CampaignManagementFilterLinkAdExtension
property:
  path: status
  name: status
  description: The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Deleted
property:
  path: scheduling
  name: scheduling
  description: Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads. Add: Optional Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. To remove all scheduling set this element to an empty Schedule object.
  node: CampaignManagementScheduleShape
  class: CampaignManagementSchedule
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: devicePreference
  name: device preference
  description: Not supported for this ad extension type.
  datatype: long
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad extension. Add: Read-only Update: Read-only and Required
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad extension. This value is FilterLinkAdExtension when you retrieve a filter link ad extension. Add: Read-only Update: Read-only For more information about ad extension types, see the Ad Extension Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Tracks the number of times the ad extension has been updated. The version is set to 1 when the ad extension is created, and increments by one after each update. Add: Not allowed Update: Not allowed
  datatype: int
  max count: 1
property:
  path: adExtensionHeaderType
  name: ad extension header type
  description: The header that is appended with a colon (:) and precedes the filter link values in the ad that is shown. Filter link headers will be shown in the language that you specify. For example, if you want header Amenities in English you must set the Language to English and the AdExtensionHeaderType to Amenities. If you want header Ausstattung (Amenities in German) you must set the Language to German and the AdExtensionHeaderType to Amenities. Add: Required Update: Required
  datatype: string
  max count: 1
  in: Unknown
  in: Amenities
  in: Brands
  in: Classes
  in: Courses
  in: DailyRates
  in: DegreePrograms
  in: Departments
  in: Destinations
  in: FeaturedHotels
  in: Goods
  in: Grades
  in: Highlights
  in: InsuranceCoverage
  in: Items
  in: Languages
  in: Locations
  in: Models
  in: Neighborhoods
  in: Prices
  in: Rates
  in: Ratings
  in: SchoolDistricts
  in: Services
  in: ServiceCatalog
  in: Shows
  in: Sizes
  in: Styles
  in: Tools
  in: Topics
  in: Types
  in: Vacations
  in: Vehicles
  in: What
  in: Who
  in: Why
  in: Deals
  in: BestSellers
  in: AgeGroups
  in: Occasions
  in: Flowers
property:
  path: language
  name: language
  description: The language you want to use for the filter link headers. Filter link headers will be shown in the language that you specify. For example, if you want header Amenities in English you must set the Language to English and the AdExtensionHeaderType to Amenities. If you want header Ausstattung (Amenities in German) you must set the Language to German and the AdExtensionHeaderType to Amenities. Add: Required Update: Required
  datatype: string
  max count: 1
property:
  path: texts
  name: texts
  description: The text values that follow after the AdExtensionHeaderType component of the ad that is shown. Each text value that you choose can have a maximum length of 25 characters. Note that for Traditional Chinese characters, each value can have a maximum length of 12 characters. Add: Required Update: Required
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The landing page URL for mobile devices. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 list items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 list items for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty list, the previous setting will be deleted.
  datatype: string
property:
  path: finalUrls
  name: final urls
  description: The landing page URL. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 list items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 list items for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all FinalUrls and FinalMobileUrls. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 3 CustomParameter objects that you include within the CustomParameters object, and any additional custom parameters will be ignored. Each CustomParameter includes Key and Value elements. For customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635), Microsoft Advertising will accept the first 8 custom parameter key and value pairs that you include, and if you include more than 8 custom parameters an error will be returned. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. There are currently no forward compatibility changes for the AdExtension object. Add: Read-only Update: Read-only
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementFixedBidShape
type: NodeShape
target class: CampaignManagementFixedBid
property:
  path: type
  name: type
  description: The type of the criterion bid. This value is FixedBid when you retrieve a fixed bid criterion. For more information about criterion types, see the CriterionBid Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: amount
  name: amount
  description: The bid value. For details about the valid bid range for your market, see Currencies. Add: Required Update: Optional
  datatype: double
  max count: 1

CampaignManagementFlyerAdExtensionShape
type: NodeShape
target class: CampaignManagementFlyerAdExtension
property:
  path: status
  name: status
  description: The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
  in: Active
  in: Deleted
property:
  path: scheduling
  name: scheduling
  description: Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads. The EndDate must be within 30 days of the StartDate. Add: The schedule StartDate and EndDate are required for flyer ad extensions. Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. You cannot set this element to an empty Schedule object, because that would effectively attempt to delete all scheduling. This would result in an error since StartDate and EndDate are required for flyer ad extensions.
  node: CampaignManagementScheduleShape
  class: CampaignManagementSchedule
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: devicePreference
  name: device preference
  description: Not supported for this ad extension type.
  datatype: long
  max count: 1
property:
  path: id
  name: id
  description: The unique Microsoft Advertising identifier of the ad extension. Add: Read-only Update: Read-only and Required
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: The type of the ad extension. This value is FlyerAdExtension when you retrieve a flyer ad extension. Add: Read-only Update: Read-only For more information about ad extension types, see the Ad Extension Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Tracks the number of times the ad extension has been updated. The version is set to 1 when the ad extension is created, and increments by one after each update. Add: Not allowed Update: Not allowed
  datatype: int
  max count: 1
property:
  path: flyerName
  name: flyer name
  description: The flyer name. The maximum length for this element is 150 characters. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: storeId
  name: store id
  description: The unique identifier of a Microsoft Merchant Center store used for product ads. Add: Optional Update: Read-only. You cannot update the store ID after it was set.
  datatype: long
  max count: 1
property:
  path: description
  name: description
  description: Description that can be used by the advertiser, agency, or account manager to track, label, or manage flyer extensions. This description is not displayed with the ad or image. The maximum length for this element is 1,024 characters. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: imageMediaIds
  name: image media ids
  description: The identifier of the image to include in the ad. You can only set one media ID. The data type is a list of long values in case support for multiple images is added later. Each media ID corresponds to an Image of the "GenericImage" Media sub type. You can get the identifier of each Image when you add them to the image library by calling the AddMedia operation. Otherwise after the media has been added to your image library you can get the media identifiers with the GetMediaMetaDataByAccountId operation. The image should have a minimum width and height of 220px, and a maximum file size of 3.9MB. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: long
property:
  path: imageMediaUrls
  name: image media urls
  description: The URL of the media that you already added. Add: Read-only Update: Read-only
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The landing page URL for mobile devices. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 list items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 list items for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty list, the previous setting will be deleted.
  datatype: string
property:
  path: finalUrls
  name: final urls
  description: The landing page URL. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 list items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 list items for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. Add: Required Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
property:
  path: urlCustomParameters
  name: url custom parameters
  description: Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 3 CustomParameter objects that you include within the CustomParameters object, and any additional custom parameters will be ignored. Each CustomParameter includes Key and Value elements. For customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635), Microsoft Advertising will accept the first 8 custom parameter key and value pairs that you include, and if you include more than 8 custom parameters an error will be returned. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
  node: CampaignManagementCustomParametersShape
  class: CampaignManagementCustomParameters
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The tracking template to use as a default for all FinalUrls and FinalMobileUrls. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
  datatype: string
  max count: 1
property:
  path: finalAppUrls
  name: final app urls
  description: Reserved for future use.
  node: CampaignManagementAppUrlShape
  class: CampaignManagementAppUrl
  node kind: BlankNodeOrIRI
property:
  path: forwardCompatibilityMap
  name: forward compatibility map
  description: 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. There are currently no forward compatibility changes for the AdExtension object. Add: Read-only Update: Read-only
  node: CampaignManagementKeyValuePairOfstringAndstringShape
  class: CampaignManagementKeyValuePairOfstringAndstring
  node kind: BlankNodeOrIRI

CampaignManagementGenderCriterionShape
type: NodeShape
target class: CampaignManagementGenderCriterion
property:
  path: type
  name: type
  description: The type of the criterion. This value is Gender when you retrieve a gender criterion. For more information about criterion types, see the Criterion Data Object Remarks. Add: Read-only Update: Read-only
  datatype: string
  max count: 1
property:
  path: genderType
  name: gender type
  description: The gender of the people you want to see your ads. Add: Required Update: Not allowed. If you specify this element it must match the existing setting.
  datatype: string
  max count: 1
  in: Unknown
  in: Male
  in: Female

CampaignManagementGenderDimensionShape
type: NodeShape
target class: CampaignManagementGenderDimension
property:
  path: type
  name: type
  description: The type of audience dimensions, the following dimension types are supported as of now: Age, Gender, Audience. Add: For more information about audience types, see the Remarks. Update: For more information about audience types, see the Remarks.
  datatype: string
  max count: 1
  in: Age
  in: Gender
  in: Audience
  in: Profile
property:
  path: genderTypes
  name: gender types
  description: A list of gender types. Add: Required Update: Optional. To remove existing values, set it to null or empty. To remove a subset of gender types, specify the gender types that you want to keep and it will replace the existing gender types.
  datatype: string
  in: Unknown
  in: Male
  in: Female

CampaignManagementGenreCriterionShape
type: NodeShape
target class: CampaignManagementGenreCriterion
property:
  path: type
  name: type
  description: The type of the criterion. This value is Genre when you retrieve a genre criterion. For more information about criterion types, see the Criterion Data Object Remarks.
  datatype: string
  max count: 1
property:
  path: genreId
  name: genre id
  description: The Microsoft Advertising identifier of the Genre. View this table to see possible values for GenreId.
  datatype: long
  max count: 1

CampaignManagementGetAccountMigrationStatusesRequestShape
type: NodeShape
target class: CampaignManagementGetAccountMigrationStatusesRequest
property:
  path: accountIds
  name: account ids
  description: The identifiers of each account to request migration status.
  datatype: long
property:
  path: migrationType
  name: migration type
  description: Filters the returned migration status by migration type. Currently there are no applicable migrations in progress and this element is reserved for future use.
  datatype: string
  max count: 1

CampaignManagementGetAccountMigrationStatusesResponseShape
type: NodeShape
target class: CampaignManagementGetAccountMigrationStatusesResponse
property:
  path: migrationStatuses
  name: migration statuses
  description: An array of account migration statuses. For each account identifier specified in the request, an AccountMigrationStatusesInfo object is returned.
  node: CampaignManagementAccountMigrationStatusesInfoShape
  class: CampaignManagementAccountMigrationStatusesInfo
  node kind: BlankNodeOrIRI

CampaignManagementGetAccountPropertiesRequestShape
type: NodeShape
target class: CampaignManagementGetAccountPropertiesRequest
property:
  path: accountPropertyNames
  name: account property names
  description: The names of account properties that you want to get. For example, determine whether or not Microsoft Click Id auto-tagging is enabled, include the MSCLKIDAutoTaggingEnabled value in your request.
  datatype: string
  in: None
  in: TrackingUrlTemplate
  in: MSCLKIDAutoTaggingEnabled
  in: AdClickParallelTracking
  in: FinalUrlSuffix
  in: IncludeViewThroughConversions
  in: ProfileExpansionEnabled
  in: AllowImageAutoRetrieve
  in: AutoApplyRecommendations
  in: IncludeAutoBiddingViewThroughConversions
  in: AutoBiddingViewThroughConversionsValueAttributionWeight
  in: LoopBackWindowForViewThroughConversions
  in: BusinessAttributes
  in: EnableMMAUnderDSAAdgroups
  in: OptOutFromMCM
  in: NetflixTCAccepted
  in: BlockedContentSegments
  in: AssetAIEnhancementOptout
  in: AcceptNielsenTermsAndConditions
  in: ImageMissingWarningOptout
  in: OptOutFromSystemSourcedImagesInSWF

CampaignManagementGetAccountPropertiesResponseShape
type: NodeShape
target class: CampaignManagementGetAccountPropertiesResponse
property:
  path: accountProperties
  name: account properties
  description: An array of account properties. For each account property name specified in the request, an AccountProperty object is returned.
  node: CampaignManagementAccountPropertyShape
  class: CampaignManagementAccountProperty
  node kind: BlankNodeOrIRI
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementGetAdExtensionIdsByAccountIdRequestShape
type: NodeShape
target class: CampaignManagementGetAdExtensionIdsByAccountIdRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account that contains the ad extensions to get.
  datatype: long
  max count: 1
property:
  path: associationType
  name: association type
  description: A value that filters the extensions based on whether they?re associated with a specific entity type. For possible values, see AssociationType. To get all extensions including those not associated with any entity, set this element to NULL.
  datatype: string
  max count: 1
  in: Campaign
  in: AdGroup
  in: Account
property:
  path: adExtensionType
  name: ad extension type
  description: The types of ad extensions to get from the account. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, LocationAdExtension CallAdExtension.
  datatype: string
  max count: 1

CampaignManagementGetAdExtensionIdsByAccountIdResponseShape
type: NodeShape
target class: CampaignManagementGetAdExtensionIdsByAccountIdResponse
property:
  path: adExtensionIds
  name: ad extension ids
  description: A list of ad extension IDs. To get the extension, call the GetAdExtensionsByIds operation.
  datatype: long

CampaignManagementGetAdExtensionsAssociationsRequestShape
type: NodeShape
target class: CampaignManagementGetAdExtensionsAssociationsRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account that owns the extensions.
  datatype: long
  max count: 1
property:
  path: entityIds
  name: entity ids
  description: The list of entity identifiers by which you may request the respective ad extension associations. The maximum number of EntityIds per request is 100.
  datatype: long
property:
  path: adExtensionType
  name: ad extension type
  description: Filters the returned associations by ad extension type. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, LocationAdExtension CallAdExtension.
  datatype: string
  max count: 1
property:
  path: associationType
  name: association type
  description: Filters the returned associations by entity type.
  datatype: string
  max count: 1
  in: Campaign
  in: AdGroup
  in: Account
property:
  path: returnAdditionalFields
  name: return additional fields
  description: Reserved for future use.
  datatype: string
  max count: 1

CampaignManagementGetAdExtensionsAssociationsResponseShape
type: NodeShape
target class: CampaignManagementGetAdExtensionsAssociationsResponse
property:
  path: adExtensionAssociationCollection
  name: ad extension association collection
  description: An array of ad extension association collections. For each entity identifier specified in the request, an AdExtensionAssociationCollection is returned.
  class: CampaignManagementAdExtensionAssociationCollection
  node kind: BlankNodeOrIRI
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any associations that were not successfully retrieved. The list of errors corresponds directly to the list of associations in the request. Items of the list may be returned as null. For each list index where an association was successfully retrieved, the corresponding error element will be null. Ideally all associations are retrieved successfully and all elements in this list are null.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementGetAdExtensionsByIdsRequestShape
type: NodeShape
target class: CampaignManagementGetAdExtensionsByIdsRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account that owns the ad extensions.
  datatype: long
  max count: 1
property:
  path: adExtensionIds
  name: ad extension ids
  description: A list of ad extension identifiers. You can specify a maximum of 100 identifiers.
  datatype: long
property:
  path: adExtensionType
  name: ad extension type
  description: The types of ad extensions that the list of identifiers contains. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, LocationAdExtension CallAdExtension.
  datatype: string
  max count: 1
property:
  path: returnAdditionalFields
  name: return additional fields
  description: Reserved for future use.
  datatype: string
  max count: 1

CampaignManagementGetAdExtensionsByIdsResponseShape
type: NodeShape
target class: CampaignManagementGetAdExtensionsByIdsResponse
property:
  path: adExtensions
  name: ad extensions
  description: A list of AdExtension objects. The list corresponds directly to the list of identifiers in the request. If an ad extension ID in the request is not valid or the extension is not of the type specified, the corresponding item in this list is null.
  or:
    node: CampaignManagementActionAdExtensionShape
    class: CampaignManagementActionAdExtension
  or:
    node: CampaignManagementAdExtensionShape
    class: CampaignManagementAdExtension
  or:
    node: CampaignManagementAdExtensionBaseShape
    class: CampaignManagementAdExtensionBase
  or:
    node: CampaignManagementAppAdExtensionShape
    class: CampaignManagementAppAdExtension
  or:
    node: CampaignManagementCallAdExtensionShape
    class: CampaignManagementCallAdExtension
  or:
    node: CampaignManagementCalloutAdExtensionShape
    class: CampaignManagementCalloutAdExtension
  or:
    node: CampaignManagementDataTableAdExtensionShape
    class: CampaignManagementDataTableAdExtension
  or:
    node: CampaignManagementDisclaimerAdExtensionShape
    class: CampaignManagementDisclaimerAdExtension
  or:
    node: CampaignManagementFilterLinkAdExtensionShape
    class: CampaignManagementFilterLinkAdExtension
  or:
    node: CampaignManagementFlyerAdExtensionShape
    class: CampaignManagementFlyerAdExtension
  or:
    node: CampaignManagementImageAdExtensionShape
    class: CampaignManagementImageAdExtension
  or:
    node: CampaignManagementLeadFormAdExtensionShape
    class: CampaignManagementLeadFormAdExtension
  or:
    node: CampaignManagementLocationAdExtensionShape
    class: CampaignManagementLocationAdExtension
  or:
    node: CampaignManagementLogoAdExtensionShape
    class: CampaignManagementLogoAdExtension
  or:
    node: CampaignManagementNewsAdExtensionShape
    class: CampaignManagementNewsAdExtension
  or:
    node: CampaignManagementPriceAdExtensionShape
    class: CampaignManagementPriceAdExtension
  or:
    node: CampaignManagementPromotionAdExtensionShape
    class: CampaignManagementPromotionAdExtension
  or:
    node: CampaignManagementReviewAdExtensionShape
    class: CampaignManagementReviewAdExtension
  or:
    node: CampaignManagementSitelinkAdExtensionShape
    class: CampaignManagementSitelinkAdExtension
  or:
    node: CampaignManagementStructuredSnippetAdExtensionShape
    class: CampaignManagementStructuredSnippetAdExtension
  or:
    node: CampaignManagementVideoAdExtensionShape
    class: CampaignManagementVideoAdExtension
  node kind: BlankNodeOrIRI
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementGetAdExtensionsEditorialReasonsRequestShape
type: NodeShape
target class: CampaignManagementGetAdExtensionsEditorialReasonsRequest
property:
  path: accountId
  name: account id
  description: The identifier of the account that owns the extensions.
  datatype: long
  max count: 1
property:
  path: adExtensionIdToEntityIdAssociations
  name: ad extension id to entity id associations
  description: The list of ad extensions and corresponding entity associations to get.
  node: CampaignManagementAdExtensionIdToEntityIdAssociationShape
  class: CampaignManagementAdExtensionIdToEntityIdAssociation
  node kind: BlankNodeOrIRI
property:
  path: associationType
  name: association type
  description: Filters the returned associations by entity type.
  datatype: string
  max count: 1
  in: Campaign
  in: AdGroup
  in: Account

CampaignManagementGetAdExtensionsEditorialReasonsResponseShape
type: NodeShape
target class: CampaignManagementGetAdExtensionsEditorialReasonsResponse
property:
  path: editorialReasons
  name: editorial reasons
  description: The collection of ad extension editorial reasons.
  node: CampaignManagementAdExtensionEditorialReasonCollectionShape
  class: CampaignManagementAdExtensionEditorialReasonCollection
  node kind: BlankNodeOrIRI
property:
  path: partialErrors
  name: partial errors
  description: An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementGetAdGroupCriterionsByIdsRequestShape
type: NodeShape
target class: CampaignManagementGetAdGroupCriterionsByIdsRequest
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group that owns the criterions to get.
  datatype: long
  max count: 1
property:
  path: returnAdditionalFields
  name: return additional fields
  description: The list of additional properties that you want included within each returned ad group criterion. The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional.
  datatype: string
  max count: 1
property:
  path: criterionType
  name: criterion type
  description: The type of criterion to get, for example Webpage. You can specify only one type. The Targets and Audience values are not allowed for this operation.
  datatype: string
  max count: 1
property:
  path: adGroupCriterionIds
  name: ad group criterion ids
  description: A list of unique identifiers that identify the criterions to get. You can include up to 1,000 ad group criterion identifiers per request. If this element is null, all criterions for the specified AdGroupId will be retrieved.
  datatype: long

CampaignManagementGetAdGroupCriterionsByIdsResponseShape
type: NodeShape
target class: CampaignManagementGetAdGroupCriterionsByIdsResponse
property:
  path: adGroupCriterions
  name: ad group criterions
  description: The list of criterions that correspond directly to the identifiers specified in the request. If an identifier in the list is not valid, the corresponding item in the response is set to null.
  or:
    node: CampaignManagementAdGroupCriterionShape
    class: CampaignManagementAdGroupCriterion
  or:
    node: CampaignManagementAdGroupCriterionBaseShape
    class: CampaignManagementAdGroupCriterionBase
  or:
    node: CampaignManagementBiddableAdGroupCriterionShape
    class: CampaignManagementBiddableAdGroupCriterion
  or:
    node: CampaignManagementNegativeAdGroupCriterionShape
    class: CampaignManagementNegativeAdGroupCriterion
  node kind: BlankNodeOrIRI

CampaignManagementGetAdGroupsByCampaignIdRequestShape
type: NodeShape
target class: CampaignManagementGetAdGroupsByCampaignIdRequest
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign that contains the ad groups to get.
  datatype: long
  max count: 1
property:
  path: returnAdditionalFields
  name: return additional fields
  description: The list of additional properties that you want included within each returned ad group. The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional.
  datatype: string
  max count: 1

CampaignManagementGetAdGroupsByCampaignIdResponseShape
type: NodeShape
target class: CampaignManagementGetAdGroupsByCampaignIdResponse
property:
  path: adGroups
  name: ad groups
  description: The list of ad groups within the specified campaign. If the campaign contains no ad groups, an empty array is returned.
  node: CampaignManagementAdGroupShape
  class: CampaignManagementAdGroup
  node kind: BlankNodeOrIRI

CampaignManagementGetAdGroupsByIdsRequestShape
type: NodeShape
target class: CampaignManagementGetAdGroupsByIdsRequest
property:
  path: campaignId
  name: campaign id
  description: The identifier of the campaign that contains the ad groups to get.
  datatype: long
  max count: 1
property:
  path: adGroupIds
  name: ad group ids
  description: A maximum of 1,000 identifiers of the ad groups to get.
  datatype: long
property:
  path: returnAdditionalFields
  name: return additional fields
  description: The list of additional properties that you want included within each returned ad group. The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional.
  datatype: string
  max count: 1

CampaignManagementGetAdGroupsByIdsResponseShape
type: NodeShape
target class: CampaignManagementGetAdGroupsByIdsResponse
property:
  path: adGroups
  name: ad groups
  description: The list of ad groups that correspond directly to the ad group identifiers that you specified in the request. Items of the list may be returned as null. For each list index where an ad group was not retrieved, the corresponding element will be null.
  node: CampaignManagementAdGroupShape
  class: CampaignManagementAdGroup
  node kind: BlankNodeOrIRI
property:
  path: partialErrors
  name: partial errors
  description: The list of batch errors that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
  or:
    node: CampaignManagementBatchErrorShape
    class: CampaignManagementBatchError
  or:
    node: CampaignManagementBatchErrorBaseShape
    class: CampaignManagementBatchErrorBase
  or:
    node: CampaignManagementEditorialErrorShape
    class: CampaignManagementEditorialError
  node kind: BlankNodeOrIRI

CampaignManagementGetAdsByAdGroupIdRequestShape
type: NodeShape
target class: CampaignManagementGetAdsByAdGroupIdRequest
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group to retrieve the ads from.
  datatype: long
  max count: 1
property:
  path: adTypes
  name: ad types
  description: One or more ad types to retrieve.
  datatype: string
  in: Text
  in: Image
  in: Product
  in: AppInstall
  in: ExpandedText
  in: DynamicSearch
  in: ResponsiveAd
  in: ResponsiveSearch
  in: Hotel
property:
  path: returnAdditionalFields
  name: return additional fields
  description: The list of additional properties that you want included within each returned ad. The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional.
  datatype: string
  max count: 1

CampaignManagementGetAdsByAdGroupIdResponseShape
type: NodeShape
target class: CampaignManagementGetAdsByAdGroupIdResponse
property:
  path: ads
  name: ads
  description: The list of ads that have been retrieved. If the ad group doesn't contain ads, this array is empty.
  or:
    node: CampaignManagementAdShape
    class: CampaignManagementAd
  or:
    node: CampaignManagementAdBaseShape
    class: CampaignManagementAdBase
  or:
    node: CampaignManagementAppInstallAdShape
    class: CampaignManagementAppInstallAd
  or:
    node: CampaignManagementDynamicSearchAdShape
    class: CampaignManagementDynamicSearchAd
  or:
    node: CampaignManagementExpandedTextAdShape
    class: CampaignManagementExpandedTextAd
  or:
    node: CampaignManagementHotelAdShape
    class: CampaignManagementHotelAd
  or:
    node: CampaignManagementProductAdShape
    class: CampaignManagementProductAd
  or:
    node: CampaignManagementResponsiveAdShape
    class: CampaignManagementResponsiveAd
  or:
    node: CampaignManagementResponsiveSearchAdShape
    class: CampaignManagementResponsiveSearchAd
  or:
    node: CampaignManagementTextAdShape
    class: CampaignManagementTextAd
  node kind: BlankNodeOrIRI

CampaignManagementGetAdsByEditorialStatusRequestShape
type: NodeShape
target class: CampaignManagementGetAdsByEditorialStatusRequest
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group to retrieve the ads from.
  datatype: long
  max count: 1
property:
  path: editorialStatus
  name: editorial status
  description: The editorial review status that the ads must have to be returned.
  datatype: string
  max count: 1
  in: Active
  in: Disapproved
  in: Inactive
  in: ActiveLimited
property:
  path: adTypes
  name: ad types
  description: One or more types of ads to return.
  datatype: string
  in: Text
  in: Image
  in: Product
  in: AppInstall
  in: ExpandedText
  in: DynamicSearch
  in: ResponsiveAd
  in: ResponsiveSearch
  in: Hotel
property:
  path: returnAdditionalFields
  name: return additional fields
  description: The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional.
  datatype: string
  max count: 1

CampaignManagementGetAdsByEditorialStatusResponseShape
type: NodeShape
target class: CampaignManagementGetAdsByEditorialStatusResponse
property:
  path: ads
  name: ads
  description: The list of ads that have been retrieved. If the ad group doesn't contain ads that meet the criteria, this array is empty.
  or:
    node: CampaignManagementAdShape
    class: CampaignManagementAd
  or:
    node: CampaignManagementAdBaseShape
    class: CampaignManagementAdBase
  or:
    node: CampaignManagementAppInstallAdShape
    class: CampaignManagementAppInstallAd
  or:
    node: CampaignManagementDynamicSearchAdShape
    class: CampaignManagementDynamicSearchAd
  or:
    node: CampaignManagementExpandedTextAdShape
    class: CampaignManagementExpandedTextAd
  or:
    node: CampaignManagementHotelAdShape
    class: CampaignManagementHotelAd
  or:
    node: CampaignManagementProductAdShape
    class: CampaignManagementProductAd
  or:
    node: CampaignManagementResponsiveAdShape
    class: CampaignManagementResponsiveAd
  or:
    node: CampaignManagementResponsiveSearchAdShape
    class: CampaignManagementResponsiveSearchAd
  or:
    node: CampaignManagementTextAdShape
    class: CampaignManagementTextAd
  node kind: BlankNodeOrIRI

CampaignManagementGetAdsByIdsRequestShape
type: NodeShape
target class: CampaignManagementGetAdsByIdsRequest
property:
  path: adGroupId
  name: ad group id
  description: The identifier of the ad group that contains the ads to get.
  datatype: long
  max count: 1
property:
  path: adIds
  name: ad ids
  description: A maximum of 20 identifiers of the requested ads. If the ad identifiers do not match the requested ad types, then the operation will return a batch error for each requested ad.
  datatype: long
property:
  path: adTypes
  name: ad types
  description: One or more types of ads to return.
  datatype: string
  in: Text
  in: Image
  in: Product
  in: AppInstall
  in: ExpandedText
  in: DynamicSearch
  in: ResponsiveAd
  in: ResponsiveSearch
  in: Hotel
property:
  path: returnAdditionalFields
  name: return additional fields
  description: The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional.
  datatype: string
  max count: 1

CampaignManagementGetAdsByIdsResponseShape
type: NodeShape
target class: CampaignManagementGetAdsByIdsResponse
property:
  path: ads
  name: ads
  description: An array of Ad objects that corresponds directly to the ad identifiers that you specified in the request. Items of the list may be returned as null. For each list index where an ad was not retrieved, the corresponding element will be null.
  or:
    node: CampaignManagementAdShape
    class: CampaignManagementAd
  or:
    node: CampaignManagementAdBaseShape
    class: CampaignManagementAdBase
  node kind: BlankNodeOrIRI

path: autoTargeting
name: auto targeting
description: Use predictive targeting if the value is true.
datatype: boolean
max count: 1

path: callToActionLanguage
name: call to action language
datatype: string
max count: 1
in: None
in: Albanian
in: Arabic
in: Bulgarian
in: TraditionalChinese
in: Croatian
in: Czech
in: Danish
in: Dutch
in: English
in: Estonian
in: Finnish
in: French
in: German
in: Greek
in: Hebrew
in: Hindi
in: Hungarian
in: Icelandic
in: Indonesian
in: Italian
in: Japanese
in: Korean
in: Latvian
in: Lithuanian
in: Macedonian
in: Malay
in: Maltese
in: Norwegian
in: Polish
in: Portuguese
in: Romanian
in: Russian
in: Serbian
in: Slovak
in: Slovenian
in: Spanish
in: Swedish
in: Tagalog
in: Thai
in: Turkish
in: Vietnamese
in: SimplifiedChinese
in: Bosnian
in: All

path: images
name: images
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI

path: videos
name: videos
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI

path: headlines
name: headlines
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI

path: longHeadline
name: long headline
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI
max count: 1

path: longHeadlines
name: long headlines
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI

path: descriptions
name: descriptions
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI

path: impressionTrackingUrls
name: impression tracking urls
datatype: string

path: verifiedTrackingSettings
name: verified tracking settings
node: CampaignManagementVerifiedTrackingSettingShape
class: CampaignManagementVerifiedTrackingSetting
node kind: BlankNodeOrIRI
max count: 1

path: adSubType
name: ad sub type
datatype: string
max count: 1

path: isExact
name: is exact
datatype: boolean
max count: 1

path: text
name: text
datatype: string
max count: 1

path: source
name: source
datatype: string
max count: 1

path: url
name: url
datatype: string
max count: 1

path: nameUrl
name: name url
datatype: string
max count: 1

path: description1
name: description1
datatype: string
max count: 1

path: description2
name: description2
datatype: string
max count: 1

path: actionType
name: action type
datatype: string
max count: 1
in: Unknown
in: ActNow
in: ApplyNow
in: BetNow
in: BidNow
in: BookACar
in: BookHotel
in: BookNow
in: Browse
in: BuyNow
in: ChatNow
in: Compare
in: ContactUs
in: Coupon
in: Donate
in: Download
in: EmailNow
in: EnrollNow
in: Explore
in: FileNow
in: FindJob
in: FreePlay
in: FreeQuote
in: FreeTrial
in: GetDeals
in: GetOffer
in: GetQuote
in: JoinNow
in: LearnMore
in: ListenNow
in: LogIn
in: Message
in: NewCars
in: OrderNow
in: PlayGame
in: PlayNow
in: PostJob
in: Register
in: RentACar
in: RentNow
in: Reserve
in: Sale
in: SaveNow
in: Schedule
in: SeeMenu
in: SeeMore
in: SeeOffer
in: SellNow
in: ShopNow
in: Showtimes
in: SignIn
in: SignUp
in: StartFree
in: StartNow
in: Subscribe
in: TestDrive
in: TryNow
in: UsedCars
in: ViewCars
in: ViewNow
in: ViewPlans
in: VisitSite
in: VoteNow
in: Watch
in: WatchMore
in: WatchNow
in: Directions
in: FindStore
in: SwitchNow
in: VisitStore
in: RenewNow
in: Reorder
in: BuildNow
in: Dealers
in: GetDemo
in: GetNow

path: language
name: language
datatype: string
max count: 1

path: header
name: header
datatype: string
max count: 1

path: values
name: values
datatype: string

path: priceExtensionType
name: price extension type
datatype: string
max count: 1
in: Unknown
in: Brands
in: Events
in: Locations
in: Neighborhoods
in: ProductCategories
in: ProductTiers
in: Services
in: ServiceCategories
in: ServiceTiers

path: tableRows
name: table rows
node: CampaignManagementPriceTableRowShape
class: CampaignManagementPriceTableRow
node kind: BlankNodeOrIRI

path: promotionItem
name: promotion item
datatype: string
max count: 1

path: discountModifier
name: discount modifier
datatype: string
max count: 1
in: Unknown
in: UpTo
in: None

path: percentOff
name: percent off
datatype: double
max count: 1

path: moneyAmountOff
name: money amount off
datatype: double
max count: 1

path: promotionCode
name: promotion code
datatype: string
max count: 1

path: ordersOverAmount
name: orders over amount
datatype: double
max count: 1

path: promotionStartDate
name: promotion start date
node: CampaignManagementDateShape
class: CampaignManagementDate
node kind: BlankNodeOrIRI
max count: 1

path: promotionEndDate
name: promotion end date
node: CampaignManagementDateShape
class: CampaignManagementDate
node kind: BlankNodeOrIRI
max count: 1

path: promotionOccasion
name: promotion occasion
datatype: string
max count: 1
in: Unknown
in: NewYears
in: ValentinesDay
in: Easter
in: MothersDay
in: FathersDay
in: LaborDay
in: BackToSchool
in: Halloween
in: BlackFriday
in: CyberMonday
in: Christmas
in: BoxingDay
in: None
in: IndependenceDay
in: NationalDay
in: EndOfSeason
in: WinterSale
in: SummerSale
in: FallSale
in: SpringSale
in: Ramadan
in: EidAlFitr
in: EidAlAdha
in: SinglesDay
in: WomensDay
in: Holi
in: ParentsDay
in: StNicholasDay
in: ChineseNewYear
in: Carnival
in: Epiphany
in: RoshHashanah
in: Passover
in: Hanukkah
in: Diwali
in: Navratri
in: Songkran
in: YearEndGift

path: currencyCode
name: currency code
datatype: string
max count: 1

path: adExtensionHeaderType
name: ad extension header type
datatype: string
max count: 1
in: Unknown
in: Amenities
in: Brands
in: Classes
in: Courses
in: DailyRates
in: DegreePrograms
in: Departments
in: Destinations
in: FeaturedHotels
in: Goods
in: Grades
in: Highlights
in: InsuranceCoverage
in: Items
in: Languages
in: Locations
in: Models
in: Neighborhoods
in: Prices
in: Rates
in: Ratings
in: SchoolDistricts
in: Services
in: ServiceCatalog
in: Shows
in: Sizes
in: Styles
in: Tools
in: Topics
in: Types
in: Vacations
in: Vehicles
in: What
in: Who
in: Why
in: Deals
in: BestSellers
in: AgeGroups
in: Occasions
in: Flowers

path: texts
name: texts
datatype: string

path: flyerName
name: flyer name
datatype: string
max count: 1

path: storeId
name: store id
datatype: long
max count: 1

path: imageMediaUrls
name: image media urls
datatype: string

path: actionText
name: action text
datatype: string
max count: 1

path: videoId
name: video id
datatype: long
max count: 1

path: thumbnailId
name: thumbnail id
datatype: long
max count: 1

path: thumbnailUrl
name: thumbnail url
datatype: string
max count: 1

path: title
name: title
datatype: string
max count: 1

path: popupText
name: popup text
datatype: string
max count: 1

path: lineText
name: line text
datatype: string
max count: 1

path: disclaimerLayout
name: disclaimer layout
datatype: string
max count: 1

path: businessName
name: business name
datatype: string
max count: 1

path: businessLogo
name: business logo
datatype: long
max count: 1

path: businessLogoUrl
name: business logo url
datatype: string
max count: 1

path: domainName
name: domain name
datatype: string
max count: 1

path: callToAction
name: call to action
datatype: string
max count: 1
in: Unknown
in: CustomText
in: ApplyNow
in: BookNow
in: ContactUs
in: Download
in: GetOffer
in: GetQuote
in: LearnMore
in: SignUp
in: Subscribe

path: actionName
name: action name
datatype: string
max count: 1

path: actionDescription
name: action description
datatype: string
max count: 1

path: corporateImage
name: corporate image
node: CampaignManagementImageAssetShape
class: CampaignManagementImageAsset
node kind: BlankNodeOrIRI
max count: 1

path: corporateImageInternalUrl
name: corporate image internal url
datatype: string
max count: 1

path: formHeadline
name: form headline
datatype: string
max count: 1

path: formBusinessName
name: form business name
datatype: string
max count: 1

path: formDescription
name: form description
datatype: string
max count: 1

path: formPolicyUrl
name: form policy url
datatype: string
max count: 1

path: formQuestions
name: form questions
node: CampaignManagementLeadFormQuestionDefinitionShape
class: CampaignManagementLeadFormQuestionDefinition
node kind: BlankNodeOrIRI

path: confirmationMessage
name: confirmation message
datatype: string
max count: 1

path: confirmationDescription
name: confirmation description
datatype: string
max count: 1

path: confirmationAction
name: confirmation action
datatype: string
max count: 1
in: Unknown
in: None
in: VisitWebsite
in: DownloadFile

path: confirmationUrl
name: confirmation url
datatype: string
max count: 1

path: leadDelivery
name: lead delivery
datatype: string
max count: 1
in: Unknown
in: CSV
in: Email
in: Webhook

path: leadEmails
name: lead emails
datatype: string
max count: 1

path: leadWebhookUrl
name: lead webhook url
datatype: string
max count: 1

path: leadWebhookKey
name: lead webhook key
datatype: string
max count: 1

path: locationId
name: location id
datatype: long
max count: 1

path: locationType
name: location type
datatype: string
max count: 1

path: displayName
name: display name
datatype: string
max count: 1

path: enclosedLocationIds
name: enclosed location ids
datatype: long

path: intentOption
name: intent option
datatype: string
max count: 1
in: PeopleInOrSearchingForOrViewingPages
in: PeopleIn
in: PeopleSearchingForOrViewingPages

path: audienceId
name: audience id
datatype: long
max count: 1

path: audienceType
name: audience type
datatype: string
max count: 1

path: profileId
name: profile id
datatype: long
max count: 1

path: profileType
name: profile type
datatype: string
max count: 1

path: profile
name: profile
datatype: string
max count: 1

path: storeId
name: store id
datatype: long
max count: 1

path: dealId
name: deal id
datatype: long
max count: 1

path: genreId
name: genre id
datatype: long
max count: 1

path: placementId
name: placement id
datatype: long
max count: 1

path: placementName
name: placement name
datatype: string
max count: 1

path: topicId
name: topic id
datatype: long
max count: 1

path: topicName
name: topic name
datatype: string
max count: 1

path: channelPlacementId
name: channel placement id
datatype: long
max count: 1

path: channelPlacementName
name: channel placement name
datatype: string
max count: 1

path: channelId
name: channel id
datatype: int
max count: 1

path: channelName
name: channel name
datatype: string
max count: 1

path: subChannelId
name: sub channel id
datatype: int
max count: 1

path: subChannelName
name: sub channel name
datatype: string
max count: 1

path: adScheduleUseSearcherTimeZone
name: ad schedule use searcher time zone
description: Determines whether to use the account time zone or the time zone of the search user where the ads could be delivered. Set this property to true if you want the ads to be shown in the search user's time zone, and otherwise set it to false. This element is not returned by default. To get this element, include the AdScheduleUseSearcherTimeZone value in the ReturnAdditionalFields element when you call the GetAdGroupsByCampaignId and GetAdGroupsByIds service operations. Add: Optional. If you do not specify this element or leave it empty, the default value of true will be set and the search user's time zone will be used. After September 30, 2020, if you do not specify this field or leave it empty, the default value of false is set and the account time zone is used. Update: Optional. If no value is set for the update, this setting is not changed.
datatype: boolean
max count: 1

path: adGroupType
name: ad group type
description: The ad group type. In a mixed campaign where the CampaignType is "Search", the ExperimentId is not set, and the Settings already have a valid DynamicSearchAdsSetting, the possible values are "SearchDynamic" and "SearchStandard". Otherwise the type of ad groups within "Search" campaigns can only be set to "SearchStandard". If the ad group type is "SearchDynamic", then you can only add dynamic search ads within this ad group. If the ad group type is "SearchStandard", then you can add expanded text ads or responsive search ads within this ad group. The type of ad groups within "DynamicSearchAds" campaigns can only be set to "SearchDynamic". You don't need to set the ad group type for "DynamicSearchAds" campaigns, but please note when you retrieve ad groups this element will be set to "SearchDynamic". This field can be set to HotelAds for "Hotel" or "Search" campaign types. This element cannot be set for "Audience" or "Shopping" campaign types. When you retrieve an ad group within unsupported campaigns, this element will not be set. Add: Optional. The default value for "Search" campaigns is "SearchStandard". The default value for "DynamicSearchAds" campaigns is "SearchDynamic". Update: Read-only. You cannot update the ad group type.
datatype: string
max count: 1

path: cpvBid
name: cpv bid
description: The manual CPV bid strategy type. With the ManualCpv (manual cost per view) bid strategy, you set the highest amount that you'd like to pay per view or per click on a video ad, and Microsoft Advertising uses these bids every time. This element is not returned by default. To get this element, include the Cpv value in the ReturnAdditionalFields element when you call the GetAdGroupsByCampaignId and GetAdGroupsByIds service operations.
node: CampaignManagementBidShape
class: CampaignManagementBid
node kind: BlankNodeOrIRI
max count: 1

path: cpmBid
name: cpm bid
description: The manual CPM bid strategy type. With the ManualCpm (manual cost per thousand) bid strategy, you set the highest amount that you'd like to pay per thousand impressions, and Microsoft Advertising uses these bids every time. This element is not returned by default. To get this element, include the CpmBid value in the ReturnAdditionalFields element when you call the GetAdGroupsByCampaignId and GetAdGroupsByIds service operations.
node: CampaignManagementBidShape
class: CampaignManagementBid
node kind: BlankNodeOrIRI
max count: 1

path: mcpaBid
name: mcpa bid
description: The manual CPA bid strategy type. With the ManualCpa (manual cost per action) bid strategy, you set your big per advertiser-specified action.
node: CampaignManagementBidShape
class: CampaignManagementBid
node kind: BlankNodeOrIRI
max count: 1

path: multimediaAdsBidAdjustment
name: multimedia ads bid adjustment
description: The percent amount by which to adjust your bid for multimedia ads above or below the base ad group or keyword bid.
datatype: int
max count: 1

path: commissionRate
name: commission rate
description: The commission rate charged to the advertiser when someone books a hotel and stays there.
node: CampaignManagementRateBidShape
class: CampaignManagementRateBid
node kind: BlankNodeOrIRI
max count: 1

path: percentCpcBid
name: percent cpc bid
description: The percent CPC bid strategy type (total hotel price per night, including taxes and fees).
node: CampaignManagementRateBidShape
class: CampaignManagementRateBid
node kind: BlankNodeOrIRI
max count: 1

path: useOptimizedTargeting
name: use optimized targeting
description: This will be deprecated. Use UsePredictiveTargeting instead.
datatype: boolean
max count: 1

path: usePredictiveTargeting
name: use predictive targeting
description: Indicates if predictive targeting is enabled for an AdGroup. Note: UsePredictiveTargeting is only available for Audience campaigns. Add: Optional Update: Optional.
datatype: boolean
max count: 1

path: frequencyCapSettings
name: frequency cap settings
description: Settings for the frequency cap.
node: CampaignManagementFrequencyCapSettingsShape
class: CampaignManagementFrequencyCapSettings
node kind: BlankNodeOrIRI

path: forwardCompatibilityMap
name: forward compatibility map
description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
node: CampaignManagementKeyValuePairOfstringAndstringShape
class: CampaignManagementKeyValuePairOfstringAndstring
node kind: BlankNodeOrIRI

path: networkOption
name: network option
datatype: string
max count: 1
in: OwnedAndOperatedAndSyndicatedSearch
in: OwnedAndOperatedOnly
in: SyndicatedSearchOnly
in: InHousePromotion

path: impressionTrackingUrl
name: impression tracking url
datatype: string
max count: 1

path: optimizationGoal
name: optimization goal
datatype: string
max count: 1
in: Unspecified
in: MaxImpressions
in: MaxUniqueReach

path: timeGranularity
name: time granularity
datatype: string
max count: 1
in: HOUR
in: DAY
in: WEEK

path: capValue
name: cap value
datatype: int
max count: 1

path: channelOptimizationOptOut
name: channel optimization opt out
datatype: boolean
max count: 1

path: audienceOptimizationOptOut
name: audience optimization opt out
datatype: boolean
max count: 1

path: editorialStatus
name: editorial status
description: The editorial review status of the asset group, which indicates whether the asset group is pending review, has been approved, or has been disapproved. Add: Read-only Update: Read-only
datatype: string
max count: 1
in: Active
in: Disapproved
in: Inactive
in: ActiveLimited

path: assetGroupUrlTargets
name: asset group url targets
description: Reserved.
node: CampaignManagementAssetGroupUrlTargetShape
class: CampaignManagementAssetGroupUrlTarget
node kind: BlankNodeOrIRI

path: id
name: id
description: The system generated asset group ID. Add: Read-only Update: Read-only
datatype: long
max count: 1

path: forwardCompatibilityMap
name: forward compatibility map
description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
node: CampaignManagementKeyValuePairOfstringAndstringShape
class: CampaignManagementKeyValuePairOfstringAndstring
node kind: BlankNodeOrIRI

path: budgetId
name: budget id
description: The unique Microsoft Advertising identifier of the Budget that this campaign shares with other campaigns in the account. If the value is not null and greater than zero, then the campaign is using a shared budget. If the value is null, then the campaign is not using a shared budget. If the campaign is using a shared budget, and you prefer that it use its own budget e.g. DailyBudget amount, set this element to '0' (zero) and set DailyBudget to a valid budget amount. Note: Shared budgets are not supported with smart shopping campaigns or Performance Max campaigns. With smart shopping campaigns, you must set the DailyBudget amount. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
datatype: long
max count: 1

path: languages
name: languages
description: Your ad language setting determines the language you will use when you write your ads and should be the language of your customers. IMPORTANT: If languages are set at both the ad group and campaign level, the ad group level language will override the campaign level language. You can specify multiple languages individually in the list, or only include one list item set to All if you want to target all languages. The supported language strings for Search and Shopping campaigns are: Albanian, Bulgarian, Croatian, Czech, Danish, Dutch, English, Estonian, Finnish, French, German, Greek, Hungarian, Italian, Japanese, Latvian, Lithuanian, Maltese, Norwegian, Polish, Portuguese, Romanian, Slovak, Slovenian, Spanish, Swedish, and TraditionalChinese. NOTE: The following languages are not yet available for everyone: Bulgarian, Croatian, Czech, Estonian, Greek, Hungarian, Japanese, Latvian, Lithuanian, Maltese, Polish, Romanian, Slovak, Slovenian. For Audience campaigns you must include all languages i.e., set this element to All. For Dynamic Search Ads campaigns, the campaign and ad group level language settings are ignored in favor of the website domain language. You should set campaign languages to "All" and leave the ad group level language empty. Add: Required for Audience campaigns, and otherwise this element is optional. If there is no campaign language set, then the language of each ad group within the campaign will be required. Update: Optional. If no value is set for the update, this setting is not changed. Once campaign languages are set, you cannot delete all of them. The list of languages that you specify during update replaces the previous settings i.e. does not append to the existing set of languages.
datatype: string

path: experimentId
name: experiment id
description: The system-generated identifier of the Experiment. This element is only set for experiment campaigns i.e., campaigns that have been created for A/B testing based on another Search campaign. Base campaigns will not contain an experiment ID. Likewise, after an experiment has been Graduated to an independent campaign, this element will be empty, even though the campaign was previously an experiment campaign. With experiment campaigns you cannot set the Budget, BudgetType, or Status. The budget, and status of an experiment campaign are always inherited from the base campaign settings. If you want to change an experiment's budget, you will need to change the base campaign's budget. The change in value will then be split based on your experiment TrafficSplitPercent setting. Add: Read-only Update: Read-only
datatype: long
max count: 1

path: adScheduleUseSearcherTimeZone
name: ad schedule use searcher time zone
description: Determines whether to use the account time zone or the time zone of the search user where the ads could be delivered. Set this property to true if you want the ads to be shown in the search user's time zone, and otherwise set it to false. This element is not returned by default. To get this element, include the AdScheduleUseSearcherTimeZone value in the ReturnAdditionalFields element when you call the GetCampaignsByAccountId and GetCampaignsByIds service operations. Add: Optional. If you do not specify this element or leave it empty, the default value of false will be set and the account time zone will be used. Update: Optional. If no value is set for the update, this setting is not changed.
datatype: boolean
max count: 1

path: bidStrategyId
name: bid strategy id
description: The system-generated identifier of the BidStrategy that this campaign shares with other campaigns in the account. If the field is empty, then the campaign is not using a portfolio bid strategy. If the field is not empty and the value is greater than zero, then the campaign is using a portfolio bid strategy. If the campaign is using a portfolio bid strategy, and you prefer that it use its own bid strategy, set this field to '0' (zero). Note: Portfolio bid strategies are not supported with smart shopping campaigns or Performance Max campaigns. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.
datatype: long
max count: 1

path: bidStrategyScope
name: bid strategy scope
description: A nullable field that indicates whether the BidStrategyId associated with the campaign is defined at the customer level or the account level. If no value is provided, the default scope is set to Account.
datatype: string
max count: 1
in: Account
in: Customer

path: multimediaAdsBidAdjustment
name: multimedia ads bid adjustment
description: The percent amount by which to adjust your bid for multimedia ads above or below the base ad group or keyword bid
datatype: int
max count: 1

path: goalIds
name: goal ids
description: A list of goal IDs.
datatype: long

path: dealIds
name: deal ids
description: A list of unique system identifiers corresponding to the deals that were added. The list of identifiers corresponds directly to the list of deals in the request. Items of the list may be returned as null. For each list index where a deal was not added, the corresponding element will be null.
datatype: long

path: isDealCampaign
name: is deal campaign
description: The campaign is a deal campaign if true.
datatype: boolean
max count: 1

path: startDate
name: start date
description: The date when you want your campaign to begin serving. For campaigns with budget type LifetimeBudgetStandard, StartDate is mandatory. The start date can be updated as long as the campaign has not started serving. Note: Currently, this will only be honored for Audience campaigns.
datatype: dateTime
max count: 1

path: endDate
name: end date
description: The date when you want your campaign to stop serving. If the budget type is LifetimeBudgetStandard, EndDate is required and can't be more than one year after the start date. EndDate can be set or left unset for campaigns with a daily budget. To remove the existing end date and effectively configure the campaign with no end date, set EndDate to January 1, 2050, or a later date. When retrieving the campaign, this element will be null. This indicates that no predefined end date exists, and EndDate won't explicitly be set to January 1, 2050. Note: Currently, this will only be honored for Audience campaigns.
datatype: dateTime
max count: 1

path: useCampaignLevelDates
name: use campaign level dates
description: Determines whether the dates should be managed at the campaign level or the ad group level. If set to true, campaign dates will be considered during serving. For the Lifetime Budget type, this field is required and must be set to true. For Daily Budget types, it can be set to either true or false, depending on whether you prefer to use campaign dates or ad group dates.
datatype: boolean
max count: 1

path: isPolitical
name: is political
description: Indicates whether a campaign is political. Microsoft doesn't currently support political campaigns. If IsPolitical is set to true, attempts to add or update the campaign will fail with the error: PoliticalCampaignsAreNotSupported. Additionally, if this field is empty or null in a GET call or bulk download, its value is treated as false. Add: Optional. If you do not specify this field or leave it empty, the default value of false is set. Update: Optional. If you do not specify this field or leave it empty, the default value of false is set. Delete: Read-only
datatype: boolean
max count: 1

path: forwardCompatibilityMap
name: forward compatibility map
description: 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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
node: CampaignManagementKeyValuePairOfstringAndstringShape
class: CampaignManagementKeyValuePairOfstringAndstring
node kind: BlankNodeOrIRI

path: value
name: value
datatype: double
max count: 1

path: appPlatform
name: app platform
datatype: string
max count: 1

path: appStoreId
name: app store id
datatype: string
max count: 1

path: isExternallyAttributed
name: is externally attributed
datatype: boolean
max count: 1

path: newBrandListAssociations
name: new brand list associations
datatype: boolean
max count: 1

path: newConversionGoals
name: new conversion goals
datatype: boolean
max count: 1

path: newCarouselAd
name: new carousel ad
datatype: boolean
max count: 1

path: newPortfolioBidStrategy
name: new portfolio bid strategy
datatype: boolean
max count: 1

path: newAIMaxSettings
name: new aimax settings
datatype: boolean
max count: 1

path: newSearchThemesForExistingAssetGroups
name: new search themes for existing asset groups
datatype: boolean
max count: 1

path: updateEntities
name: update entities
datatype: boolean
max count: 1

path: updateCampaignBudgets
name: update campaign budgets
datatype: boolean
max count: 1

path: updateBids
name: update bids
datatype: boolean
max count: 1

path: updateNegativeKeywordLists
name: update negative keyword lists
datatype: boolean
max count: 1

path: updateAccountNegativeKeywords
name: update account negative keywords
datatype: boolean
max count: 1

path: updateNegativeSites
name: update negative sites
datatype: boolean
max count: 1

path: updateKeywordUrls
name: update keyword urls
datatype: boolean
max count: 1

path: updateUrlOptions
name: update url options
datatype: boolean
max count: 1

path: updateCampaignNames
name: update campaign names
datatype: boolean
max count: 1

path: updateLabels
name: update labels
datatype: boolean
max count: 1

path: updateProductFilters
name: update product filters
datatype: boolean
max count: 1

path: updateConversionGoals
name: update conversion goals
datatype: boolean
max count: 1

path: updateLocationTargets
name: update location targets
datatype: boolean
max count: 1

path: updateAdSchedules
name: update ad schedules
datatype: boolean
max count: 1

path: updateDeviceTargets
name: update device targets
datatype: boolean
max count: 1

path: updateDemographicTargets
name: update demographic targets
datatype: boolean
max count: 1

path: updateCampaignAdGroupLanguages
name: update campaign ad group languages
datatype: boolean
max count: 1

path: updateAudienceTargets
name: update audience targets
datatype: boolean
max count: 1

path: updateTopicTargets
name: update topic targets
datatype: boolean
max count: 1

path: updateAppAdExtensions
name: update app ad extensions
datatype: boolean
max count: 1

path: updateCallAdExtensions
name: update call ad extensions
datatype: boolean
max count: 1

path: updateCalloutAdExtensions
name: update callout ad extensions
datatype: boolean
max count: 1

path: updatePriceAdExtensions
name: update price ad extensions
datatype: boolean
max count: 1

path: updateLocationAdExtensions
name: update location ad extensions
datatype: boolean
max count: 1

path: updateReviewAdExtensions
name: update review ad extensions
datatype: boolean
max count: 1

path: updateSitelinkAdExtensions
name: update sitelink ad extensions
datatype: boolean
max count: 1

path: updateStructuredSnippetAdExtensions
name: update structured snippet ad extensions
datatype: boolean
max count: 1

path: updatePromotionAdExtensions
name: update promotion ad extensions
datatype: boolean
max count: 1

path: updateImageAdExtensions
name: update image ad extensions
datatype: boolean
max count: 1

path: updateLogoAdExtensions
name: update logo ad extensions
datatype: boolean
max count: 1

path: updateLeadFormAdExtensions
name: update lead form ad extensions
datatype: boolean
max count: 1

path: updateStatusForCampaigns
name: update status for campaigns
datatype: boolean
max count: 1

path: updateStatusForAdGroups
name: update status for ad groups
datatype: boolean
max count: 1

path: updateStatusForAds
name: update status for ads
datatype: boolean
max count: 1

path: updateStatusForKeywords
name: update status for keywords
datatype: boolean
max count: 1

path: updateAdGroupNetwork
name: update ad group network
datatype: boolean
max count: 1

path: updatePageFeeds
name: update page feeds
datatype: boolean
max count: 1

path: updateAdCustomizerFeeds
name: update ad customizer feeds
datatype: boolean
max count: 1

path: updateBrandSuitability
name: update brand suitability
datatype: boolean
max count: 1

path: updateBrandListAssociations
name: update brand list associations
datatype: boolean
max count: 1

path: updateAdCustomizerAttributes
name: update ad customizer attributes
datatype: boolean
max count: 1

path: updateAIMaxSettings
name: update aimax settings
datatype: boolean
max count: 1

path: updateAssetGroupsAsset
name: update asset groups asset
datatype: boolean
max count: 1

path: enableCopilot
name: enable copilot
datatype: boolean
max count: 1

path: deleteRemovedEntities
name: delete removed entities
datatype: boolean
max count: 1

path: raiseBidsToMinimum
name: raise bids to minimum
datatype: boolean
max count: 1

path: raiseCampaignBudgetsToMinimum
name: raise campaign budgets to minimum
datatype: boolean
max count: 1

path: adjustmentForCampaignBudgets
name: adjustment for campaign budgets
datatype: double
max count: 1

path: adjustmentForBids
name: adjustment for bids
datatype: double
max count: 1

path: suffixForUrls
name: suffix for urls
datatype: string
max count: 1

path: searchAndReplaceForUrls
name: search and replace for urls
node: CampaignManagementImportSearchAndReplaceForStringPropertyShape
class: CampaignManagementImportSearchAndReplaceForStringProperty
node kind: BlankNodeOrIRI
max count: 1

path: suffixForTrackingTemplates
name: suffix for tracking templates
datatype: string
max count: 1

path: searchAndReplaceForTrackingTemplates
name: search and replace for tracking templates
node: CampaignManagementImportSearchAndReplaceForStringPropertyShape
class: CampaignManagementImportSearchAndReplaceForStringProperty
node kind: BlankNodeOrIRI
max count: 1

path: suffixForCampaignNames
name: suffix for campaign names
datatype: string
max count: 1

path: searchAndReplaceForCampaignNames
name: search and replace for campaign names
node: CampaignManagementImportSearchAndReplaceForStringPropertyShape
class: CampaignManagementImportSearchAndReplaceForStringProperty
node kind: BlankNodeOrIRI
max count: 1

path: searchAndReplaceForCustomParameters
name: search and replace for custom parameters
node: CampaignManagementImportSearchAndReplaceForStringPropertyShape
class: CampaignManagementImportSearchAndReplaceForStringProperty
node kind: BlankNodeOrIRI
max count: 1

path: searchAndReplaceForFinalURLSuffix
name: search and replace for final urlsuffix
node: CampaignManagementImportSearchAndReplaceForStringPropertyShape
class: CampaignManagementImportSearchAndReplaceForStringProperty
node kind: BlankNodeOrIRI
max count: 1

path: pauseCampaignsWithoutSupportedLocations
name: pause campaigns without supported locations
datatype: boolean
max count: 1

path: enableParentLocationMapping
name: enable parent location mapping
datatype: boolean
max count: 1

path: associatedStoreId
name: associated store id
datatype: long
max count: 1

path: raiseProductGroupBidsToMinimum
name: raise product group bids to minimum
datatype: boolean
max count: 1

path: searchAndDsaMixedCampaignAsSearchCampaign
name: search and dsa mixed campaign as search campaign
datatype: boolean
max count: 1

path: accountUrlOptions
name: account url options
datatype: boolean
max count: 1

path: enableAutoCurrencyConversion
name: enable auto currency conversion
datatype: boolean
max count: 1

path: updateBiddingStrategies
name: update bidding strategies
datatype: boolean
max count: 1

path: associatedUetTagId
name: associated uet tag id
datatype: long
max count: 1

path: autoDeviceBidOptimization
name: auto device bid optimization
datatype: boolean
max count: 1

path: adScheduleUseSearcherTimezone
name: ad schedule use searcher timezone
datatype: boolean
max count: 1

path: pauseAIMAdGroupIfAllAudienceCriterionNotImported
name: pause aimad group if all audience criterion not imported
datatype: boolean
max count: 1

path: renameCampaignNameWithSuffix
name: rename campaign name with suffix
datatype: boolean
max count: 1

path: updateAdUrls
name: update ad urls
datatype: boolean
max count: 1

path: updateSitelinkUrls
name: update sitelink urls
datatype: boolean
max count: 1

path: updateAssetAutomationCampaignSetting
name: update asset automation campaign setting
datatype: boolean
max count: 1

path: imageAssetAutomationOptOut
name: image asset automation opt out
datatype: boolean
max count: 1

path: importNCAGoalWithSystemGeneratedAudience
name: import ncagoal with system generated audience
datatype: boolean
max count: 1

path: callToActionLanguage
name: call to action language
description: The language that the call to action will be served in. The call to action will always be served in this language, regardless of the campaign's language settings. Add: Not applicable for audience ads; Required for multimedia ads Update: Optional. If no value is set for the update, this setting is not changed.
datatype: string
max count: 1
in: None
in: Albanian
in: Arabic
in: Bulgarian
in: TraditionalChinese
in: Croatian
in: Czech
in: Danish
in: Dutch
in: English
in: Estonian
in: Finnish
in: French
in: German
in: Greek
in: Hebrew
in: Hindi
in: Hungarian
in: Icelandic
in: Indonesian
in: Italian
in: Japanese
in: Korean
in: Latvian
in: Lithuanian
in: Macedonian
in: Malay
in: Maltese
in: Norwegian
in: Polish
in: Portuguese
in: Romanian
in: Russian
in: Serbian
in: Slovak
in: Slovenian
in: Spanish
in: Swedish
in: Tagalog
in: Thai
in: Turkish
in: Vietnamese
in: SimplifiedChinese
in: Bosnian
in: All

path: images
name: images
description: Image assets with different sizes and aspect ratios so they can flexibly display across a variety of publishers and placements. Include one or more AssetLink objects that each contain an ImageAsset with SubType and crop settings that match the desired aspect ratio. For more information see the remarks below. Add: Required Update: Optional. If no value is set for the update, this setting is not changed. If you include images during update, any previously set images will be replaced.
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI

path: videos
name: videos
description: Video assets with different sizes and aspect ratios so they can flexibly display across a variety of publishers and placements. Include one or more AssetLink objects that each contain a VideoAsset with a SubType. Add: Required for video ads Update: Optional. If no value is set for the update, this setting is not changed. If you include videos during an update, any previously set videos will be replaced.
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI

path: headlines
name: headlines
description: Headlines are the most prominent text that appears in your ad, so you should make the most out of the available characters. We require multiple headlines so the ad can flexibly display across a variety of publishers and placements. Unless you pin one of the headlines to a specific position, Bing will optimize the ad layout dynamically with the best headlines and descriptions for the user's search query. From a data model perspective the desriptions and headlines are each stored as text assets i.e., one TextAsset per AssetLink. The same asset can be used by multiple ads. For example if "Seamless Integration" is a text asset, it will have the same asset identifier across all ads in the same Microsoft Advertising account. You must set between 1-15 headlines. Each headline's Text must contain at least one word. For efficient use of resources we recommend that you use dynamic text strings such as {keyword} instead of creating new ad copy for each keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. The maximum input length of each headline's Text is 1,000 characters including dynamic text strings, and of those 1,000 no more than 30 final characters are allowed after substitution. The ad will fail to display or default text will be used if the length exceeds 30 characters after dynamic text substitution occurs. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 500 characters including dynamic text strings, and of those 500 no more than 15 final characters are allowed after substitution. The ad will fail to display or default text will be used if the length exceeds 15 characters after dynamic text substitution occurs. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japanese and Chinese languages characters as w…
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI

path: longHeadline
name: long headline
description: For Audience campaigns, LongHeadline is the longer of two possible responsive ad headlines.
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI
max count: 1

path: longHeadlines
name: long headlines
description: You must set between 1-5 long headlines. Each headline's Text must contain at least one word. The Text cannot contain the newline (\n) character. If the parent campaign associates to a store and you specify LongHeadlines, you must also specify Headlines, Descriptions, and Images. Add: Optional if the parent campaign associates to a store, required if its parent campaign does not associate to a store. Will use LongHeadlineString if empty. Update: Optional. To retain all of the existing asset links, set or leave this element nil. If you set a value for this element, any headlines that were previously linked to this asset group will be replaced. If the parent campaign associates to a store and you set this element to an empty list, the previous setting will be deleted.
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI

path: descriptions
name: descriptions
description: The descriptions that are shown below the path in your ad. To maximize impressions across all ad formats, the descriptions might not always be shown in your ad. To maximize impressions across all ad formats the descriptions might not always be shown in your ad. Unless you pin one of the descriptions to a specific position, Bing will optimize the ad layout dynamically with the best headlines and descriptions for the user's search query. From a data model perspective the desriptions and headlines are each stored as text assets i.e., one TextAsset per AssetLink. The same asset can be used by multiple ads. For example if "Seamless Integration" is a text asset, it will have the same asset identifier across all ads in the same Microsoft Advertising account. You must set between 1-5 descriptions. Each description's Text must contain at least one word. For efficient use of resources we recommend that you use dynamic text strings such as {keyword} instead of creating new ad copy for each keyword. For more information, see the Microsoft Advertising help article Automatically customize your ads with dynamic text parameters. The maximum input length of each description's Text is 1,000 characters including dynamic text strings, and of those 1,000 no more than 90 final characters are allowed after substitution. The ad will fail to display or default text will be used if the length exceeds 90 characters after dynamic text substitution occurs. For languages with double-width characters e.g. Traditional Chinese the maximum input length is 500 characters including dynamic text strings, and of those 500 no more than 45 final characters are allowed after substitution. The ad will fail to display or default text will be used if the length exceeds 45 characters after dynamic text substitution occurs. The double-width characters are determined by the characters you use instead of the character set of the campaign or ad group language settings. Double-width characters include Korean, Japan…
node: CampaignManagementAssetLinkShape
class: CampaignManagementAssetLink
node kind: BlankNodeOrIRI

path: impressionTrackingUrls
name: impression tracking urls
description: The URLs for 1x1 impression tracking pixels. Each pixel will report Microsoft Audience Network impressions to your third-party ad reporting tool. You can include up to 2 impression tracking URLs for each responsive ad. Each URL must be accessible. The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. For each Microsoft Audience Network impression, Microsoft will ping the URL to enable impression tracking in your third party ad reporting tool. Advanced-level user tracking such as conversion tracking or tracking based on cookies or IP addresses is not supported. This element is not returned by default. To get this element, include the ImpressionTrackingUrls value in the ReturnAdditionalFields element when you call the GetAdsByAdGroupId, GetAdsByEditorialStatus, and GetAdsByIds service operations. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. To remove impression tracking URLs set this element to an empty string array.
datatype: string

path: verifiedTrackingSettings
name: verified tracking settings
description: VerifiedTrackingSetting relates third-party measurement settings. This allows you to track viewability, brand safety, and invalid traffic metrics via a third-party verification provider, such as Integral Ad Science. This feature is available for native, display, and online video ads using the CPM bid strategy. Note: Currently, IAS is the only supported vendor (vendorName), but other verification providers are coming soon. The example below pertains to IAS. There are 3 key-value pairs for IAS:"vendorName""advertiserEntityID" (client ID for your verification provider)"publisherEntityID" (reporting ID for your verification provider)Example (required for IAS): vendorName : "IAS"advertiserEntityID : "12345678"publisherEntityID : "12345678"
node: CampaignManagementVerifiedTrackingSettingShape
class: CampaignManagementVerifiedTrackingSetting
node kind: BlankNodeOrIRI
max count: 1

path: adSubType
name: ad sub type
description: The possible ad sub types.
datatype: string
max count: 1