AuctionInsightResult Data Object - Ad Insight

Defines the auction insight results from calling the GetAuctionInsightData operation.

Syntax

XML

<xs:complexType name="AuctionInsightResult" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Segments" nillable="true" type="tns:ArrayOfAuctionSegment" />
    <xs:element minOccurs="0" name="Entries" nillable="true" type="tns:ArrayOfAuctionInsightEntry" />
    <xs:element minOccurs="0" name="UsedImpressions" type="xs:double" />
    <xs:element minOccurs="0" name="UsedKeywords" type="xs:double" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "Entries": [
    {
      "AggregatedKpi": {
        "AboveRate": DoubleValueHere,
        "AbsoluteTopOfPageRate": DoubleValueHere,
        "AveragePosition": DoubleValueHere,
        "ImpressionShare": DoubleValueHere,
        "OutrankingShare": DoubleValueHere,
        "OverlapRate": DoubleValueHere,
        "Segments": [
          "ValueHere"
        ],
        "TopOfPageRate": DoubleValueHere
      },
      "DisplayDomain": "ValueHere",
      "SegmentedKpis": [
        {
          "AboveRate": DoubleValueHere,
          "AbsoluteTopOfPageRate": DoubleValueHere,
          "AveragePosition": DoubleValueHere,
          "ImpressionShare": DoubleValueHere,
          "OutrankingShare": DoubleValueHere,
          "OverlapRate": DoubleValueHere,
          "Segments": [
            "ValueHere"
          ],
          "TopOfPageRate": DoubleValueHere
        }
      ]
    }
  ],
  "Segments": [
    "ValueHere"
  ],
  "UsedImpressions": DoubleValueHere,
  "UsedKeywords": DoubleValueHere
}

Elements

The AuctionInsightResult object has the following elements: Entries, Segments, UsedImpressions, UsedKeywords.

Element	Description	Data Type
Entries	One or more auction insight entries i.e., one result per domain that you competed with in the auction.	AuctionInsightEntry array
Segments	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.	AuctionSegment array
UsedImpressions	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.	double
UsedKeywords	The number of keywords that were used to generate the auction insight entries.	double

Requirements

Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13

Used By

GetAuctionInsightData