Freigeben über


PromotionAdExtension-Datenobjekt – Kampagnenverwaltung

Werbeerweiterungen heben spezielle Verkäufe und Angebote in Ihren Textanzeigen hervor. Indem Angebote hervorstechen, ist es wahrscheinlicher, dass potenzielle Kunden auf Ihre Anzeige klicken, um mehr Umsatz für Sie zu generieren.

Sie können eine Werbeanzeigenerweiterung dem Konto oder Kampagnen und Anzeigengruppen im Konto zuordnen. Jede Entität (Konto, Kampagne oder Anzeigengruppe) kann bis zu 20 Werbeanzeigenerweiterungen zugeordnet werden.

Hinweis

Promotion-Erweiterungen sind für Kunden in AU, CA, DE, FR, USA und Uk verfügbar.

Syntax

<xs:complexType name="PromotionAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="CurrencyCode" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DiscountModifier" nillable="true" type="tns:PromotionDiscountModifier" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q56="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q56:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q57="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q57:ArrayOfstring" />
        <xs:element minOccurs="0" name="Language" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="MoneyAmountOff" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="OrdersOverAmount" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="PercentOff" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="PromotionCode" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="PromotionEndDate" nillable="true" type="tns:Date" />
        <xs:element minOccurs="0" name="PromotionItem" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="PromotionOccasion" nillable="true" type="tns:PromotionOccasion" />
        <xs:element minOccurs="0" name="PromotionStartDate" nillable="true" type="tns:Date" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elemente

Das PromotionAdExtension-Objekt verfügt über die folgenden Elemente: CurrencyCode, DiscountModifier, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, Language, MoneyAmountOff, OrdersOverAmount, PercentOff, PromotionCode, PromotionEndDate, PromotionItem, PromotionOccasion, PromotionStartDate, TrackingUrlTemplate, UrlCustomParameters.

Element Beschreibung Datentyp
CurrencyCode Der Währungscode für den Aktionspreis oder -rabatt.

Dieses Feld gilt nur, wenn Sie MoneyAmountOff oder OrdersOverAmount festlegen.

Die unterstützten Währungscodes sind ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, DKK, EUR, GBP, HKD, INR, MXN, NZD, PEN, PHP, PLN, SEK, SGD, USD, TWD und VEF.

Hinzufügen: Erforderlich, wenn MoneyAmountOff oder OrdersOverAmount festgelegt sind.
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Wenn Sie PercentOff oder PromotionCode festlegen, ist diese Einstellung nicht mehr anwendbar und wird gelöscht.
Zeichenfolge
DiscountModifier Der Aktionsrabattmodifizierer.

Angenommen, der Rabattmodifizierer ist auf UpTo festgelegt. Wenn der Rabatt für eine unveränderte Aktion dann "20 USD für Schuhe" betragen würde, lautet die geänderte Aktion "Bis zu 20 USD off shoes".

Hinzufügen: Optional. Wenn Sie dieses Element nicht angeben oder leer lassen, wird der Standardwert Keine festgelegt.
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert.
PromotionDiscountModifier
FinalAppUrls Reserviert für zukünftige Verwendung. AppUrl-Array
FinalMobileUrls Die URL der Landing Page für mobile Geräte.

Die folgenden Überprüfungsregeln gelten für endgültige URLs und endgültige mobile URLs.
– Die Länge der URL ist auf 2.048 Zeichen beschränkt. Die HTTP- oder HTTPS-Protokollzeichenfolge wird auf den Grenzwert von 2.048 Zeichen angerechnet.
– Sie können bis zu 10 Listenelemente für FinalUrls und FinalMobileUrls angeben. für die Lieferung wird jedoch nur der erste Artikel in jeder Liste verwendet. Der Dienst ermöglicht bis zu 10 Listenelemente für potenzielle Vorwärtskompatibilität.
- Die Verwendung von "{" und "}" ist nur zum Abgrenzen von Tags zulässig, z. B. {lpurl}.
- Endgültige URLs müssen jeweils eine wohlgeformte URL sein, die entweder mit http:// oder https:// beginnt.
– Wenn Sie FinalMobileUrls angeben, müssen Sie auch FinalUrls angeben.

Hinzufügen: Optional
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Wenn Sie dieses Element auf eine leere Liste festlegen, wird die vorherige Einstellung gelöscht.
Zeichenfolgenarray
FinalUrls Die URL der Landing Page.

Die folgenden Überprüfungsregeln gelten für endgültige URLs und endgültige mobile URLs.
– Die Länge der URL ist auf 2.048 Zeichen beschränkt. Die HTTP- oder HTTPS-Protokollzeichenfolge wird auf den Grenzwert von 2.048 Zeichen angerechnet.
– Sie können bis zu 10 Listenelemente für FinalUrls und FinalMobileUrls angeben. für die Lieferung wird jedoch nur der erste Artikel in jeder Liste verwendet. Der Dienst ermöglicht bis zu 10 Listenelemente für potenzielle Vorwärtskompatibilität.
- Die Verwendung von "{" und "}" ist nur zum Abgrenzen von Tags zulässig, z. B. {lpurl}.
- Endgültige URLs müssen jeweils eine wohlgeformte URL sein, die entweder mit http:// oder https:// beginnt.
– Wenn Sie FinalMobileUrls angeben, müssen Sie auch FinalUrls angeben.

Hinzufügen: Erforderlich
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert.
Zeichenfolgenarray
FinalUrlSuffix Das endgültige URL-Suffix kann Nachverfolgungsparameter enthalten, die an das Ende ihrer Landing Page-URL angefügt werden. Es wird empfohlen, die für Ihre Landing Page benötigten Nachverfolgungsparameter in einem endgültigen URL-Suffix zu platzieren, damit Ihre Kunden immer an Ihre Landing Page gesendet werden. Weitere Informationen und Validierungsregeln finden Sie unter Endgültiges URL-Suffix in den technischen Leitfäden.

Dieses Feature ist nur für Kunden im Pilotversuch "End-URL-Suffix Phase 3" verfügbar (GetCustomerPilotFeatures gibt 636 zurück). Wenn Sie sich nicht im Pilotversuch befinden, wird diese Eigenschaft ignoriert, und es wird kein Fehler zurückgegeben.

Hinzufügen: Optional
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Wenn Sie dieses Element auf eine leere Zeichenfolge ("") festlegen, wird die vorherige Einstellung gelöscht.
Zeichenfolge
Sprache Die Sprache, in der die Anzeigenerweiterung bereitgestellt wird.

Die Erweiterung wird immer in dieser Sprache bereitgestellt, unabhängig von den Spracheinstellungen der Kampagne oder Anzeigengruppe.

Die unterstützten Sprachzeichenfolgen sind: Dänisch, Niederländisch, Englisch, Finnisch, Französisch, Deutsch, Italienisch, Norwegisch, Portugiesisch, Spanisch, Schwedisch und TraditionellChinesisch.

Hinzufügen: Erforderlich
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert.
Zeichenfolge
MoneyAmountOff Das Geld aus Dem Promotion-Wert.

Wenn Sie z. B. "20 USD off shoes - On orders over $100" (Bei Bestellungen über 100 USD) höher stufen möchten, legen Sie das PromotionItem-Objekt auf "schuhe" fest, legen Sie CurrencyCode auf "USD" fest, legen Sie MoneyAmountOff auf 20 fest, und legen Sie OrdersOverAmount auf 100 fest.

Hinzufügen: Erforderlich. Sie müssen entweder MoneyAmountOff oder PercentOff festlegen, aber Sie können nicht beide festlegen.
Aktualisieren: Optional. Sie können entweder MoneyAmountOff oder PercentOff festlegen, aber sie können nicht beide festlegen.
Doppel
OrdersOverAmount Die Aufträge über den Betragswert, der an das Heraufstufungsziel angefügt wird.

Wenn Sie z. B. "20 USD off shoes - On orders over $100" (Bei Bestellungen über 100 USD) höher stufen möchten, legen Sie das PromotionItem-Objekt auf "schuhe" fest, legen Sie CurrencyCode auf "USD" fest, legen Sie MoneyAmountOff auf 20 fest, und legen Sie OrdersOverAmount auf 100 fest.

Hinzufügen: Optional. Sie können nicht sowohl OrdersOverAmount als auchPromotionCode festlegen.
Aktualisieren: Optional. Sie können nicht sowohl OrdersOverAmount als auchPromotionCode festlegen. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Wenn Sie dieses Element auf "0" (null) festlegen, wird die vorherige Einstellung gelöscht.
Doppel
PercentOff Der prozentsatzoffene Heraufstufungswert.

Beispielsweise stellt 10,0 einen Rabatt von 10 % dar.

Hinzufügen: Erforderlich. Sie müssen entweder MoneyAmountOff oder PercentOff festlegen, aber Sie können nicht beide festlegen.
Aktualisieren: Optional. Sie können entweder MoneyAmountOff oder PercentOff festlegen, aber sie können nicht beide festlegen. Wenn Sie diese Eigenschaft festlegen, gilt die CurrencyCode-Einstellung nicht mehr und wird gelöscht, wenn sie zuvor festgelegt wurde.
Doppel
PromotionCode Der an das Heraufstufungsziel angefügte Höherstufungscode.

Wenn Sie beispielsweise "$20 off shoes - Promocode SAVE20" höher stufen möchten, legen Sie das PromotionItem-Objekt auf "schuhe" fest, legen Sie CurrencyCode auf "USD" fest, legen Sie MoneyAmountOff auf 20 fest, und legen Sie PromotionCode auf "SAVE20" fest.

Die Zeichenfolge darf maximal 15 Zeichen enthalten.

Hinzufügen: Optional. Sie können nicht sowohl OrdersOverAmount als auchPromotionCode festlegen.
Aktualisieren: Optional. Sie können nicht sowohl OrdersOverAmount als auchPromotionCode festlegen. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Wenn Sie dieses Element auf eine leere Zeichenfolge ("") festlegen, wird die vorherige Einstellung gelöscht. Wenn Sie diese Eigenschaft festlegen, gilt die CurrencyCode-Einstellung nicht mehr und wird gelöscht, wenn sie zuvor festgelegt wurde.
Zeichenfolge
PromotionEndDate Das Enddatum hilft dabei, das Promotiondatum oder die Datumsangaben zu informieren, die in der Anzeige angezeigt werden.

Wenn z. B. die Datumsangaben PromotionStartDate und PromotionEndDate auf den 14. Februar festgelegt sind, könnte der Text "Gültiger Februar 14" in die angezeigte Heraufstufung eingeschlossen werden.

Das PromotionStartDate-Datum muss vor oder gleich dem PromotionEndDate-Datum sein.

Diese Eigenschaft überschreibt nicht den inhärenten Übermittlungsbereich für eine Heraufstufung. Sowohl die Promotion PromotionOccasion als auch die Terminplanung bestimmen, wann die Promotion in Anzeigen angezeigt werden kann.

Wenn das Enddatum für das aktuelle Jahr bereits abgelaufen ist, müssen jedes Start- und Enddatum für Datumsangaben im Folgejahr festgelegt werden.

Hinzufügen: Optional
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Um das aktuelle Enddatum zu löschen und effektiv kein Enddatum festzulegen, legen Sie für Tag, Monat und Jahr jeweils "0" (Null) fest. Wenn Sie die Werbungserweiterung beim nächsten Mal abrufen, wird dieses Element nicht festgelegt.
Date
PromotionItem Das Höherstufungsziel oder -element.

Sie können beispielsweise eine Promotion für "Schuhe" mit einem Rabatt von 20 USD oder 20 % durchführen. Um eine Promotion für "Bis zu 20 US-Dollar off shoes" auszuführen, legen Sie das PromotionItem-Element auf "Schuhe" fest, legen Sie DiscountModifier auf UpTo, CurrencyCode auf "USD" und MoneyAmountOff auf 20 fest.

Die Zeichenfolge darf maximal 20 Zeichen enthalten.

Hinzufügen: Erforderlich
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert.
Zeichenfolge
PromotionOccasion Der Promotion-Anlass.

Sowohl die Elemente PromotionOccasion als auch Scheduling bestimmen, wann die Promotion in Anzeigen angezeigt werden kann.

Die PromotionOccasion bestimmt den Zeitraum oder die Saisonalität, z. B. WomensDay vom 15. Februar bis 31. März jedes Jahr. Die Heraufstufung wird nur innerhalb der Datumsangaben ausgeführt, die dem von Ihnen festgelegten Anlass entsprechen. Ausführliche Informationen zum definierten Datumsbereich für die einzelnen Anlässe finden Sie unter PromotionOccasion .

Die Zeitplanung kann die Höherstufung auf einen kürzeren Zeitrahmen innerhalb des Datumsbereichs des Anlasses beschränken, z. B. die Ausführung der Höherstufung zwischen dem 20. Februar und dem 8. März zu beschränken. Die Zeitplanung kann auch verwendet werden, um dieselbe Aktion mehrere Jahre auszuführen, z. B. die WomensDay-Aktion jedes Jahr vom 15. Februar bis zum 31. März durchzuführen.

Hinzufügen: Optional. Wenn Sie dieses Element nicht angeben oder leer lassen, wird der Standardwert Keine festgelegt.
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Wenn Sie dieses Element festlegen, müssen auch PromotionStartDate und PromotionEndDate so festgelegt werden, dass die vorherigen Einstellungen beibehalten oder aktualisiert werden.
PromotionOccasion
PromotionStartDate Das Startdatum hilft ihnen, das Promotionsdatum oder die Datumsangaben zu informieren, die in der Anzeige angezeigt werden.

Wenn z. B. die Datumsangaben PromotionStartDate und PromotionEndDate auf den 14. Februar festgelegt sind, könnte der Text "Gültiger Februar 14" in die angezeigte Heraufstufung eingeschlossen werden.

Das PromotionStartDate-Datum muss vor oder gleich dem PromotionEndDate-Datum sein.

Diese Eigenschaft überschreibt nicht den inhärenten Übermittlungsbereich für eine Heraufstufung. Sowohl die Promotion PromotionOccasion als auch die Terminplanung bestimmen, wann die Promotion in Anzeigen angezeigt werden kann.

Wenn das Enddatum für das aktuelle Jahr bereits abgelaufen ist, müssen jedes Start- und Enddatum für Datumsangaben im Folgejahr festgelegt werden.

Hinzufügen: Optional
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Um das aktuelle Enddatum zu löschen und effektiv kein Enddatum festzulegen, legen Sie für Tag, Monat und Jahr jeweils "0" (Null) fest. Wenn Sie die Werbungserweiterung beim nächsten Mal abrufen, wird dieses Element nicht festgelegt.
Date
TrackingUrlTemplate Die Nachverfolgungsvorlage, die als Standard für alle FinalUrls und FinalMobileUrls verwendet werden soll.

Die folgenden Validierungsregeln gelten für Nachverfolgungsvorlagen. Weitere Informationen zu unterstützten Vorlagen und Parametern finden Sie im Microsoft Advertising-Hilfeartikel Welche Nachverfolgungs- oder URL-Parameter kann ich verwenden?
- Nachverfolgungsvorlagen, die für Entitäten auf niedrigerer Ebene definiert sind, z. B. Anzeigen, überschreiben diejenigen, die für Entitäten höherer Ebene festgelegt wurden, z. B. Kampagnen. Weitere Informationen finden Sie unter Entitätsgrenzwerte.
– Die Länge der Nachverfolgungsvorlage ist auf 2.048 Zeichen beschränkt. Die HTTP- oder HTTPS-Protokollzeichenfolge wird auf den Grenzwert von 2.048 Zeichen angerechnet.
– Die Nachverfolgungsvorlage muss eine wohlgeformte URL sein, die mit einer der folgenden Beginnt: http://, https://, {lpurl} oder {unescapedlpurl}.
– Microsoft Advertising überprüft nicht, ob benutzerdefinierte Parameter vorhanden sind. Wenn Sie benutzerdefinierte Parameter in Ihrer Nachverfolgungsvorlage verwenden und diese nicht vorhanden sind, enthält die URL der Angebotsseite die Schlüssel- und Wertplatzhalter Ihrer benutzerdefinierten Parameter ohne Ersetzung. Wenn Ihre Nachverfolgungsvorlage beispielsweise lautet https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} und weder {_season} noch {_promocode} auf Kampagnen-, Anzeigengruppen-, Kriterium-, Schlüsselwort (keyword)- oder Anzeigenebene definiert sind, ist die URL der Landing Page identisch.

Hinzufügen: Optional
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Wenn Sie dieses Element auf eine leere Zeichenfolge ("") festlegen, wird die vorherige Einstellung gelöscht.
Zeichenfolge
UrlCustomParameters Ihre benutzerdefinierte Sammlung von Schlüssel- und Wertparametern für die URL-Nachverfolgung.

Microsoft Advertising akzeptiert die ersten 3 CustomParameter-Objekte , die Sie in das CustomParameters-Objekt einschließen, und alle zusätzlichen benutzerdefinierten Parameter werden ignoriert. Jeder CustomParameter enthält Key - und Value-Elemente . Für Kunden im Pilotversuch "Limiterhöhung für benutzerdefinierte Parameter" in Phase 3 (GetCustomerPilotFeatures gibt 635 zurück) akzeptiert Microsoft Advertising die ersten 8 benutzerdefinierten Parameterschlüssel- und Wertpaare, die Sie einschließen. Wenn Sie mehr als 8 benutzerdefinierte Parameter einschließen, wird ein Fehler zurückgegeben.

Hinzufügen: Optional
Aktualisieren: Optional. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Legen Sie das UrlCustomParameters-Element auf NULL oder leer fest, um alle vorhandenen benutzerdefinierten Parameter beizubehalten. Um alle benutzerdefinierten Parameter zu entfernen, legen Sie das Parameters-Element des CustomParameters-Objekts auf NULL oder leer fest. Um eine Teilmenge benutzerdefinierter Parameter zu entfernen, geben Sie die benutzerdefinierten Parameter an, die Sie im Parameters-Element des CustomParameters-Objekts beibehalten möchten.
CustomParameters

Das PromotionAdExtension-Objekt verfügt über geerbte Elemente.

Geerbte Elemente

Geerbte Elemente von AdExtension

Das PromotionAdExtension-Objekt wird vom AdExtension-Objekt abgeleitet und erbt die folgenden Elemente: DevicePreference, ForwardCompatibilityMap, ID, Scheduling, Status, Type, Version. Die folgenden Beschreibungen gelten spezifisch für PromotionAdExtension und gelten möglicherweise nicht für andere Objekte, die dieselben Elemente vom AdExtension-Objekt erben .

Element Beschreibung Datentyp
DevicePreference Wird für diesen Anzeigenerweiterungstyp nicht unterstützt. Lange
ForwardCompatibilityMap Die Liste der Schlüssel- und Wertzeichenfolgen für die Vorwärtskompatibilität, um andere Breaking Changes zu vermeiden, wenn neue Elemente in der aktuellen API-Version hinzugefügt werden.

Es gibt derzeit keine Änderungen an der Vorwärtskompatibilität für das AdExtension-Objekt .

Hinzufügen: Schreibgeschützt
Aktualisieren: Schreibgeschützt
KeyValuePairOfstring-Array
Id Der eindeutige Microsoft Advertising-Bezeichner der Anzeigenerweiterung.

Hinzufügen: Schreibgeschützt
Aktualisieren: Schreibgeschützt und erforderlich
Lange
Zeitplanung Bestimmt den Kalendertag und die Zeitbereiche, in dem die Anzeigenerweiterung in Anzeigen angezeigt werden kann.

Hinzufügen: Optional
Aktualisieren: Optional. Wenn Sie dieses Element null festlegen, bleiben alle vorhandenen Zeitplanungssätze für die Anzeigenerweiterung unverändert. Wenn Sie dieses Objekt auf ein Schedule-Objekt ungleich NULL festlegen, ersetzen Sie effektiv vorhandene Planungseinstellungen für die Anzeigenerweiterung. Um alle Zeitplanungen zu entfernen, legen Sie dieses Element auf ein leeres Schedule-Objekt fest.
Schedule
Status Der status der Anzeigenerweiterung. Der Wert ist immer Aktiv , da der Kampagnenverwaltungsdienst keine gelöschten Anzeigenerweiterungen zurückgibt.

Hinzufügen: Schreibgeschützt
Aktualisieren: Schreibgeschützt
AdExtensionStatus
Typ Der Typ der Anzeigenerweiterung. Dieser Wert ist PromotionAdExtension , wenn Sie eine Werbeerweiterung abrufen.

Hinzufügen: Schreibgeschützt
Aktualisieren: Schreibgeschützt

Weitere Informationen zu Anzeigenerweiterungstypen finden Sie in den Hinweisen zu Ad Extension Data Object.
Zeichenfolge
Version Verfolgt nach, wie oft die Anzeigenerweiterung aktualisiert wurde.

Die Version wird beim Erstellen der Anzeigenerweiterung auf 1 festgelegt und nach jedem Update um eins erhöht.

Hinzufügen: Nicht zulässig
Aktualisieren: Nicht zulässig
int

Anforderungen

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