PerformanceInsightsDetail Data Object - Ad Insight

Defines the details for performance insights.

Syntax

XML

<xs:complexType name="PerformanceInsightsDetail" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="EntityId" type="xs:long" />
    <xs:element minOccurs="0" name="EntityType" type="tns:EntityType" />
    <xs:element minOccurs="0" name="KPIType" type="tns:KPIType" />
    <xs:element minOccurs="0" name="Date" nillable="true" type="tns:DayMonthAndYear" />
    <xs:element minOccurs="0" name="Description" nillable="true" type="tns:PerformanceInsightsMessage" />
    <xs:element minOccurs="0" name="RootCauses" nillable="true" type="tns:ArrayOfPerformanceInsightsMessage" />
    <xs:element minOccurs="0" name="Actions" nillable="true" type="tns:ArrayOfPerformanceInsightsMessage" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "Actions": [
    {
      "IndentationLevel": IntValueHere,
      "Parameters": [
        {
          "Type": "Entities",
          "EntityCount": IntValueHere,
          "EntityDetails": [
            {
              "EntityId": "LongValueHere",
              "EntityName": "ValueHere"
            }
          ],
          "EntityType": "ValueHere",
          "SuggestedText": "ValueHere"
        }
      ],
      "TemplateId": "ValueHere"
    }
  ],
  "Date": {
    "Day": IntValueHere,
    "Month": IntValueHere,
    "Year": IntValueHere
  },
  "Description": {
    "IndentationLevel": IntValueHere,
    "Parameters": [
      {
        "Type": "Entities",
        "EntityCount": IntValueHere,
        "EntityDetails": [
          {
            "EntityId": "LongValueHere",
            "EntityName": "ValueHere"
          }
        ],
        "EntityType": "ValueHere",
        "SuggestedText": "ValueHere"
      }
    ],
    "TemplateId": "ValueHere"
  },
  "EntityId": "LongValueHere",
  "EntityType": "ValueHere",
  "KPIType": "ValueHere",
  "RootCauses": [
    {
      "IndentationLevel": IntValueHere,
      "Parameters": [
        {
          "Type": "Entities",
          "EntityCount": IntValueHere,
          "EntityDetails": [
            {
              "EntityId": "LongValueHere",
              "EntityName": "ValueHere"
            }
          ],
          "EntityType": "ValueHere",
          "SuggestedText": "ValueHere"
        }
      ],
      "TemplateId": "ValueHere"
    }
  ]
}

Elements

The PerformanceInsightsDetail object has the following elements: Actions, Date, Description, EntityId, EntityType, KPIType, RootCauses.

Element	Description	Data Type
Actions	Messages that describe the actions in "What can I do."	PerformanceInsightsMessage array
Date	The date of the detected performance insights.	DayMonthAndYear
Description	A message to describe the performance insights.	PerformanceInsightsMessage
EntityId	For account level, this is AccountId. For campaign level, this is CampaignId.	long
EntityType	The supported types are account and campaign.	EntityType
KPIType	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.	KPIType
RootCauses	Messages that describe the root causes in "What happened."	PerformanceInsightsMessage array

Requirements

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

Used By

GetPerformanceInsightsDetailDataByAccountId