Referenz zur Hotel-API

Hinweis

Diese Betaversion von HotelPreisanzeigen ist nur für ausgewählte Teilnehmer verfügbar. Informationen zur Teilnahme am Beta-Release-Programm finden Sie bei Ihrem Account Manager, oder registrieren Sie sich hier.

Api und Dokumentation können geändert werden.

Mit der Hotel-API können Sie Ihre Hotelanzeigenkampagnen und -angebote verwalten.

Endpunkte

Im Folgenden sehen Sie den Basis-URI, den Sie zum Erstellen des Endpunkts verwenden.

  • Produktion —https://partner.api.bingads.microsoft.com/Travel/v1/

Der Endpunkt muss die Kunden- und Kontoressourcen enthalten.

https://partner.api.sandbox.bingads.microsoft.com/Travel/V1/Customers({customerId})/Accounts({accountId})/

Legen Sie {customerId} auf die CustomerId des Kunden und {accountId} auf die CustomerAccountId des Kunden fest.

Fügen Sie als Nächstes eine Vorlage aus der folgenden Tabelle an, um Hotelressourcen hinzuzufügen, abzurufen und zu aktualisieren. Verwenden Sie beispielsweise den folgenden Endpunkt, um eine Hotelgruppe abzurufen oder hinzuzufügen:

https://partner.api.sandbox.bingads.microsoft.com/Travel/V1/Customers({customerId})/Accounts({accountId})/SubAccounts('{subAccountId}')/HotelGroups

Hinweis

Die IDs für SubAccounts, HotelGroups, Hotels und ReportJobs sind Zeichenfolgen und müssen in einfache Anführungszeichen eingeschlossen werden. Beispiel: SubAccounts('12345')/HotelGroups. Dies gilt nur für SubAccounts, HotelGroups, Hotels und ReportJobs; verwenden Sie keine einfachen Anführungszeichen für Kunden und Konten.

Vorlage "SubAccounts"

Verb Beschreibung
ERHALTEN Ruft die Liste der Unterkunftskampagnen (ehemals Hotelkampagnen) ab, die für das angegebene Konto definiert wurden.

HINWEIS: Standardmäßig enthält die Liste maximal 1.000 Kampagnen. Verwenden Sie den Abfrageparameter $count , um die Gesamtanzahl der Kampagnen im Unterkonto zu ermitteln. Verwenden Sie den Abfrageparameter $top , um die Anzahl der zurückzugebenden Kampagnen anzugeben. Um alle Kampagnen in einem Unterkonto zu durchlaufen, verwenden Sie die Abfrageparameter $top und $skip .

Antworttext: Enthält ein CollectionResponse-Objekt . Das value Feld enthält die Liste der SubAccount-Objekte .
BEREITSTELLEN Fügt das Unterkonto dem angegebenen Konto hinzu. Sie können sich Unterkonten als Unterkunftskampagnen vorstellen. Verwenden Sie Unterkonten, um Ihre Hotelanzeigenkampagnen logisch zu organisieren. Pro Konto können maximal 50 aktive Unterkunftskampagnen durchgeführt werden.

Anforderungstext: Enthält das hinzuzufügende SubAccount .

Antworttext: Enthält bei erfolgreicher Ausführung ein AddResponse-Objekt . Das value Feld enthält die ID der hinzugefügten Unterkunftskampagne.

SubAccounts('{subAccountId}')-Vorlage

Verb Beschreibung
ERHALTEN Ruft das angegebene Unterkonto ab.

Antworttext: Enthält ein SubAccount-Objekt .

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des abzurufenden Unterkontos fest.
PATCH Updates das Unterkonto.

Anforderungstext: Enthält ein SubAccount-Objekt , das nur die zu aktualisierenden Felder angibt.

Antworttext: Keine. Bei erfolgreicher Ausführung wird HTTP-status Code 204 zurückgegeben.

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des zu aktualisierenden Unterkontos fest.

SubAccounts('{subAccountId}')/HotelGroups-Vorlage

Verb Beschreibung
ERHALTEN Ruft die Liste der Hotelgruppen im angegebenen Unterkonto ab.

HINWEIS: Standardmäßig enthält die Liste maximal 1.000 Hotelgruppen. Verwenden Sie den Abfrageparameter $count , um die Gesamtzahl der Gruppen im Unterkonto zu ermitteln. Verwenden Sie den Abfrageparameter $top , um die Anzahl der zurückzugebenden Gruppen anzugeben. Verwenden Sie zum Durchlaufen aller Gruppen in einem Unterkonto die Abfrageparameter $top und $skip .

Antworttext: Enthält ein CollectionResponse-Objekt . Das value Feld enthält die Liste der HotelGroup-Objekte .

Vorlagenparameter:
  • {subAccountId}– Legt auf die ID des Unterkontos fest, das die abzurufenden Hotelgruppen enthält.
BEREITSTELLEN Fügt die Hotelgruppe dem angegebenen Unterkonto hinzu. Verwenden Sie Hotelgruppen, um logische Gruppierungen von Hotelpreisanzeigen zu erstellen. Sie können bis zu 1.000 aktive Hotelgruppen pro Unterkonto erstellen.

Anforderungstext: Enthält die HotelGroup , die dem Unterkonto hinzugefügt werden soll.

Antworttext: Enthält bei erfolgreicher Ausführung ein AddResponse-Objekt . Das value Feld enthält die ID der hinzugefügten Hotelgruppe.

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des Unterkontos fest, dem die Hotelgruppe hinzugefügt werden soll.

SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')-Vorlage

Verb Beschreibung
ERHALTEN Ruft die angegebene Hotelgruppe ab.

Antworttext: Enthält ein HotelGroup-Objekt .

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des Unterkontos fest, das die Hotelgruppe enthält.
  • {hotelGroupId}– Legen Sie auf die ID der abzurufenden Hotelgruppe fest.
PATCH Updates die Hotelgruppe.

Anforderungstext: Enthält ein HotelGroup-Objekt , das nur die zu aktualisierenden Felder angibt.

Antworttext: Keine. Bei erfolgreicher Ausführung wird HTTP-status Code 204 zurückgegeben.

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des Unterkontos fest, das die Hotelgruppe enthält.
  • {hotelGroupId}– Legen Sie auf die ID der zu aktualisierenden Hotelgruppe fest.
LÖSCHEN Löscht die Hotelgruppe.

Anforderungstext: Keine.

Antworttext: Keine. Bei erfolgreicher Ausführung wird HTTP-status Code 204 zurückgegeben.

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des Unterkontos fest, das die Hotelgruppe enthält.
  • {hotelGroupId}– Legen Sie auf die ID der zu löschenden Hotelgruppe fest.

SubAccounts('{subAccountId}')/Hotels-Vorlage

Verb Beschreibung
ERHALTEN Ruft die Liste der Hotelpreisanzeigen im angegebenen Unterkonto ab. Die Liste enthält alle Hotels in allen Hotelgruppen im Unterkonto.

HINWEIS: Standardmäßig enthält die Liste maximal 1.000 Hotels. Verwenden Sie den Abfrageparameter $count , um die Gesamtzahl der Hotels im Unterkonto zu ermitteln. Verwenden Sie den Abfrageparameter $top , um die Anzahl der zurückzugebenden Hotels anzugeben. Um alle Hotels in einem Unterkonto zu durchlaufen, verwenden Sie die Abfrageparameter $top und $skip .

HINWEIS: Verwenden Sie diesen Aufruf, um hotels nur in einer Benutzeroberfläche zu durchlaufen. Verwenden Sie diesen Aufruf nicht, um alle Hotels herunterzuladen. Um alle Hotels herunterzuladen, verwenden Sie stattdessen die Berichterstellungsfunktion .

Antworttext: Enthält ein CollectionResponse-Objekt . Das value Feld enthält die Liste der Hotel-Objekte .

Vorlagenparameter:
  • {subAccountId}– Legt auf die ID des Unterkontos fest, das die abzurufenden Hotels enthält.
.

SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')/Hotels-Vorlage

Verb Beschreibung
ERHALTEN Ruft die Liste der Hotelpreisanzeigen in der angegebenen Hotelgruppe ab.

HINWEIS: Standardmäßig enthält die Liste maximal 1.000 Hotels. Verwenden Sie den Abfrageparameter $count , um die Gesamtzahl der Hotels in der Hotelgruppe zu ermitteln. Verwenden Sie den Abfrageparameter $top , um die Anzahl der zurückzugebenden Hotels anzugeben. Um alle Hotels in einer Gruppe zu durchlaufen, verwenden Sie die Abfrageparameter $top und $skip .

HINWEIS: Verwenden Sie diesen Aufruf, um hotels nur in einer Benutzeroberfläche zu durchlaufen. Verwenden Sie diesen Aufruf nicht, um alle Hotels herunterzuladen. Um alle Hotels herunterzuladen, verwenden Sie stattdessen die Berichterstellungsfunktion .

Antworttext: Enthält ein CollectionResponse-Objekt . Das value Feld enthält die Liste der Hotel-Objekte .

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des Unterkontos fest, das die Hotelgruppe enthält.
  • {hotelGroupId}– Legen Sie auf die ID der Hotelgruppe fest, die die abzurufenden Hotels enthält.
.

SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')/Hotels('{hotelId}')-Vorlage

Verb Beschreibung
ERHALTEN Ruft die angegebene Hotelanzeige ab.

Antworttext: Enthält ein Hotel-Objekt .

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des Unterkontos fest, das die Hotelgruppe enthält.
  • {hotelGroupId}– Legen Sie auf die ID der Hotelgruppe fest, die das abzurufende Hotel enthält.
  • {hotelId}– Legen Sie auf die zu erhaltende Hotelanzeige fest.
PATCH Updates die Hotelanzeige.

Anforderungstext: Enthält ein Hotel-Objekt , das nur die zu aktualisierenden Felder angibt.

Antworttext: Keine. Bei erfolgreicher Ausführung wird HTTP-status Code 204 zurückgegeben.

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des Unterkontos fest, das die Hotelgruppe enthält.
  • {hotelGroupId}– Legen Sie auf die ID der Hotelgruppe fest, die das zu aktualisierende Hotel enthält.
  • {hotelId}– Legen Sie auf die ID des zu aktualisierenden Hotels fest. Sie können diesen Parameter auf die ID festlegen, die Microsoft dem Hotel zugewiesen hat, oder auf die ID, die der Werbetreibende dem Hotel zugewiesen hat. Wenn Sie es auf die ID des Inserenten festlegen, müssen Sie den PartnerHotelId Abfrageparameter auf true festlegen.
Abfrageparameter:
  • PartnerHotelId– Auf TRUE festgelegt, wenn der {hotelId} Ressourcenparameter die ID enthält, die der Inserent dem Hotel zugewiesen hat. Wenn dieser Parameter auf false festgelegt ist oder fehlt, ist die ID die von Microsoft zugewiesene ID. Der Standardwert ist false.

SubAccounts('{subAccountId}')/Nicht gruppierte Vorlage

Verb Beschreibung
ERHALTEN Ruft die Liste der Hotels in der Hotelgruppe Ohne Gruppierung ab. Wenn Sie ein Unterkonto erstellen, erstellt der Dienst die Nicht gruppierte Hotelgruppe. Alle Hotels aus Ihrem Hotelfeed, die anderen Gruppen nicht zugeordnet sind, werden in dieser Gruppe platziert. Informationen zum Zuordnen eines Hotels in dieser Gruppe zu einer anderen Hotelgruppe finden Sie in der Vorlage Zuordnen .

HINWEIS: Standardmäßig enthält die Liste maximal 1.000 Hotels. Verwenden Sie den Abfrageparameter $count , um die Gesamtzahl der Hotels in der Gruppe Nicht gruppierte Hotels zu ermitteln. Verwenden Sie den Abfrageparameter $top , um die Anzahl der zurückzugebenden Hotels anzugeben. Um alle Hotels in der Gruppe zu durchlaufen, verwenden Sie die Abfrageparameter $top und $skip .

HINWEIS: Verwenden Sie diesen Aufruf, um hotels nur in einer Benutzeroberfläche zu durchlaufen. Verwenden Sie diesen Aufruf nicht, um alle Hotels herunterzuladen. Um alle Hotels herunterzuladen, verwenden Sie stattdessen die Berichterstellungsfunktion .

Antworttext: Enthält ein CollectionResponse-Objekt . Das value Feld enthält die Liste der Hotel-Objekte .

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des Unterkontos fest, das die nicht gruppierten Hotelpreisanzeigen enthält, die abgerufen werden sollen.

SubAccounts('{subAccountId}')/Zuordnungsvorlage

Verb Beschreibung
ERHALTEN Ruft eine Liste der Hotel- und Hotelgruppenzuordnungen ab.

HINWEIS: Standardmäßig enthält die Liste maximal 1.000 Zuordnungen. Verwenden Sie den Abfrageparameter $count , um die Gesamtzahl der Zuordnungen im Unterkonto zu ermitteln. Verwenden Sie den Abfrageparameter $top , um die Anzahl der zurückzugebenden Zuordnungen anzugeben. Um alle Zuordnungen in einem Unterkonto zu durchlaufen, verwenden Sie die Abfrageparameter $top und $skip .

Antworttext: Enthält ein CollectionResponse-Objekt . Das value Feld enthält die Liste der HotelAssociation-Objekte .

Vorlagenparameter:
  • {subAccountId}– Legt auf die ID des Unterkontos fest, das die abzurufenden Zuordnungen enthält.

SubAccounts('{subAccountId}')/Vorlage zuordnen

Verb Beschreibung
BEREITSTELLEN Fügt dem Unterkonto eine Liste von Hotel- und Hotelgruppenzuordnungen hinzu.

Anforderungstext: Enthält ein AssociationCollection-Objekt . Das HotelAssociation Feld enthält eine Liste mit maximal 500 HotelAssociation-Objekten . Jedes Objekt ordnet ein Hotel einer Hotelgruppe zu.

Sie dürfen ein Hotel nur einer Hotelgruppe zuordnen. Standardmäßig sind Hotels der Gruppe Nicht gruppierte Hotels zugeordnet. Verwenden Sie diese Vorlage, um ein Hotel einer neuen Hotelgruppe zuzuordnen. Wenn Sie ein Hotel einer neuen Hotelgruppe zuordnen, entfernt der Dienst die vorherige Zuordnung.

Antworttext: Enthält ein CollectionResponse-Objekt . Das value Feld enthält eine Liste von HotelAssociation-Objekten . Die Liste enthält nur die Zuordnungen, bei denen die Überprüfung fehlgeschlagen ist. Die Liste ist leer, wenn keine Fehler vorliegen. Das Feld der Errors Zuordnung enthält die Liste der Gründe, warum die Zuordnung fehlgeschlagen ist.

Vorlagenparameter:
  • {subAccountId}– Legen Sie auf die ID des Unterkontos fest, dem die Zuordnungen hinzugefügt werden sollen.

ReportJobs-Vorlage

Verb Beschreibung
BEREITSTELLEN Fügt der Berichtswarteschlange eine Berichtsanforderung hinzu.

Anforderungstext: Enthält das ReportJob-Objekt , das die Berichtsanforderung definiert, die Sie der Warteschlange hinzufügen.

Antworttext: Wenn die Berichtsanforderung erfolgreich zur Warteschlange hinzugefügt wurde, ist der Textkörper ein AddResponse-Objekt , das die ID des Berichtsauftrags enthält. Verwenden Sie die ID in nachfolgenden GET-Anforderungen, um die status des Berichtsauftrags abzurufen (siehe Vorlage ReportJobs('{jobId}').

ReportJobs('{jobId}')

Verb Beschreibung
ERHALTEN Ruft die status des angegebenen Berichtsauftrags ab.

Antworttext: Enthält ein ReportJob-Objekt . Verwenden Sie das Status Feld, um zu bestimmen, wann der Auftrag abgeschlossen ist. Wenn der Auftrag abgeschlossen ist, verwenden Sie die URL im Url Feld, um den Bericht herunterzuladen.

Vorlagenparameter:
  • {jobId}– Die ID des Berichtsauftrags, von dem die status abgerufen werden soll. Legen Sie auf die ID des Berichtsauftrags fest, den Ihre POST-Anforderung zurückgegeben hat.

$batch-Vorlage

Verb Beschreibung
BEREITSTELLEN Sendet eine Batchanforderung, die maximal 500 Anforderungen enthalten kann. Weitere Informationen

Anforderungstext: Enthält eine Zeichenfolge der einzelnen Anforderungen.

Antworttext: Enthält eine Zeichenfolge der entsprechenden Antworten.

Abfrageparameter

Im Folgenden sind die Abfrageparameter aufgeführt, die von der Anforderung angegeben werden können.

Parameter Beschreibung
$count Ein OData-Parameter, der bestimmt, ob die Antwort ein @odata.count Feld enthält. In der Regel fügen Sie diesen Parameter ein, wenn Sie eine Liste von Entitäten anfordern, z. B. eine Liste von Hotelgruppen. Das @odata.count Feld enthält die Gesamtzahl der verfügbaren Ressourcenentitäten, nicht derjenigen, die in der Anforderung zurückgegeben werden. Wenn Sie beispielsweise $top auf 40 festlegen, aber 1.000 Entitäten vorhanden sind, @odata.count wird auf 1.000 und nicht auf 40 festgelegt. Um die Anzahl einzuschließen, legen Sie $count auf true fest.
$filter Ein OData-Parameter, der eine Liste von Ausdrücken angibt, die zum Filtern der Daten verwendet werden.

HINWEIS: Sie können den parameter $filter nur mit der /Associations-Ressource verwenden. Weitere Informationen finden Sie unter Filtern von Hotelzuordnungen.
$select Ein OData-Parameter, der eine durch Trennzeichen getrennte Liste der Felder angibt, die in die Antwort eingeschlossen werden sollen. Bei den Feldnamen wird die Groß-/Kleinschreibung beachtet. Geben Sie beispielsweise den folgenden Parameter an, um den Namen, die Partner-ID und die Gebotsfelder des Hotels in die Antwort einzuschließen:

$select=Name,PartnerHotelId,Bid
$skip Ein OData-Parameter, der die Anzahl der Zu überspringenden Ressourcenentitäten angibt, bevor Entitäten zurückgegeben werden. Der $skip Wert muss ein Vielfaches von $top sein. Wenn Sie einen Wert angeben, der außerhalb des zulässigen Bereichs liegt, enthält die Antwort einen leeren Satz. Verwenden Sie $top und $skip, um eine Liste von Ressourcenentitäten zu durchsuchen.
$top Ein OData-Parameter, der die Anzahl der zurückzugebenden Ressourcenentitäten angibt. Der Standardwert ist 1.000, und der Maximalwert, den Sie angeben können, ist 5.000. Verwenden Sie $top und $skip, um eine Liste von Ressourcenentitäten zu durchsuchen.

Header

Im Folgenden sind die Anforderungs- und Antwortheader aufgeführt.

Header Beschreibung
Autorisierung Anforderungsheader.

Legen Sie diesen Header auf ein OAuth-Bearer-Zugriffstoken fest. Beispiel: "Authorization: Bearer QTkxRUFBRjEzOTUyNEIx...". Informationen zum Abrufen eines Tokens finden Sie unter Erste Schritte.
Content-Type Anforderungs- und Antwortheader.

Der Inhaltstyp im Textkörper der Anforderung oder Antwort. Legen Sie für POST und PATCH diesen Header auf fest application/json.
X-MS-RequestId Antwortheader.

Die ID des Protokolleintrags, der die Details der Anforderung enthält. Sie sollten diese ID immer erfassen, wenn ein Fehler auftritt. Wenn Sie das Problem nicht ermitteln und beheben können, geben Sie diese ID zusammen mit den anderen Informationen an, die Sie dem Supportteam zur Verfügung stellen.

Hinweis

Diese API unterstützt die Verwendung von OAuth-Zugriffstoken nur für die Authentifizierung (siehe Autorisierungsheader). Sie dürfen die Header UserName und Password nicht verwenden, um Legacyanmeldeinformationen anzugeben.

Für diese API ist kein Entwicklertoken erforderlich. Wenn Sie den DeveloperToken-Header einschließen, ignoriert die API ihn.

Ressourcenobjekte

Im Folgenden sind die von der API verwendeten Ressourcenobjekte aufgeführt.

Objekt Beschreibung
Addresponse Definiert ein Antwortobjekt für Anforderungen, die eine Ressource hinzufügen.
AdsApiError Definiert einen aufgetretenen Fehler.
AdvanceBookingWindowMultiplier Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer die angegebene Anzahl von Tagen im Voraus bucht.
AssociationCollection Definiert eine Auflistung von Hotelzuordnungen.
Budget Definiert das Tagesbudget für Hotelpreisanzeigen in einem Unterkonto.
CollectionResponse Definiert ein Antwortobjekt für Anforderungen, die eine Liste von Ressourcen abrufen.
CheckinDayOfWeekMultiplier Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer an einem der angegebenen Wochentage eincheckt.
DateTypeMultiplier Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer nach Hotels mit bestimmten Datumsangaben gesucht hat.
DeviceMultiplier Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer eines der angegebenen Geräte verwendet, um nach Hotels zu suchen.
FixedBid Definiert einen festen Gebotsbetrag.
Hotel Definiert eine Hotelanzeige.
HotelAssociation Definiert die Zuordnung zwischen einem Hotel und einer Hotelgruppe.
HotelGroup Definiert eine logische Gruppierung von Hotelpreisanzeigen.
LengthOfStayMultiplier Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer die angegebene Anzahl von Nächten oder länger bleibt.
PercentageBid Definiert ein Gebot basierend auf dem Prozentsatz des Zimmertarifs pro Nacht.
ReportJob Definiert einen Berichtsauftrag.
SiteMultiplier Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer nach Hotels auf einer der angegebenen Bing-Websites sucht.
SubAccount Definiert die Gruppierung von Hotelpreisanzeigen auf oberster Ebene. Sie können sich dies logisch als eine Unterkunftskampagne vorstellen.
UserCountryMultiplier Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer auf eine der Bing-Domänen zugreift.

Hinweis

Die Antwortobjekte enthalten ein Kontextfeld. Da dieses Feld in Zukunft unterdrückt werden kann oder sich das Modell ändern kann, sollten Sie keine Abhängigkeit davon übernehmen. Eine Abhängigkeit von diesem Feld kann ihren Code in Zukunft beeinträchtigen.

Addresponse

Definiert ein Antwortobjekt für Anforderungen, die eine Ressource hinzufügen.

Name Wert Typ
Wert Die ID der Ressource, die Sie hinzugefügt haben. Objekt

AdsApiError

Definiert einen aufgetretenen Fehler.

Name Wert Typ
Code Ein symbolischer Code, der den Fehler identifiziert. Eine Liste der Codes finden Sie unter Fehlercodes. Zeichenfolge
Nachricht Eine Beschreibung des Fehlers. Zeichenfolge
Parameter Der Name des Objekts, Felds oder Parameters, das den Fehler verursacht hat. Zeichenfolge

AdvanceBookingWindowMultiplier

Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer die angegebene Anzahl von Tagen im Voraus bucht.

Name Wert Typ Hinzufügen Aktualisieren
Faktor Der Prozentsatz, um den das Basisgebot angepasst werden soll. Der gültige Bereich ist 0,00 bis 11,00. Wenn das feste Gebot beispielsweise 5 USD und der Multiplikator 5 ist, beträgt das endgültige Gebot 25 USD. Wenn das Gebot in Prozent 5 % beträgt und der Raumpreis insgesamt 100 USD beträgt, beträgt das endgültige Gebot 25 USD. Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional
MinimumNumberOfDays Die Mindestanzahl von Tagen im Voraus der Buchung. Wenden Sie den Multiplikator an, wenn die Buchung im Voraus die angegebene Anzahl von Tagen oder länger erfolgt. Ganze Zahl Erforderlich Optional
@odata.type Der Typ des Objekts. Dieses Feld ist auf "#Model.AdvanceBookingWindowMultiplier" festgelegt. Zeichenfolge Erforderlich Erforderlich

AssociationCollection

Definiert eine Auflistung von Hotelzuordnungen.

Name Wert Typ Hinzufügen Aktualisieren
HotelAssociations Die Liste der Hotel- und Hotelgruppenverbände. Die Liste darf maximal 500 Zuordnungen enthalten. HotelAssociation[] Erforderlich Nicht zutreffend

Gebot

Definiert die Basisklasse für ein Gebot.

Geben Sie diese Klasse nicht an, sondern stattdessen die FixedBid - oder PercentageBid-Klasse .

Name Wert Typ Ergänzungen Aktualisieren
Betrag Der Gebotsbetrag in Dollar. Ausführliche Informationen zum gültigen Gebotsbereich für Ihren Markt finden Sie in der Tabelle Währungswert im Thema Währungen . Das Konto des Kunden gibt die verwendete Währung an. Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional

Budget

Definiert das Tagesbudget für Hotelpreisanzeigen in einem Unterkonto.

Name Wert Typ Ergänzungen Aktualisieren
Betrag Der Tagesbudgetbetrag. Ausführliche Informationen zu gültigen Budgets für Ihren Markt finden Sie in der Tabelle Währungswert im Thema Währungen . Das Konto des Kunden gibt die Währung an, die für das Budget verwendet wird. Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional

CheckinDayOfWeekMultiplier

Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer an einem der angegebenen Wochentage eincheckt.

Name Wert Typ Hinzufügen Aktualisieren
DaysOfWeek Eine Liste der Wochentage. Wenden Sie den Multiplikator an, wenn der Benutzer an einem der angegebenen Tage überprüft. Im Folgenden sind die möglichen Werte aufgeführt, bei denen die Groß-/Kleinschreibung beachtet wird.

  • Montag
  • Dienstag
  • Mittwoch
  • Donnerstag
  • Freitag
  • Samstag
  • Sonntag
String[] Erforderlich Optional
Faktor Der Prozentsatz, um den das Basisgebot angepasst werden soll. Der gültige Bereich ist 0,00 bis 10,00. Wenn das feste Gebot beispielsweise 5 USD und der Multiplikator 5 ist, beträgt das endgültige Gebot 25 USD. Wenn das Gebot in Prozent 5 % beträgt und der Raumpreis insgesamt 100 USD beträgt, beträgt das endgültige Gebot 25 USD. Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional
@odata.type Der Typ des Objekts. Dieses Feld ist auf "#Model.CheckinDayOfWeekMultiplier" festgelegt. Zeichenfolge Erforderlich Erforderlich

CollectionResponse

Definiert ein Antwortobjekt für Anforderungen, die eine Liste von Ressourcen abrufen.

Name Wert Typ
Wert Die Liste der angeforderten Ressourcen. Je nach Anforderung enthält die Liste einen der folgenden Objekttypen:Wenn Sie beispielsweise eine Liste von Hotelgruppen anfordern, value enthält eine Liste von HotelGroup -Objekten. object[]
@odata.count Die Gesamtzahl der verfügbaren Ressourcenentitäten, nicht die Anzahl der Entitäten in Value. Die Antwort enthält dieses Feld nur, wenn Sie den abfrageparameter $count in die Anforderung einschließen.

DateTypeMultiplier

Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer nach Hotels mit bestimmten Datumsangaben gesucht hat.

Name Wert Typ Hinzufügen Aktualisieren
Datetype.fromstring Der Bei der Suche verwendete Datumstyp. Im Folgenden sind die möglichen Werte aufgeführt, bei denen die Groß-/Kleinschreibung beachtet wird.

  • Standard: Der Benutzer hat nicht nach Hotels mit bestimmten Datumsangaben gesucht.
  • Ausgewählt: Der Benutzer hat nach Hotels mit bestimmten Datumsangaben gesucht.
String[] Erforderlich Optional
Faktor Der Prozentsatz, um den das Basisgebot angepasst werden soll. Der gültige Bereich ist 0,00 bis 10,00. Wenn das feste Gebot beispielsweise 5 USD und der Multiplikator 5 ist, beträgt das endgültige Gebot 25 USD. Wenn das Gebot in Prozent 5 % beträgt und der Raumpreis insgesamt 100 USD beträgt, beträgt das endgültige Gebot 25 USD. Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional
@odata.type Der Typ des Objekts. Dieses Feld ist auf "#Model.DateTypeMultiplier" festgelegt. Zeichenfolge Erforderlich Erforderlich

DeviceMultiplier

Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer eines der angegebenen Geräte verwendet, um nach Hotels zu suchen.

Name Wert Typ Ergänzungen Aktualisieren
DeviceTypes Eine Liste der Gerätetypen. Wenden Sie den Multiplikator an, wenn der Benutzer den Gerätetyp verwendet, um nach Hotels zu suchen. Im Folgenden sind die möglichen Werte aufgeführt, bei denen die Groß-/Kleinschreibung beachtet wird.

  • Desktop
  • Mobilgeräte
  • Tablet
String[] Erforderlich Optional
Faktor Der Prozentsatz, um den das Basisgebot angepasst werden soll. Der gültige Bereich ist 0,00 bis 10,00. Wenn das feste Gebot beispielsweise 5 USD und der Multiplikator 5 ist, beträgt das endgültige Gebot 25 USD. Wenn das Gebot in Prozent 5 % beträgt und der Raumpreis insgesamt 100 USD beträgt, beträgt das endgültige Gebot 25 USD. Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional
@odata.type Der Typ des Objekts. Dieses Feld ist auf "#Model.DeviceMultiplier" festgelegt. Zeichenfolge Erforderlich Erforderlich

FixedBid

Definiert einen festen Gebotsbetrag.

Name Wert Typ Hinzufügen Aktualisieren
Betrag Der feste Gebotsbetrag in Dollar. Ausführliche Informationen zum gültigen Gebotsbereich für Ihren Markt finden Sie in der Tabelle Währungswert im Thema Währungen . Das Konto des Kunden gibt die verwendete Währung an.

Der Gebotsbetrag ist das Gebot pro Nacht. Wenn das Gebot beispielsweise 3,50 USD beträgt und die Reiseroute für einen 3-Nächte-Aufenthalt gilt, beträgt das endgültige Gebot 10,50 USD.
Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional
@odata.type Der Typ des Objekts. Dieses Feld ist auf "#Model.FixedBid" festgelegt. Zeichenfolge Erforderlich Erforderlich

Hotel

Definiert eine Hotelanzeige.

Name Wert Typ Ergänzungen Aktualisieren
Gebot Das Basisgebot. Microsoft verwendet dieses Gebot in der Auktion, es sei denn, Sie geben einen oder mehrere Multiplikatoren an (siehe BidMultipliers). Wenn Sie kein Gebot angeben, erbt das Hotel das Gebot von der Hotelgruppe oder dem Unterkonto in dieser Reihenfolge. Wenn das Hotel beim Abrufen eines Hotels kein Gebot angibt, enthält dieses Feld das geerbte Gebot.

Im Folgenden sind die Typen von Geboten aufgeführt, die Sie angeben können.Um das Hotel anzuhalten, geben Sie ein Prozentuales Gebot an, und legen Sie den Gebotsbetrag auf Null (0) fest.

Um das Gebot des Hotels zu entfernen, legen Sie auf NULL fest Bid .
Objekt Nicht zutreffend Optional
BidMultipliers Eine Liste der Multiplikatoren, die auf das Basisgebot angewendet werden sollen. Microsoft wendet die Multiplikatoren auf das Basisgebot an und verwendet das angepasste Gebot in der Auktion. Wenn das Hotel kein Gebot angibt, passen die Multiplikatoren das geerbte Gebot an.

Wenn Sie keine Multiplikatoren angeben, erbt das Hotel diese von der Hotelgruppe oder dem Unterkonto in dieser Reihenfolge. Wenn das Hotel beim Abrufen eines Hotels keine Multiplikatoren angibt, enthält dieses Feld die geerbten Multiplikatoren.

Wenn das Hotel Multiplikatoren angibt und Sie sie entfernen möchten, legen Sie auf ein leeres Array fest BidMultipliers .

Im Folgenden sind die Typen von Multiplikatoren aufgeführt, die Sie angeben können.
object[] Nicht zutreffend Optional
BidMultiplierSource Die Quelle der Gebotsmultiplikatoren. Im Folgenden sind die möglichen Werte aufgeführt.
  • SubAccount
  • HotelGroup
  • Hotel
Wenn das Hotel und die Hotelgruppe beispielsweise keine Multiplikatoren angegeben haben, erbt das Hotel die Multiplikatoren vom Unterkonto. In diesem Fall ist dieses Feld auf SubAccount festgelegt.
Zeichenfolge Nicht zutreffend Schreibgeschützt
BidSource Die Quelle des Gebots. Im Folgenden sind die möglichen Werte aufgeführt.
  • SubAccount
  • HotelGroup
  • Hotel
Wenn das Hotel beispielsweise ein Gebot angibt, wird dieses Feld auf Hotel festgelegt.
Zeichenfolge Nicht zutreffend Schreibgeschützt
CountryCode Der zweistellige ISO 3116-Kreiscode des Landes, in dem sich das Hotel befindet. Das Land ist dasselbe Land, das Sie für das Hotel in Ihrer Hotelfeeddatei angegeben haben. Zeichenfolge Schreibgeschützt Schreibgeschützt
Id Eine vom System generierte ID, die das Hotel eindeutig identifiziert. Zeichenfolge Nicht zutreffend Erforderlich
Name Der Name des Hotels. Der Name entspricht dem Namen, den Sie in Ihrer Hotelfeeddatei angegeben haben. Zeichenfolge Nicht zutreffend Schreibgeschützt
PartnerHotelId Die ID, die Sie zum Identifizieren des Hotels in der Datei "Hotelfeeds" verwendet haben. Zeichenfolge Nicht zutreffend Schreibgeschützt
Status Die status des Hotelunternehmens. Im Folgenden sind die möglichen Werte aufgeführt.
  • Aktiv: Das Hotel wird nicht gelöscht und kann aktualisiert werden.
  • Gelöscht: Der Benutzer hat das Hotel gelöscht. Benutzer können Hotels nur über die Benutzeroberfläche löschen.
Zeichenfolge Nicht zutreffend Schreibgeschützt

HotelAssociation

Definiert die Zuordnung zwischen einem Hotel und einer Hotelgruppe.

Die Spalte Update enthält N/V-Werte, da es keinen HTTP-Updatevorgang gibt. Um die Zuordnung eines Hotels zu aktualisieren, verwenden Sie einen Vorgang zum Hinzufügen (POST). Weitere Informationen finden Sie in der Vorlage Zuordnen .

Name Wert Typ Hinzufügen Aktualisieren
Fehler Die Liste der Gründe, warum die Zuordnung nicht überprüft wurde.

Die Antwort enthält dieses Feld nur, wenn bei der Zuordnung beim Hinzufügen der Zuordnung ein Fehler aufgetreten ist.
AdsApiError Schreibgeschützt Nicht zutreffend
HotelGroupId Die ID der Hotelgruppe, der das Hotel zugeordnet werden soll. Zeichenfolge Erforderlich Nicht zutreffend
HotelGroupName Der Name der Hotelgruppe. Zeichenfolge Schreibgeschützt Nicht zutreffend
HotelId Die ID des Hotels, das der angegebenen Hotelgruppe zugeordnet werden soll (siehe HotelGroupId). Sie können das Hotel nur einer Hotelgruppe zuordnen.

Standardmäßig werden alle Hotels einer Hotelgruppe zugeordnet, unabhängig davon, ob es sich um eine benutzerdefinierte Gruppe oder um die Standardmäßige Nicht gruppierte Hotelgruppe handelt. Um ein Hotel von einer Gruppe in eine andere zu verschieben, posten Sie eine neue Zuordnung, die die Hotel-ID und die neue Hotelgruppen-ID angibt. Der Dienst entfernt die vorherige Zuordnung.
Zeichenfolge Erforderlich Nicht zutreffend
HotelName Der Name des Hotels. Zeichenfolge Schreibgeschützt Nicht zutreffend
PartnerHotelId Die ID, die Sie zum Angeben des Hotels in der Datei "Hotelfeeds" verwendet haben. Zeichenfolge Schreibgeschützt Nicht zutreffend

HotelGroup

Definiert eine logische Gruppierung von Hotels.

Name Wert Typ Hinzufügen Aktualisieren
Gebot Das Basisgebot, das Hotels in der Gruppe erben, wenn sie kein Gebot angeben. Informationen zur Verwendung finden Sie Bid im Hotel-Objekt .

Wenn Sie kein Gebot angeben, erbt die Gruppe das Gebot vom Unterkonto. Wenn die Gruppe beim Abrufen einer Hotelgruppe kein Gebot angibt, enthält dieses Feld das geerbte Gebot.

Im Folgenden sind die Typen von Geboten aufgeführt, die Sie angeben können.Um alle Hotels in der Gruppe anzuhalten, geben Sie ein Prozentuales Gebot an, und legen Sie den Gebotsbetrag auf Null (0) fest.

Um das Gebot der Gruppe zu entfernen, legen Sie auf NULL fest Bid .
Objekt Optional Optional
BidMultipliers Eine Liste der Multiplikatoren, die Hotels in der Gruppe erben, wenn sie keine Multiplikatoren angeben. Informationen zur Verwendung finden Sie BidMultipliers im Hotel-Objekt .

Wenn Sie keine Multiplikatoren angeben, erbt die Gruppe diese vom Unterkonto.

Wenn die Hotelgruppe Multiplikatoren angibt und Sie sie entfernen möchten, legen Sie auf ein leeres Array fest BidMultipliers .

Im Folgenden sind die Typen von Multiplikatoren aufgeführt, die Sie angeben können.
object[] Optional Optional
BidMultiplierSource Die Quelle der Gebotsmultiplikatoren. Im Folgenden sind die möglichen Werte aufgeführt.
  • SubAccount
  • HotelGroup
Wenn die Hotelgruppe beispielsweise keine Multiplikatoren angegeben hat, erbt die Hotelgruppe die Multiplikatoren vom Unterkonto. In diesem Fall ist dieses Feld auf SubAccount festgelegt.
Zeichenfolge Schreibgeschützt Schreibgeschützt
BidSource Die Quelle des Gebots. Im Folgenden sind die möglichen Werte aufgeführt.
  • SubAccount
  • HotelGroup
Wenn die Hotelgruppe beispielsweise Multiplikatoren angibt, wird dieses Feld auf HotelGroup festgelegt.
Zeichenfolge Schreibgeschützt Schreibgeschützt
HotelAssociationCount Die Anzahl der Hotels, die der Hotelgruppe zugeordnet sind. Unsigned Integer Schreibgeschützt Schreibgeschützt
Id Eine vom System generierte ID, die die Gruppe eindeutig identifiziert. Zeichenfolge Schreibgeschützt Erforderlich
Name Der Name der Gruppe. Der Name darf maximal 256 Zeichen enthalten. Zeichenfolge Erforderlich Schreibgeschützt
Status Die status der Hotelgruppenentität. Im Folgenden sind die möglichen Werte aufgeführt.
  • Aktiv: Die Hotelgruppe wird nicht gelöscht und kann aktualisiert werden.
  • Gelöscht: Der Benutzer hat die Hotelgruppe gelöscht. Benutzer können Hotelgruppen nur über die Benutzeroberfläche löschen.
Zeichenfolge Schreibgeschützt Schreibgeschützt

LengthOfStayMultiplier

Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer die angegebene Anzahl von Nächten oder länger bleibt.

Name Wert Typ Hinzufügen Aktualisieren
Faktor Der Prozentsatz, um den das Basisgebot angepasst werden soll. Der gültige Bereich ist 0,00 bis 10,00. Wenn das feste Gebot beispielsweise 5 USD und der Multiplikator 5 ist, beträgt das endgültige Gebot 25 USD. Wenn das Gebot in Prozent 5 % beträgt und der Raumpreis insgesamt 100 USD beträgt, beträgt das endgültige Gebot 25 USD. Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional
MinimumNumberOfNights Die Mindestanzahl von Nächten, die zum Anwenden des Multiplikators erforderlich sind. Wenden Sie den Multiplikator an, wenn der Benutzer die angegebene Anzahl von Nächten oder länger bleibt. Gültige Werte sind 1 bis 14. Ganze Zahl Erforderlich Optional
@odata.type Der Typ des Objekts. Dieses Feld ist auf "#Model.LengthOfStayMultiplier" festgelegt. Zeichenfolge Erforderlich Erforderlich

Multiplikator

Definiert die Basisklasse für einen Multiplikator.

Geben Sie diese Klasse nicht an, sondern geben Sie stattdessen eine der Multiplikatorklassen an, z. B. UserCountryMultiplier.

Name Wert Typ Ergänzungen Aktualisieren
Faktor Der Prozentsatz, um den das Basisgebot angepasst werden soll. Der gültige Bereich ist 0,00 bis 10,00. Wenn das feste Gebot beispielsweise 5 USD und der Multiplikator 5 ist, beträgt das endgültige Gebot 25 USD. Wenn das Gebot in Prozent 5 % beträgt und der Raumpreis insgesamt 100 USD beträgt, beträgt das endgültige Gebot 25 USD. Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional

PercentageBid

Definiert ein Gebot basierend auf dem Prozentsatz des Zimmerpreises pro Nacht, einschließlich Steuern und anderen Gebühren.

Name Wert Typ Hinzufügen Aktualisieren
Betrag Der prozentsatzuelle Gebotsbetrag. Der gültige Bereich ist 0 bis 1.000. Wenn Sie beispielsweise 5 Prozent der Gesamtrate des Raums bieten möchten, legen Sie auf 5,0 fest Amount .

Der Gebotsbetrag ist das Gebot pro Nacht. Wenn das Gebot z. B. 3 % beträgt, der Zimmerpreis insgesamt 99 USD beträgt und die Reiseroute für einen Aufenthalt von 3 Nächten gilt, dann beträgt das endgültige Gebot 8,91 USD.
Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional
@odata.type Der Typ des Objekts. Dieses Feld ist auf "#Model.PercentageBid" festgelegt. Zeichenfolge Erforderlich Erforderlich

ReportJob

Definiert einen Berichtsauftrag.

Name Wert Typ Hinzufügen
Spalten Die Liste der Spalten, die in den Bericht aufgenommen werden sollen. Die Reihenfolge, in der sie im Bericht enthalten sind, ist unbestimmt. Der Berichtsdienst kann auch andere relevante Spalten überlappen, die nicht explizit angefordert werden. Bei Spaltennamen wird die Groß-/Kleinschreibung beachtet. Eine Liste der Spaltennamen finden Sie unter Berichtsspalten für den von Ihnen angeforderten Berichtstyp (z. B. für PerformanceReport siehe Leistungsberichtsspalten). Die Spalten müssen bei Lease eine Dimensionsspalte und eine Spalte vom Typ Metrik enthalten. String[] Erforderlich
Komprimierung Der Komprimierungstyp, der auf den Bericht angewendet werden soll. Im Folgenden sind die möglichen Werte aufgeführt, bei denen die Groß-/Kleinschreibung nicht beachtet wird.
  • ZIP
Der Standardwert ist keine Komprimierung.
Zeichenfolge Optional
EndDate Das UTC-Enddatum des Berichts im Format JJJJ-MM-tt. Der Monat und der Tag müssen zwei Ziffern enthalten. Verwenden Sie beispielsweise anstelle von 2018-1-4 2018-01-04.

Der Bericht enthält Daten, die innerhalb des Start- und Enddatums liegen, einschließlich. Das Enddatum muss am oder nach dem Startdatum sein.

HINWEIS: Beim Abrufen der status des Auftrags gibt der Dienst das Datum im Format JJJJ-MM-ttTHH:mm:ssZ zurück (z. B. 2017-10-30T00:00:00Z).
Zeichenfolge Erforderlich
Filter Die anzuwendende OData-Filterzeichenfolge. Die maximale Länge der Filterzeichenfolge beträgt 1.000 Zeichen. Informationen zur Verwendung von Filtern finden Sie unter Filtern von Berichtsdaten.

HINWEIS: Bei den von Ihnen angegebenen Berichtsspaltennamen und Enumerationswerten wird die Groß-/Kleinschreibung beachtet. Beispielsweise müssen Sie DeviceType anstelle des Gerätetyps und Desktop anstelle von Desktop angeben.
Zeichenfolge Optional
Format Das Format des Inhalts im Bericht. Im Folgenden sind die möglichen Werte aufgeführt, bei denen die Groß-/Kleinschreibung nicht beachtet wird.
  • CSV
Der Standardwert ist CSV.
Zeichenfolge Optional
HotelGroupId Die ID des Hotels, auf das der Bericht beschränkt werden soll. Um dieses Feld festzulegen, müssen Sie auch festlegen SubaccountId. Zeichenfolge Optional
Id Eine ID, die den Berichtsauftrag eindeutig identifiziert. Zeichenfolge Schreibgeschützt
IncludeNonPerformingHotels Ein boolescher Wert, der bestimmt, ob der Bericht Hotels enthält, die während des Berichtszeitraums keine Aufrufe empfangen haben. Legen Sie dieses Feld auf true fest, um nicht leistungsfähige Hotels einzuschließen. andernfalls false. Der Standardwert ist false.

Einschränkungen in Bezug auf die Spalten, die Sie angeben können, wenn Sie Nicht-Leistungs-Hotels anfordern, finden Sie unter Einschließen von Hotels mit Nicht-Leistung in den Bericht.
Boolesch Optional
ReportType Der Typ der Entität oder des Berichts, die heruntergeladen werden soll. Im Folgenden sind die möglichen Werte aufgeführt, bei denen die Groß-/Kleinschreibung beachtet wird. Zeichenfolge Erforderlich
StartDate Das UTC-Startdatum des Berichts im Format JJJJ-MM-tt. Der Monat und der Tag müssen zwei Ziffern enthalten. Beispielsweise muss 2018-1-4 2018-01-04 sein. Das früheste Datum, das Sie angeben können, ist drei Jahre ab heute.

HINWEIS: Beim Abrufen der status des Auftrags gibt der Dienst das Datum im Format JJJJ-MM-ttTHH:mm:ssZ zurück (z. B. 2017-10-30T00:00:00Z).
Zeichenfolge Erforderlich
Status Die status des Berichtsauftrags. Im Folgenden sind die möglichen Werte aufgeführt.
  • Abgeschlossen: Der Berichtsauftrag wurde erfolgreich abgeschlossen. Verwenden Sie die URL im Url Feld, um den Bericht herunterzuladen.
  • Fehler: Der Auftrag ist aus irgendeinem Grund fehlgeschlagen. Falls der Fehler ein vorübergehender Fehler ist, sollten Sie den Auftrag erneut übermitteln. Wenn der Auftrag erneut fehlschlägt, erfassen Sie die Anforderungs-ID im X-MS-RequestId-Header, und wenden Sie sich an den Support.
  • InProgress– Der Dienst erstellt gerade den Bericht.
  • PendingExecution – Die Berichtsanforderung wird in die Warteschlange gestellt.
Zeichenfolge Schreibgeschützt
SubaccountId Die ID des Unterkontos, auf das der Bericht beschränkt werden soll. Zeichenfolge Optional
Url Die URL des herunterzuladenden Berichts. Der Dienst stellt die URL bereit, wenn Status Abgeschlossen ist. Die URL ist fünf (5) Minuten ab dem Zeitpunkt gültig, zu dem Sie einen Berichtsauftrag erhalten, der Status auf Abgeschlossen festgelegt ist. Wenn die URL abläuft, senden Sie eine GET-Anforderung, um die status des Auftrags erneut und eine neue URL abzurufen.

SiteMultiplier

Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer nach Hotels auf einer der angegebenen Bing-Websites sucht.

Name Wert Typ Hinzufügen Aktualisieren
Faktor Der Prozentsatz, um den das Basisgebot angepasst werden soll. Der gültige Bereich ist 0,00 bis 10,00. Wenn das feste Gebot beispielsweise 5 USD und der Multiplikator 5 ist, beträgt das endgültige Gebot 25 USD. Wenn das Gebot in Prozent 5 % beträgt und der Raumpreis insgesamt 100 USD beträgt, beträgt das endgültige Gebot 25 USD. Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional
Websites Eine Liste von Websites. Wenden Sie den Multiplikator an, wenn der Benutzer die angegebene Website verwendet, um nach Hotels zu suchen. Im Folgenden sind die möglichen Werte aufgeführt, bei denen die Groß-/Kleinschreibung beachtet wird.
  • LocalUniversal– Der Benutzer sucht nach Hotels auf Bing.com.
  • MapResults: Der Benutzer sucht nach Hotels auf Bing.com/maps.
  • PropertyPromotionAd – Die erste Ergebnisseite, die in der Kartensuche angezeigt wird.
String[] Erforderlich Optional
@odata.type Der Typ des Objekts. Dieses Feld ist auf "#Model.SiteMultiplier" festgelegt. Zeichenfolge Erforderlich Erforderlich

SubAccount

Definiert die Gruppierung von Hotelpreisanzeigen auf oberster Ebene. Sie können sich dies logisch als eine Unterkunftskampagne vorstellen.

Name Wert Typ Hinzufügen Aktualisieren
Gebot Das Basisgebot, das Hotels erben, wenn sie oder die Gruppe, zu der sie gehören, kein Gebot angeben. Informationen zur Verwendung finden Sie Bid im Hotel-Objekt .

Im Folgenden sind die Typen von Geboten aufgeführt, die Sie angeben können.Um alle Hotels im Unterkonto anzuhalten, geben Sie ein Prozentuales Gebot an, und legen Sie den Gebotsbetrag auf Null (0) fest.
Objekt Erforderlich Optional
BidMultipliers Eine Liste von Multiplikatoren, die Hotels erben, wenn sie oder die Gruppe, zu der sie gehören, keine Multiplikatoren angeben. Der Standardwert ist 0. Informationen zur Verwendung finden Sie BidMultipliers im Hotel-Objekt .

Wenn das Unterkonto Multiplikatoren angibt und Sie sie entfernen möchten, legen Sie auf ein leeres Array fest BidMultipliers .

Im Folgenden sind die Typen von Multiplikatoren aufgeführt, die Sie angeben können.
object[] Optional Optional
DailyBudget Das Tagesbudget, das über den Tag verteilt werden soll.

Wenn Sie das Budget auf 0 festlegen, wird verhindert, dass Hotels im Unterkonto bereitgestellt werden.
Budget Erforderlich Optional
HotelAssociationCount Die Anzahl der Hotels, die Hotelgruppen im Unterkonto zugeordnet sind. Unsigned Integer Schreibgeschützt Schreibgeschützt
Id Eine vom System generierte ID, die das Unterkonto eindeutig identifiziert. Zeichenfolge Schreibgeschützt Erforderlich
MaximumBid Der nicht überschreitende Gebotsbetrag. FixedBid Optional Optional
Name Der Name des Unterkontos. Der Name darf maximal 128 Zeichen enthalten. Zeichenfolge Erforderlich Schreibgeschützt
Status Die status der Entität des Unterkontos. Im Folgenden sind die möglichen Werte aufgeführt.
  • Aktiv: Das Unterkonto wird nicht gelöscht und kann aktualisiert werden.
  • Gelöscht: Der Benutzer hat das Unterkonto gelöscht. Benutzer können Unterkonten nur über die Benutzeroberfläche löschen.
Zeichenfolge Schreibgeschützt Schreibgeschützt

UserCountryMultiplier

Definiert den Betrag, um den das Basisgebot angepasst werden soll, wenn der Benutzer auf eine der Bing-Domänen zugreift.

Name Wert Typ Hinzufügen Aktualisieren
Länder Eine Liste der aus zwei Buchstaben bestehenden ISO 3116-Länder-/Regionscodes. Eine Liste der möglichen Länder-/Regionscodes finden Sie unter Zulässige Länder-/Regionscodes.

Wenden Sie den Multiplikator an, wenn der Benutzer mit dem angegebenen Ländercode auf die Bing-Domäne zugreift. Wenn die Liste beispielsweise USA und DE enthält, verwendet Microsoft den Multiplikator, wenn der Benutzer Bing.com mit dem Code us oder de country verwendet (z. B. bing.com?cc=de).
String[] Erforderlich Optional
Faktor Der Prozentsatz, um den das Basisgebot angepasst werden soll. Der gültige Bereich ist 0,00 bis 10,00. Wenn das feste Gebot beispielsweise 5 USD und der Multiplikator 5 ist, beträgt das endgültige Gebot 25 USD. Wenn das Gebot in Prozent 5 % beträgt und der Raumpreis insgesamt 100 USD beträgt, beträgt das endgültige Gebot 25 USD. Gleitkommawert mit doppelter Genauigkeit Erforderlich Optional
@odata.type Der Typ des Objekts. Dieses Feld ist auf "#Model.UserCountryMultiplier" festgelegt. Zeichenfolge Erforderlich Erforderlich

HTTP-Statuscodes

Die Anforderungen geben möglicherweise die folgenden HTTP-status-Codes zurück.

Statuscode Beschreibung
200 Die Ressource wurde erfolgreich abgerufen.
201 Die Ressource wurde erfolgreich hinzugefügt.
204 Die Ressource wurde erfolgreich aktualisiert oder gelöscht.
400 Ungültige Anforderung. Entweder ist ein Abfrageparameterwert ungültig, oder der Inhalt im Anforderungstext ist ungültig.
401 Unbefugt. Die Anmeldeinformationen des Benutzers sind ungültig.
403 Verboten. Die Download-URL für den Bericht ist abgelaufen. Sie haben sieben Tage Zeit, nachdem Sie die URL erhalten haben, um den Bericht herunterzuladen. Wenn die URL abläuft, müssen Sie eine neue Auftragsanforderung übermitteln.
404 Nicht gefunden.
429 Zu viele Anforderungen. Die API beschränkt die Anzahl der Anforderungen, die Sie pro Minute vornehmen können. Der Grenzwert ist nicht dokumentiert und kann geändert werden. Die API gibt diesen status Code zurück, wenn Sie den Grenzwert überschreiten. Sie müssen nach dem Empfang dieses Fehlers 60 warten, bevor Sie die Anforderung erneut senden.
500 Serverfehler.

Fehlercodes

Melden von Fehlercodes

Fehlercode Beschreibung
CompressionTypeNotSupported Das Compression Feld ist auf einen Wert festgelegt, der nicht unterstützt wird. Eine Liste der unterstützten Komprimierungsalgorithmen finden Sie unter Komprimierung.
DuplicateValues Das Feld Spalten enthält mehrmals denselben Spaltennamen.
FilterTooLong Die OData-Filterzeichenfolge, die Sie auf festlegen Filter , ist zu lang. Informationen zur zulässigen maximalen Länge finden Sie unter Filter.
FormatVersionNotSupported Das Format Feld ist auf einen Wert festgelegt, der nicht unterstützt wird. Eine Liste der unterstützten Formate finden Sie unter Format.
InvalidDateRange Der angegebene Berichtszeitraum ist ungültig. Informationen zum Angeben eines gültigen Datumsbereichs finden Sie in den Feldern StarteDate und EndDate .
InvalidReportName Das ReportType Feld ist auf einen ungültigen Berichtsnamen festgelegt. Eine Liste der gültigen Berichtsnamen finden Sie unter ReportType.
InvalidSelect Mindestens eine der von Ihnen angegebenen Spalten ist ungültig. Vergleichen Sie die Spaltennamen, die Sie verwendet haben, mit denen, die für den angeforderten Bericht dokumentiert sind. Denken Sie daran, dass bei den Namen die Groß-/Kleinschreibung beachtet wird.

Länder- oder Regionscodes

Sie können die folgenden Länder-/Regionscodes verwenden, um das Countries Feld von UserCountryMultiplier festzulegen.

Name des Landes/der Region Länder-/Regionscode
Afghanistan AF
Albanien AL
Algerien DZ
Andorra AD
Angola AO
Anguilla AI
Antarktis AQ
Antigua und Barbuda AG
Antillen (Niederlande) EINE
Amerikanisch-Samoa AS
Argentinien AR
Armenien BIN
Aruba AW
Australien AU
Österreich AT
Aserbaidschan AZ
Bahamas BS
Bahrain BH
Bangladesch BD
Barbados BB
Belarus BY
Belgien WERDEN
Belize BZ
Bermuda BM
Benin BJ
Bhutan BT
Bolivien BO
Bosnien und Herzegowina BA
Botsuana BW
Brasilien BR
Brunei MRD
Bulgarien BG
Burkina Faso BF
Burundi BI
Cabo Verde Kostenabweichung (KA)
Kambodscha KH
Kamerun CM
Kanada CA
Kaimaninseln KY
Zentralafrika CF
Tschad TD
Chile CL
China CN
Weihnachtsinsel CX
Kokosinseln CC
Kolumbien CO
Komoren KM
Congo CG
Kongo (Demokratische Republik) CD
Cookinseln CK
Costa Rica CR
Côte d'Ivoire CI
Kroatien HR
Zypern CY
Tschechien CZ
Dänemark DK
Dschibuti DJ
Dominica DM
Dominikanische Republik TUN
Ecuador EG
Ägypten ZB
El Salvador Planabweichung (PA)
Äquatorialguinea GQ
Eritrea ER
Estland EE
Eswatini SZ
Äthiopien ET
Falklandinseln FK
Färöer FO
Fidschi FJ
Finnland FI
Frankreich FR
Französisch-Guayana GF
Französisch-Polynesien PF
Gabun Allgemein verfügbar
Gambia GM
Georgien GE
Deutschland DE
Ghana GH
Gibraltar GI
Griechenland GR
Grönland GL
Grenada GD
Guadeloupe GP
Guam GU
Guatemala Gt
Guinea GN
Guinea-Bissau GW
Guyana GY
Haiti HT
Heiliger Stuhl VA
Honduras HN
Hongkong (SAR) HK
Ungarn HU
Island IST
Indien IN
Indonesien ID
Irak IQ
Irland IE
Israel IL
Italien IT-Abteilung
Jamaika JM
Japan JP
Jordanien JO
Kasachstan KZ
Kenia KE
Kiribati KI
Korea KR
Kuwait KW
Kirgisistan KG
Demokratische Republik Lao Personen LA
Lettland LV
Libanon LB
Lesotho LS
Liberia LR
Libyen LY
Liechtenstein LI
Litauen LT
Luxemburg LU
Macao SAR MO
Madagaskar MG
Malawi MW
Malaysia MEINE
Malediven MV
Mali ML
Malta MT
Marshall-Inseln MH
Martinique MQ
Mauretanien HERR
Mauritius MU
Mayotte YT
Mexiko MX
Mikronesien FM
Republik Moldau MD
Monaco MC
Mongolei MN
Montenegro ICH
Montserrat MS
Marokko MA
Mosambik MZ
Myanmar MM
Namibia
Nauru NR
Nepal NP
Niederlande NL
Neukaledonien NC
Neuseeland NZ
Nicaragua NI
Niger NE
Nigeria NG
Niue NU
Norfolkinsel NF
Norwegen NEIN
Nordmazedonien MK
Nördliche Marianen MP
Oman OM
Pakistan PK
Palau PW
Palästinensische Gebiete PS
Panama PA
Papua-Neuguinea PG
Paraguay PY
Peru PE
Philippinen PH
Pitcairninseln PN
Polen PL
Portugal PT
Puerto Rico PR
Katar QA
Réunion RE
Rumänien RO
Russische Föderation RU
Ruanda RW
St. Helena, Ascension und Tristan da Cunha SH
St. Kitts und Nevis KN
St. Lucia LC
St. Pierre und Miquelon PM
St. Vincent und die Grenadinen VC
San Marino SM
São Tomé und Príncipe ST
Saudi Arabien SA
Senegal SN
Serbien RS
Seychellen SC
Sierra Leone SL
Singapur SG
Slowakei SK
Slowenien SI
Spanien ES
Salomonen SB
Samoa WS
Somalia ALSO
Südafrika ZA
Sri Lanka LK
Suriname SR
Schweden SE
Schweiz CH
Taiwan TW
Tadschikistan TJ
Tansania TZ
Thailand TH
Timor-Leste TL
Togo SF
Tokelau TK
Tonga TO
Trinidad und Tobago TT
Tunesien TN
Türkei TR
Turkmenistan TM
Turks- und Caicosinseln TC
Tuvalu TV
Uganda UG
Ukraine UA
Vereinigte Arabische Emirate AE
Vereinigtes Königreich GB
Vereinigte Staaten US
Uruguay UY
Usbekistan UZ
Vanuatu VU
Venezuela VE
Vietnam VN
Jungferninseln (Britisch) VG
Jungferninseln (USA) VI
Wallis und Futuna WF
Jemen IHR
Sambia ZM
Simbabwe ZW