ReviewAdExtension Data Object - Campaign Management

Article
03/20/2023

Defines an object that specifies third-party reviews (exact or paraphrased) about your business, products, or services to include in an expanded text ad.

You can associate a review ad extension with the account or with campaigns and ad groups in the account. Each entity (account, campaign, or ad group) can be associated with up to 20 review ad extensions. An expanded text ad will only include one review per impression.

Syntax

<xs:complexType name="ReviewAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="IsExact" type="xs:boolean" />
        <xs:element minOccurs="0" name="Source" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Url" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The ReviewAdExtension object has the following elements: IsExact, Source, Text, Url.

Element	Description	Data Type
IsExact	Determines whether the review text is an exact quote or paraphrased. If not specified, the default value of false indicates that the review text is paraphrased from the source. If set to true, the review text will be surrounded automatically with quotation marks when displayed with the ad. Add: Optional Update: Optional. If you set this element null, the previous setting will be deleted.	boolean
Source	The review source name. The combined length of the Source and Text strings must not exceed 67 characters. Note that for Traditional Chinese characters, the combined length of the Source and Text Source and Text strings is limited to 33 characters. Add: Required Update: Required	string
Text	The text that is either a paraphrase or an exact quote from the review source. The combined length of the Source and Text strings must not exceed 67 characters. Note that for Traditional Chinese characters, the combined length of the Source and Text Source and Text strings is limited to 33 characters. Do not surround the text with quotation marks. If IsExact is set to True, the review text will be surrounded automatically with quotation marks when displayed with the ad. Add: Required Update: Required	string
Url	The review source Url. The Url must begin with either the http:// or https:// prefix. The length of this string is limited to 2,048 characters. Add: Required Update: Required	string

The ReviewAdExtension object has Inherited Elements.

Inherited Elements

Inherited Elements from AdExtension

The ReviewAdExtension object derives from the AdExtension object, and inherits the following elements: DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version. The descriptions below are specific to ReviewAdExtension, and might not apply to other objects that inherit the same elements from the AdExtension object.

Element	Description	Data Type
DevicePreference	Not supported for this ad extension type.	long
ForwardCompatibilityMap	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	KeyValuePairOfstringstring array
Id	The unique Microsoft Advertising identifier of the ad extension. Add: Read-only Update: Read-only and Required	long
Scheduling	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.	Schedule
Status	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	AdExtensionStatus
Type	The type of the ad extension. This value is ReviewAdExtension when you retrieve a review ad extension. Add: Read-only Update: Read-only For more information about ad extension types, see the Ad Extension Data Object Remarks.	string
Version	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	int

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Share via