EntityParameter Data Object - Ad Insight

Article
03/20/2023

Defines an object that provides parameter information for an entity.

Syntax

<xs:complexType name="EntityParameter" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:PerformanceInsightsMessageParameter">
      <xs:sequence>
        <xs:element minOccurs="0" name="EntityCount" type="xs:int" />
        <xs:element minOccurs="0" name="EntityDetails" nillable="true" type="tns:ArrayOfEntityDetail" />
        <xs:element minOccurs="0" name="EntityType" type="tns:PerformanceInsightsEntityType" />
        <xs:element minOccurs="0" name="SuggestedText" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The EntityParameter object has the following elements: EntityCount, EntityDetails, EntityType, SuggestedText.

Element	Description	Data Type
EntityCount	The number of entities.	int
EntityDetails	The detail information for entities.	EntityDetail array
EntityType	The entity type.	PerformanceInsightsEntityType
SuggestedText	The suggested string value to substitute for the message.	string

The EntityParameter object has Inherited Elements.

Inherited Elements

Inherited Elements from PerformanceInsightsMessageParameter

The EntityParameter object derives from the PerformanceInsightsMessageParameter object, and inherits the following elements: Type. The descriptions below are specific to EntityParameter, and might not apply to other objects that inherit the same elements from the PerformanceInsightsMessageParameter object.

Element	Description	Data Type
Type	Defines a string for the type of parameter: string, URL, or a list of demand entities.	ParameterType

Requirements

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

Share via