PerformanceInsightsMessage Data Object - Ad Insight

Defines the message for performance insights.

Syntax

XML

<xs:complexType name="PerformanceInsightsMessage" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="TemplateId" type="tns:PerformanceInsightsMessageTemplateId" />
    <xs:element minOccurs="0" name="Parameters" nillable="true" type="tns:ArrayOfPerformanceInsightsMessageParameter" />
    <xs:element minOccurs="0" name="IndentationLevel" type="xs:int" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "IndentationLevel": IntValueHere,
  "Parameters": [
    {
      "Type": "Entities",
      "EntityCount": IntValueHere,
      "EntityDetails": [
        {
          "EntityId": "LongValueHere",
          "EntityName": "ValueHere"
        }
      ],
      "EntityType": "ValueHere",
      "SuggestedText": "ValueHere"
    }
  ],
  "TemplateId": "ValueHere"
}

Elements

The PerformanceInsightsMessage object has the following elements: IndentationLevel, Parameters, TemplateId.

Element	Description	Data Type
IndentationLevel	Indentation distance or depth when displaying the message. By default, it is 0, which means no indentation distance.	int
Parameters	Message parameters are used to fill in the template that renders the message string.	PerformanceInsightsMessageParameter array
TemplateId	The message template ID.	PerformanceInsightsMessageTemplateId

Requirements

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

Used By

PerformanceInsightsDetail