Store-Ressource
Hinweis
Die Store-Ressource ist nur für Teilnehmer mit geschlossener Beta verfügbar. Für Informationen zur Teilnahme am Closed-Beta- oder Open-Beta-Programm wenden Sie sich bitte an Ihren Account Manager.
Alle Store-Programmierelemente und -dokumentationen können während der Betaversion geändert werden.
Verwenden Sie die Store-Ressource, um die Speicher zu verwalten, die sich im Besitz des Benutzers befinden. Sie können Filialen hinzufügen, einen bestimmten Store abrufen oder alle Geschäfte abrufen, die sich im Besitz des Benutzers befinden. Weitere Informationen...
Basis-URI
Im Folgenden sehen Sie den Basis-URI, an den Sie die Vorlagen anfügen.
https://content.api.ads.microsoft.com/v9.1/bmc
Verwenden Sie beispielsweise den folgenden Endpunkt, um einen Speicher hinzuzufügen oder eine Liste von Läden abzurufen, die sich im Besitz des Benutzers befinden:
https://content.api.ads.microsoft.com/v9.1/bmc/stores
Vorlagen
Dies sind die Vorlagen, die Sie an den Basis-URI anfügen, um einen HTTP-Endpunkt zu erstellen.
Vorlage "/stores"
HTTP-Verb | Beschreibung | Ressource |
---|---|---|
BEREITSTELLEN | Fügt einen Speicher hinzu. Die folgenden Grenzwerte gelten und können sich ändern:
|
Anforderung: StoreCreate Antwort: Store |
GET | Ruft eine Liste der Speicher ab, die dem Benutzer gehören. | Anforderung: N/A Antwort: StoreCollection |
Vorlage "/stores/{merchantId}"
HTTP-Verb | Beschreibung | Ressource |
---|---|---|
GET | Ruft den angegebenen Speicher ab. Legen Sie {merchantId} auf die ID des Speichers fest, den Sie abrufen möchten. |
Anforderung: N/A Antwort: Store |
Abfrageparameter
Die Anforderung kann die folgenden Abfrageparameter enthalten:
Parameter | Beschreibung |
---|---|
Probelauf | Optional. Verwenden Sie , um Ihre Anwendung zu testen oder zu debuggen. Aufrufe, die diesen Parameter enthalten, wirken sich nicht auf Produktionsdaten aus (Speicher werden nicht hinzugefügt); Die Antwort enthält jedoch alle Fehler, die der Aufruf generiert. Beachten Sie die folgenden Einschränkungen, wenn Sie diesen Parameter verwenden.
|
Header
Im Folgenden sind die Anforderungs- und Antwortheader aufgeführt.
Header | Beschreibung |
---|---|
AuthenticationToken | Anforderungsheader. Legen Sie diesen Header auf ein OAuth-Zugriffstoken fest. Informationen zum Abrufen eines Zugriffstokens finden Sie unter Authentifizieren Ihrer Anmeldeinformationen. |
Content-Type | Anforderungsheader. Alle POST-Anforderungen müssen diesen Header angeben und auf application/json festgelegt werden. |
CustomerAccountId | Anforderungsheader. Die Konto-ID eines Kontos, das Sie im Namen des im CustomerId Header angegebenen Kunden verwalten. Es spielt keine Rolle, welches Konto Sie angeben. Geben Sie diesen Header nur an, wenn Sie ein Konto im Namen des Kunden verwalten. |
Customerid | Anforderungsheader. Die Kunden-ID des Kunden, dessen Geschäft Sie verwalten. Geben Sie diesen Header nur an, wenn Sie den Speicher im Namen des Kunden verwalten. Wenn Sie diesen Header festlegen, müssen Sie auch den CustomerAccountId Header festlegen. |
DeveloperToken | Anforderungsheader. Das Entwicklertoken der Clientanwendung. Jede Anforderung muss diesen Header enthalten. Informationen zum Abrufen eines Tokens finden Sie unter Verfügen Sie über Ihre Microsoft Advertising-Anmeldeinformationen und das Entwicklertoken? |
WebRequestActivityId | Antwortheader. Die ID des Protokolleintrags, der 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. |
Anforderungs- und Antwortobjekte
Im Folgenden werden die von der API verwendeten Anforderungs- und Antwortobjekte aufgeführt.
Objekt | Beschreibung |
---|---|
Error | Definiert einen Fehler. |
ErrorResponse | Definiert das Fehlerobjekt der obersten Ebene. |
Store | Definiert einen Store im Microsoft Merchant Center. |
StoreCollection | Definiert eine Sammlung von Stores im Microsoft Merchant Center. |
StoreCreate | Definiert einen Store, der dem Microsoft Merchant Center hinzugefügt werden soll. |
StoreStatus | Definiert die status des Stores. |
Fehler
Definiert einen Fehler.
Name | Wert | Typ |
---|---|---|
code | Der Grund, warum die Anforderung fehlgeschlagen ist. Der Code ist beispielsweise InvalidStoreNameErr, wenn die Überprüfung des storeName Felds fehlgeschlagen ist. |
Zeichenfolge |
message | Eine Beschreibung des Fehlers. | Zeichenfolge |
ErrorResponse
Definiert das Fehlerobjekt der obersten Ebene.
Name | Wert | Typ |
---|---|---|
errors | Eine Liste der Fehler, die bei der Verarbeitung der Anforderung aufgetreten sind. | Fehler[] |
Store
Definiert einen Store im Microsoft Merchant Center.
Name | Wert | Typ |
---|---|---|
isBlockAggregator | Ein boolescher Wert, der angibt, ob Sie verhindern möchten, dass Aggregatoren Anzeigen aus Ihrem Store bereitstellen. Aggregatoren konsolidieren Produktangebote von mehreren, oft unabhängigen Unternehmen. Standardmäßig können Aggregatoren Ihren Katalog in ihre Anzeigen einschließen. Ist wahr , wenn Sie verhindern möchten, dass Ihre Produkte in den Anzeigen von Aggregatoren auf Bing angezeigt werden. Wenn Sie über zwei Speicher (einen für die USA und einen für das Vereinigte Königreich) verfügen, die verwendenhttp://www.contoso.com, und einer von ihnen blockt Aggregatoren, dann speichern beide Blockaggregatoren. |
Boolesch |
isSslCheckout | Ein boolescher Wert, der angibt, ob Ihr Speicher SSL aktiviert ist. Alle Speicher müssen über SSL-Anmelde- und Checkout-Seiten verfügen. Ist true , wenn die Website Ihres Stores SSL aktiviert ist. | Boolesch |
merchantId | Die ID des Stores. | Unsigned long |
notificationEmail | Eine Liste der Empfänger, die Benachrichtigungs-E-Mails erhalten sollen. Die E-Mails benachrichtigen Sie, wenn der Store genehmigt wurde oder wenn Validierungsfehler mit dem Speicher vorliegen. | String[] |
notificationLanguage | Die Sprache, die zum Schreiben der Benachrichtigungs-E-Mails verwendet wird. Die Sprache weist das Format <language-country></region> auf. Beispiel: en-US. | Zeichenfolge |
storeDescription | Eine Beschreibung, die die Verwendung des Stores beschreibt. | Zeichenfolge |
Storename | Der Name des Geschäfts. | Zeichenfolge |
storeStatus | Die status des Stores. | StoreStatus |
storeUrl | Die Ziel-URL des Speichers. Die Ziel-URL ist die Webseite, auf die Personen weitergeleitet werden, wenn sie auf Ihre Anzeige klicken. | Zeichenfolge |
StoreCollection
Definiert eine Liste von Speichern.
Name | Wert | Typ |
---|---|---|
Läden | Eine Liste der Stores, die sich im Besitz des Benutzers befinden. | Store[] |
StoreCreate
Definiert einen Store, der dem Microsoft Merchant Center hinzugefügt werden soll.
Name | Wert | Typ | Erforderlich |
---|---|---|---|
isBlockAggregator | Ein boolescher Wert, der angibt, ob Sie verhindern möchten, dass Aggregatoren Anzeigen aus Ihrem Store bereitstellen. Aggregatoren konsolidieren Produktangebote von mehreren, oft unabhängigen Unternehmen. Standardmäßig können Aggregatoren Ihren Katalog in ihre Anzeigen einschließen. Legen Sie diese Einstellung auf true fest, um zu verhindern, dass Ihre Produkte in den Anzeigen von Aggregatoren auf Bing angezeigt werden. Wenn Sie über zwei Speicher (einen für die USA und einen für das Vereinigte Königreich) verfügen, die verwendenhttp://www.contoso.com, und einer von ihnen blockt Aggregatoren, dann speichern beide Blockaggregatoren. Standardwert ist false. |
Boolean | Nein |
isSslCheckout | Ein boolescher Wert, der angibt, ob Ihr Speicher SSL aktiviert ist. Alle Speicher müssen über SSL-Anmelde- und Checkout-Seiten verfügen. Legen Sie diesen Wert auf true fest, wenn die Website Ihres Stores SSL aktiviert ist. Wenn false , wird der Store abgelehnt. Standardwert ist true. |
Boolean | Nein |
notificationEmail | Eine Liste der Empfänger, die Benachrichtigungs-E-Mails erhalten sollen. Die E-Mails benachrichtigen Sie, wenn der Store genehmigt wurde oder wenn Validierungsfehler mit dem Speicher vorliegen. Die maximale Anzahl von E-Mail-Adressen, die Sie angeben können, ist 14. | String[] | Ja |
notificationLanguage | Die Sprache, die zum Schreiben der Benachrichtigungs-E-Mails verwendet wird. Die Sprache weist das Format <language-country></region> auf. Im Folgenden sind die werte aufgeführt, bei denen die Groß-/Kleinschreibung nicht beachtet wird, die Sie angeben können.
|
Zeichenfolge | Ja |
storeDescription | Eine Beschreibung, die die Verwendung des Stores beschreibt. Die Beschreibung ist auf maximal 350 Zeichen beschränkt und darf nur alphanumerische Zeichen ([a-zA-Z0-9]) enthalten. | Zeichenfolge | Nein |
Storename | Der Name des Geschäfts. Da der Name des Stores in Ihren Produktanzeigen angezeigt wird, achten Sie darauf, einen Namen zu verwenden, der Ihre Website genau darstellt. Der Name muss:
|
Zeichenfolge | Ja |
storeUrl | Die Ziel-URL des Speichers. Die Ziel-URL ist die Webseite, auf die Personen weitergeleitet werden, wenn sie auf Ihre Anzeige klicken. Die URL darf nicht an einen anderen Speicherort umgeleitet werden. Die URL muss wohlgeformt sein und maximal 1.024 Zeichen enthalten. Sie müssen die URL Ihrer Website überprüfen und anfordern. Stores werden abgelehnt, wenn Microsoft nicht überprüfen kann, ob Ihre Website SSL-konform ist. Händlerwebsites müssen ÜBER SSL-Anmelde- und Checkout-Seiten verfügen. Überprüfen Sie, ob Ihre SSL-Zertifikate gültig sind. | Zeichenfolge | Ja |
StoreStatus
Definiert die status des Stores.
Name | Wert | Typ |
---|---|---|
message | Der Grund, warum der Store abgelehnt wurde. Das -Objekt enthält dieses Feld nur, wenn status abgelehnt ist. |
Zeichenfolge |
status | Die status des Stores. Im Folgenden sind die möglichen Werte aufgeführt.
message den Grund.Ein Store, der ursprünglich automatisch genehmigt wurde, kann von Genehmigt in ManualReview verschoben werden. Sie können keine Produkte zu einem Geschäft hinzufügen, das manuell überprüft wird, und produkte im Store werden nicht bedient. Abhängig vom Grund für die Ablehnung können Sie das Problem möglicherweise mithilfe der Microsoft Ads-Anwendung beheben. Andernfalls müssen Sie einen neuen Speicher mit den entsprechenden Werten erstellen. |
Zeichenfolge |
HTTP-Statuscodes
Die Anforderungen geben möglicherweise die folgenden HTTP-status-Codes zurück.
Statuscode | Beschreibung |
---|---|
200 | Erfolg. |
201 | Store wurde erfolgreich hinzugefügt. |
400 | Ungültige Anforderung. Höchstwahrscheinlich enthält der Text der POST-Anforderung ungültige Daten oder ist falsch formatiert. |
401 | Unbefugt. Die Anmeldeinformationen des Benutzers sind ungültig. |
404 | Nicht gefunden. Der angeforderte Speicher wurde nicht gefunden. |
500 | Serverfehler. |
Fehlercodes
Die Anforderungen geben möglicherweise die folgenden Fehlercodes zurück.
Fehlercode | Beschreibung |
---|---|
AdultAdvertiserErr | Nicht jugendfreie Werbekunden dürfen keine Geschäfte erstellen. |
DomainNotOwnedByCustomerErr | Die im Feld storeUrl angegebene Domäne ist nicht im Besitz des Kunden. Stellen Sie sicher, dass der Kunde überprüft hat, ob er der Besitzer der Domäne ist. |
DuplicateStoreNameErr | Ein weiterer Speicher mit dem angegebenen Speichernamen ist vorhanden. Store-Namen müssen im Microsoft Merchant Center eindeutig sein. |
ExceededMaxStoresForCustomerErr | Der Kunde hat die Anzahl der Geschäfte überschritten, die er erstellen kann. Informationen zu Grenzwerten finden Sie unter Hinzufügen von Store POST. |
ExceededMaxStoresForDestinationUrlErr | Der Kunde hat die Anzahl der Stores überschritten, die er mit derselben Ziel-URL erstellen kann. Informationen zu Grenzwerten finden Sie unter Hinzufügen von Store POST. |
InvalidStoreDescriptionErr | Die Beschreibung des Stores ist ungültig. Informationen zu Grenzwerten finden Sie unter storeDescription. |
InvalidStoreDestinationUrlErr | Die Ziel-URL des Speichers, die Sie im Feld storeUrl angegeben haben, ist ungültig. |
InvalidStoreNameErr | Der Name des Speichers ist ungültig. Informationen zu Grenzwerten finden Sie unter storeName. |
MarketNotSupportedErr | Der Markt, den Sie im Feld notificationLanguage angegeben haben, ist ungültig. |
NoDomainsFoundForCustomerErr | Es gibt keine überprüften Domänen im Besitz des Kunden. |