ImageAdExtension-Datenobjekt – Kampagnenverwaltung

Artikel
11/13/2024

Definiert eine Anzeigenerweiterung, die ein Bild mit alternativem Text angibt, der in eine erweiterte Textanzeige aufgenommen werden soll.

Sie können dem Konto oder Kampagnen und Anzeigengruppen im Konto eine Bildanzeigenerweiterung zuordnen. Für jedes Konto können nur 1.000 Kampagnen und 1.000 Anzeigengruppen erweiterungen zugeordnet werden. Jede Entität (Konto, Kampagne oder Anzeigengruppe) kann bis zu 6 Bildanzeigenerweiterungen zugeordnet werden.

<xs:complexType name="ImageAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="AlternativeText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayText" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q44="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q44:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q45="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q45:ArrayOfstring" />
        <xs:element xmlns:q46="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaIds" nillable="true" type="q46:ArrayOflong" />
        <xs:element minOccurs="0" name="Images" nillable="true" type="tns:ArrayOfAssetLink">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element xmlns:q47="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="Layouts" nillable="true" type="q47:ArrayOfstring">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="SourceType" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <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": "ImageAdExtension",
  "Version": IntValueHere,
  "AlternativeText": "ValueHere",
  "Description": "ValueHere",
  "DestinationUrl": "ValueHere",
  "DisplayText": "ValueHere",
  "FinalAppUrls": [
    {
      "OsType": "ValueHere",
      "Url": "ValueHere"
    }
  ],
  "FinalMobileUrls": [
    "ValueHere"
  ],
  "FinalUrls": [
    "ValueHere"
  ],
  "FinalUrlSuffix": "ValueHere",
  "ImageMediaIds": [
    "LongValueHere"
  ],
  "Images": [
    {
      "Asset": {
        "Id": "LongValueHere",
        "Name": "ValueHere",
        "Type": "ImageAsset",
        "CropHeight": IntValueHere,
        "CropWidth": IntValueHere,
        "CropX": IntValueHere,
        "CropY": IntValueHere,
        "SubType": "ValueHere",
        "TargetHeight": IntValueHere,
        "TargetWidth": IntValueHere
      },
      "AssetPerformanceLabel": "ValueHere",
      "EditorialStatus": "ValueHere",
      "PinnedField": "ValueHere"
    }
  ],
  "Layouts": [
    "ValueHere"
  ],
  "SourceType": "ValueHere",
  "TrackingUrlTemplate": "ValueHere",
  "UrlCustomParameters": {
    "Parameters": [
      {
        "Key": "ValueHere",
        "Value": "ValueHere"
      }
    ]
  }
}

Elemente

Das ImageAdExtension-Objekt verfügt über die folgenden Elemente: AlternativeText, Description, DestinationUrl, DisplayText, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, ImageMediaIds, Images, Layouts, SourceType, TrackingUrlTemplate, UrlCustomParameters.

Element	Beschreibung	Datentyp
AlternativeText	Alternative Beschreibung der Bildmedien für die Benutzerfreundlichkeit. Wenn das Bild nicht angezeigt werden konnte, wird stattdessen der Alternativtext verwendet. Die maximale Länge für dieses Element beträgt 35 Zeichen. Hinzufügen: Erforderlich Aktualisieren: Erforderlich	Zeichenfolge
Beschreibung	Beschreibung, die vom Werbetreibenden, der Agentur oder dem Konto-Manager zum Nachverfolgen, Bezeichnen oder Verwalten von Bildmedien verwendet werden kann. Diese Beschreibung wird nicht zusammen mit der Anzeige oder dem Bild angezeigt. Die maximale Länge für dieses Element beträgt 100 Zeichen. Hinzufügen: Wahlfrei Aktualisieren: Wahlfrei. Wenn Sie dieses Element null festlegen, wird die vorherige Einstellung gelöscht.	Zeichenfolge
DestinationUrl	Die URL der Webseite, zu der der Benutzer gelangen soll, wenn er auf das Bild klickt. Die URL kann dynamische Textzeichenfolgen wie {Schlüsselwort (keyword)} enthalten. Weitere Informationen finden Sie unter Welche Nachverfolgungs- oder URL-Parameter kann ich verwenden?. Die URL darf maximal 1.024 Zeichen enthalten. Wenn die URL kein Protokoll angibt, verwendet das System das HTTP-Protokoll, wenn ein Benutzer auf die Anzeige klickt. Wenn die URL das HTTP-Protokoll angibt, wenn Sie eine Anzeige hinzufügen, entfernt der Dienst die http:// Protokollzeichenfolge (die HTTP-Protokollzeichenfolge zählt nicht auf den Grenzwert von 1.024 Zeichen); Der Dienst entfernt jedoch keine HTTPS-Protokollzeichenfolge (https://) aus der URL. Wenn die URL für die Bildanzeigenerweiterung nicht angegeben ist, wird die URL der Anzeige verwendet. Hinzufügen: Wahlfrei Aktualisieren: Wahlfrei. Wenn Sie dieses Element null festlegen, wird die vorherige Einstellung gelöscht.	Zeichenfolge
DisplayText	Der Anzeigetext Ihrer Bilderweiterung. Die maximale Länge für dieses Element beträgt 35 Zeichen. Hinzufügen: Erforderlich, wenn LayoutsSearchMultiple enthält, andernfalls Optional. Aktualisieren: Erforderlich, wenn LayoutsSearchMultiple enthält, andernfalls Optional. Wenn Sie dieses Element null festlegen, wird die vorherige Einstellung gelöscht.	Zeichenfolge
FinalAppUrls	Zur zukünftigen 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. – Sie dürfen FinalMobileUrls nicht angeben, wenn DevicePreference auf 30001 (mobil) festgelegt ist. Hinzufügen: Wahlfrei Aktualisieren: Wahlfrei. Wenn für das Update kein Wert festgelegt ist, wird die vorherige Einstellung entfernt.	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. – Sie dürfen FinalMobileUrls nicht angeben, wenn DevicePreference auf 30001 (mobil) festgelegt ist. Hinzufügen: Wahlfrei Aktualisieren: Wahlfrei. Wenn für das Update kein Wert festgelegt ist, wird die vorherige Einstellung entfernt.	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 die vorherige Einstellung entfernt.	Zeichenfolge
ImageMediaIds	Die Bezeichner der Bilder, die in die Anzeige aufgenommen werden sollen. Sie dürfen keine Medienbezeichner für mehr als ein Bild mit demselben Seitenverhältnis angeben. Anders ausgedrückt: Jedes der Bilder, auf die verwiesen wird, muss unterschiedliche Seitenverhältnisse aufweisen. Sie können bis zu vier (4) Bildmedienbezeichner angeben. Der mindeste erforderliche Wert ist eine Bildmedien-ID. Um sich für alle Anzeigenplatzierungen zu qualifizieren, müssen Sie vier Bildmedienbezeichner angeben, wobei jede ID einem Bild eines der vier unterstützten Medientypen (Seitenverhältnisse) entspricht. Die unterstützten Seitenverhältnisse für Zielgruppenanzeigen sind 16:9, 1,5:1, 4:3 und 1,2:1. Weitere Informationen finden Sie in der Referenzdokumentation zu Imagedatenobjekten. 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. Hinzufügen: Erforderlich Aktualisieren: Erforderlich	langes Array
Bilder	Bildressourcen mit unterschiedlichen Größen und Seitenverhältnissen, sodass sie flexibel über eine Vielzahl von Herausgebern und Platzierungen hinweg angezeigt werden können. Schließen Sie mindestens ein AssetLink-Objekt ein, das jeweils ein ImageAsset mit SubType und Zuschneideeinstellungen enthält, die dem gewünschten Seitenverhältnis entsprechen. Hinzufügen: Erforderlich Aktualisieren: Wahlfrei. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Wenn Sie während des Updates Images einschließen, werden alle zuvor festgelegten Images ersetzt.	AssetLink-Array
Layouts	Die Liste der geeigneten Bildlayouts. Unterstützte Werte sind SearchSingle und SearchMultiple. Möglicherweise werden in Zukunft neue Layouts hinzugefügt, sodass Sie keine Abhängigkeit von einem festen Satz von Werten annehmen sollten. Hinzufügen: Erforderlich Aktualisieren: Wahlfrei. Wenn für das Update kein Wert festgelegt ist, wird diese Einstellung nicht geändert. Wenn Sie layouts während der Aktualisierung einschließen, werden alle zuvor festgelegten Layouts ersetzt.	Zeichenfolgenarray
SourceType	Der Quelltyp.	Zeichenfolge
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 die vorherige Einstellung entfernt.	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 die vorherige Einstellung entfernt.	CustomParameters

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

Geerbte Elemente

Geerbte Elemente von AdExtension

Das ImageAdExtension-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 ImageAdExtension 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. Hinzufügen: Wahlfrei 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. 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 ImageAdExtension , wenn Sie eine Bildanzeigenerweiterung 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