ProductStatuses-Ressource

Artikel
11/13/2024

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 Ressource ProductStatuses, um die status von Produktangeboten in einem Geschäft abzurufen.

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

Um beispielsweise eine Zusammenfassungsansicht der status von Produktangeboten in einem Geschäft zu erhalten, verwenden Sie den folgenden Endpunkt:

https://content.api.ads.microsoft.com/v9.1/bmc/stores/{merchantId}/productstatusessummary

Vorlagen

Dies sind die Vorlagen, die Sie an den Basis-URI anfügen, um einen HTTP-Endpunkt zu erstellen.

/stores/{merchantId}/productstatusessummary

HTTP-Verb	Beschreibung	Ressource
Abrufen	Ruft eine Zusammenfassungsansicht der status von Produktangeboten in einem Geschäft ab. Der Dienst gibt die Anzahl der Angebote zurück, die im Store genehmigt, abgelehnt und ablaufen. Legen Sie `{merchantId}` auf die ID des Speichers fest, aus dem die Status abgerufen werden sollen. Es kann bis zu zwei Stunden dauern, ab dem Zeitpunkt, zu dem sich die status eines Angebots geändert hat, bis zu dem Zeitpunkt, zu dem es in der Zusammenfassungsansicht angezeigt wird.	Anforderung: N/A Antwort: ProductStatusesSummary

/stores/{merchantId}/productstatuses

HTTP-Verb	Beschreibung	Ressource
Abrufen	Ruft eine Detailansicht der status von Produktangeboten in einem Geschäft ab. Details werden nur für Produkte zurückgegeben, deren status "Abgelehnt" oder "Warnung" lautet. Legen Sie `{merchantId}` auf die ID des Speichers fest, aus dem Sie die Status abrufen möchten. Der Abfrageparameter max-results bestimmt die Anzahl der Angebote, die der Dienst zurückgibt. Verwenden Sie den Abfrageparameter continuation-token , um alle Angebote zu durchlaufen.	Anforderung: N/A Antwort: ProductStatuses

Abfrageparameter

Die Anforderung kann die folgenden Abfrageparameter enthalten:

Parameter Beschreibung

max-results Optional. Verwenden Sie , um die maximale Anzahl von Elementen anzugeben, die in einer List-Anforderung wie zurückgegeben /stores/{merchantId}/productstatuseswerden sollen. Der Maximalwert, den Sie angeben können, ist 250. Der Standardwert ist 25.

Fortsetzungstoken Optional. Verwenden Sie , um die Liste der Produktstatus eines Stores zu durchlaufen. Das Token identifiziert die nächste Seite der zurückzugebenden Produktstatus. Geben Sie diesen Parameter nicht in der ersten List-Anforderung an. Wenn der Speicher mehr als die angeforderte Anzahl von Produkten enthält (siehe abfrageparameter max-results ), enthält die Antwort das nextPageToken Feld. Legen Sie in der nächsten Anforderung fortsetzungstoken auf den Tokenwert in nextPageTokenfest.

Parameter	Beschreibung
max-results	Optional. Verwenden Sie , um die maximale Anzahl von Elementen anzugeben, die in einer List-Anforderung wie zurückgegeben `/stores/{merchantId}/productstatuses`werden sollen. Der Maximalwert, den Sie angeben können, ist 250. Der Standardwert ist 25.
Fortsetzungstoken	Optional. Verwenden Sie , um die Liste der Produktstatus eines Stores zu durchlaufen. Das Token identifiziert die nächste Seite der zurückzugebenden Produktstatus. Geben Sie diesen Parameter nicht in der ersten List-Anforderung an. Wenn der Speicher mehr als die angeforderte Anzahl von Produkten enthält (siehe abfrageparameter max-results ), enthält die Antwort das `nextPageToken` Feld. Legen Sie in der nächsten Anforderung fortsetzungstoken auf den Tokenwert in `nextPageToken`fest.

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.
ProductStatus	Definiert die status eines Produktangebots.
ProductStatuses	Definiert eine Liste der Produktangebote mit Problemen.
ProductStatusesSummary	Definiert eine Zusammenfassungsansicht der status von Produktangeboten in einem Geschäft.
ProductStatusItemLevelIssue	Definiert ein Problem mit dem Produktangebot.

Fehler

Definiert einen Fehler.

Name	Wert	Typ
code	Der Grund, warum die Anforderung 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[]

ProductStatus

Definiert die status eines Produktangebots.

Name	Wert	Typ
Creationdate	Das Datum und die Uhrzeit der Erstellung des Produktangebots.	DateTime
expirationDate	Das Datum und die Uhrzeit, zu dem das Produktangebot abläuft.	DateTime
itemLevelIssues	Die Liste der Probleme mit dem Produktangebot.	ProductStatusItemLevelIssue[]
lastUpdateDate	Das Datum und die Uhrzeit der letzten Aktualisierung des Produktangebots.	DateTime
Productid	Die ID des Produkts.	Zeichenfolge
status	Die Genehmigung des Produkts status. Die folgenden Werte sind möglich: Abgelehnt Warnung Nicht genehmigte Produkte werden nicht bedient. Warnungen weisen darauf hin, dass das Produkt Probleme aufweist, die Sie beheben sollten, aber sie verhindern nicht, dass das Produktangebot bedient wird. Sie sollten die Probleme beheben und das Produktangebot erneut übermitteln.	Zeichenfolge
title	Titel des Produkts	Zeichenfolge