StructuredSnippetAdExtension Data Object - Campaign Management

Article
03/20/2023

Defines an object that pairs one header with between 3 and 10 snippet values that tell customers more about your business.

In the following example, Courses is the header, and .NET, Java, Python, and PHP are examples of individual values.

Courses: .NET, Java, Python, PHP

You can associate a structured snippet 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 structured snippet ad extensions. An expanded text ad will only include one structured snippet (one headline with 3 - 10 values) per impression.

Syntax

<xs:complexType name="StructuredSnippetAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="Header" nillable="true" type="xs:string" />
        <xs:element xmlns:q53="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="Values" nillable="true" type="q53:ArrayOfstring" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The StructuredSnippetAdExtension object has the following elements: Header, Values.

Element	Description	Data Type
Header	The header that is appended with a colon (:) and precedes the snippet values. Structured Snippet headers must be specified in the same language that you intend it to be shown. For example, if you want header Amenities in English you must specify the header as Amenities. If you want header Ausstattung in German you must specify the header as Ausstattung (Amenities in German). For a list of supported headers per language, please see Ad Extension Header Languages. Add: Required Update: Required	string
Values	The snippet values that follow after the Header component of the ad that is shown. Each text value that you choose can have a maximum length of 25 characters. Note that for Traditional Chinese characters, each value can have a maximum length of 12 characters. Add: Required Update: Required	string array

The StructuredSnippetAdExtension object has Inherited Elements.

Inherited Elements

Inherited Elements from AdExtension

The StructuredSnippetAdExtension object derives from the AdExtension object, and inherits the following elements: DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version. The descriptions below are specific to StructuredSnippetAdExtension, 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 StructuredSnippetAdExtension when you retrieve a structured snippet 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