FlyerAdExtension-Datenobjekt – Kampagnenverwaltung

Artikel
11/14/2024

Flyer Extensions ermöglichen es Werbetreibenden, Produkt- oder Store-Kataloge (Flyer) an potenzielle Kunden zu verteilen.

Sie können in breiten Abfragen wie "wöchentliche Deals" oder "wöchentliche Verkäufe" prominent angezeigt werden und so Kunden ermutigen, auf Ihre Anzeige statt auf die der Konkurrenz zu klicken. Durch ihre Natur tragen sie dazu bei, Sucher besser zu informieren und dadurch die Benutzerbindung zu erhöhen, z. B. die Klickrate.

Hinweis

Flyer-Erweiterungen sind für Kunden im Featurepiloten verfügbar (GetCustomerPilotFeatures gibt 802 zurück).

<xs:complexType name="FlyerAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q62="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q62:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q63="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q63:ArrayOfstring" />
        <xs:element minOccurs="0" name="FlyerName" nillable="true" type="xs:string" />
        <xs:element xmlns:q64="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaIds" nillable="true" type="q64:ArrayOflong" />
        <xs:element xmlns:q65="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaUrls" nillable="true" type="q65:ArrayOfstring" />
        <xs:element minOccurs="0" name="StoreId" nillable="true" type="xs:long" />
        <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>

{
  "DevicePreference": "LongValueHere",
  "ForwardCompatibilityMap": [
    {
      "key": "ValueHere",
      "value": "ValueHere"
    }
  ],
  "Id": "LongValueHere",
  "Scheduling": {
    "DayTimeRanges": [
      {
        "Day": "ValueHere",
        "EndHour": IntValueHere,
        "EndMinute": "ValueHere",
        "StartHour": IntValueHere,
        "StartMinute": "ValueHere"
      }
    ],
    "EndDate": {
      "Day": IntValueHere,
      "Month": IntValueHere,
      "Year": IntValueHere
    },
    "StartDate": {
      "Day": IntValueHere,
      "Month": IntValueHere,
      "Year": IntValueHere
    },
    "UseSearcherTimeZone": "ValueHere"
  },
  "Status": "ValueHere",
  "Type": "FlyerAdExtension",
  "Version": IntValueHere,
  "Description": "ValueHere",
  "FinalAppUrls": [
    {
      "OsType": "ValueHere",
      "Url": "ValueHere"
    }
  ],
  "FinalMobileUrls": [
    "ValueHere"
  ],
  "FinalUrls": [
    "ValueHere"
  ],
  "FinalUrlSuffix": "ValueHere",
  "FlyerName": "ValueHere",
  "ImageMediaIds": [
    "LongValueHere"
  ],
  "ImageMediaUrls": [
    "ValueHere"
  ],
  "StoreId": "LongValueHere",
  "TrackingUrlTemplate": "ValueHere",
  "UrlCustomParameters": {
    "Parameters": [
      {
        "Key": "ValueHere",
        "Value": "ValueHere"
      }
    ]
  }
}

Elemente

Das FlyerAdExtension-Objekt weist die folgenden Elemente auf: Description, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, FlyerName, ImageMediaIds, ImageMediaUrls, StoreId, TrackingUrlTemplate, UrlCustomParameters.

Element	Beschreibung	Datentyp
Beschreibung	Beschreibung, die vom Werbetreibenden, der Agentur oder dem Konto-Manager verwendet werden kann, um Flyererweiterungen zu verfolgen, zu kennzeichnen oder zu verwalten. Diese Beschreibung wird nicht zusammen mit der Anzeige oder dem Bild angezeigt. Die maximale Länge für dieses Element beträgt 1.024 Zeichen. Hinzufügen: Wahlfrei Aktualisieren: Wahlfrei. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert.	Zeichenfolge
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: Wahlfrei Aktualisieren: Wahlfrei. 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: Wahlfrei. 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: Wahlfrei Aktualisieren: Wahlfrei. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert.	Zeichenfolge
FlyerName	Der Name des Flyers. Die maximale Länge für dieses Element beträgt 150 Zeichen. Hinzufügen: Erforderlich Aktualisieren: Wahlfrei. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert.	Zeichenfolge
ImageMediaIds	Der Bezeichner des Bilds, das in die Anzeige aufgenommen werden soll. Sie können nur eine Medien-ID festlegen. Der Datentyp ist eine Liste mit langen Werten für den Fall, dass die Unterstützung für mehrere Bilder später hinzugefügt wird. Jede Medien-ID entspricht einem Image des Untertyps "GenericImage" Media . Sie können den Bezeichner jedes Bilds abrufen, wenn Sie sie der Bildbibliothek hinzufügen, indem Sie den AddMedia-Vorgang aufrufen. Andernfalls können Sie nach dem Hinzufügen der Medien zu Ihrer Bildbibliothek die Medienbezeichner mit dem Vorgang GetMediaMetaDataByAccountId abrufen. Das Bild sollte eine Mindestbreite und Höhe von 220 Pixeln und eine maximale Dateigröße von 3,9 MB aufweisen. Hinzufügen: Erforderlich Aktualisieren: Wahlfrei. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert.	langes Array
ImageMediaUrls	Die URL des Mediums, das Sie bereits hinzugefügt haben. Hinzufügen: Schreibgeschützt Aktualisieren: Schreibgeschützt	Zeichenfolgenarray
StoreId	Der eindeutige Bezeichner eines Microsoft Merchant Center-Stores, der für Produktanzeigen verwendet wird. Hinzufügen: Wahlfrei Aktualisieren: Schreibgeschützt. Sie können die Store-ID nicht aktualisieren, nachdem sie festgelegt wurde.	lang
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: Wahlfrei Aktualisieren: Wahlfrei. 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: Wahlfrei Aktualisieren: Wahlfrei. 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 FlyerAdExtension-Objekt verfügt über geerbte Elemente.

Geerbte Elemente

Geerbte Elemente von AdExtension

Das FlyerAdExtension-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 FlyerAdExtension 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.	lang
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	lang
Zeitplanung	Bestimmt den Kalendertag und die Zeitbereiche, in dem die Anzeigenerweiterung in Anzeigen angezeigt werden kann. Das EndDate muss innerhalb von 30 Tagen nach startDate sein. Hinzufügen: Der Zeitplan StartDate und EndDate sind für Flyer-Anzeigenerweiterungen erforderlich. Aktualisieren: Wahlfrei. 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. Sie können dieses Element nicht auf ein leeres Schedule-Objekt festlegen, da dies effektiv versuchen würde, die gesamte Zeitplanung zu löschen. Dies würde zu einem Fehler führen, da StartDate und EndDate für Flyer-Anzeigenerweiterungen erforderlich sind.	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 FlyerAdExtension , wenn Sie eine Flyer-Anzeigenerweiterung 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: Unstatthaft Aktualisieren: Unstatthaft	int

Anforderungen

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

Freigeben über