Catalogs-Ressource
Mit der Katalogressource können Sie Kataloge in Ihrem Microsoft Merchant Center Store (MMC) verwalten. Informationen zur Verwendung der Katalogressourcen finden Sie unter Verwalten Ihrer Kataloge. Beispiele zum Hinzufügen, Löschen und Abrufen von Katalogen finden Sie unter Codebeispiele.
Basis-URI
Im Folgenden sehen Sie den Basis-URI, an den Sie die Vorlagen anfügen.
https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/
Vorlagen
Um die Endpunkte zu erstellen, die Sie zum Verwalten Ihrer Kataloge verwenden, fügen Sie die entsprechende Vorlage an den Basis-URI an.
Vorlage | HTTP-Verb | Beschreibung | Ressource |
---|---|---|---|
{mmcMerchantId}/catalogs | POST | Verwenden Sie , um dem Speicher einen Katalog hinzuzufügen. Um einen Katalog hinzuzufügen, muss sein Name eindeutig sein. Sie können einem Store maximal 100 Kataloge hinzufügen. Legen Sie auf die MMC-Speicher-ID fest {mmcMerchantId} . |
Anforderung: Katalog Antwort: Katalog |
{mmcMerchantId}/catalogs/{catalogId} | PUT | Verwenden Sie , um einen Katalog im Speicher zu aktualisieren. Die einzigen Felder, die Sie aktualisieren können, sind die name Felder und isPublishingEnabled , und Sie müssen beide angeben.Legen Sie auf die MMC-Speicher-ID fest {mmcMerchantId} . |
Anforderung: Katalog Antwort: Katalog |
{mmcMerchantId}/catalogs/{catalogId} | LÖSCHEN | Verwenden Sie , um einen Katalog aus dem Speicher zu löschen. Legen Sie auf die MMC-Speicher-ID fest {mmcMerchantId} .Legen Sie auf die ID des Katalogs fest {catalogId} . |
Anforderung: N/A Antwort: N/A |
{mmcMerchantId}/catalogs/{catalogId} | GET | Verwenden Sie , um einen Katalog aus dem Store abzurufen. Legen Sie auf die MMC-Speicher-ID fest {mmcMerchantId} .Legen Sie auf die ID des Katalogs fest {catalogId} . |
Anforderung: N/A Antwort: Katalog |
{mmcMerchantId}/catalogs | GET | Verwenden Sie , um eine Liste von Katalogen aus dem Store abzurufen. Legen Sie auf die MMC-Speicher-ID fest {mmcMerchantId} . |
Anforderung: N/A Antwort: Kataloge |
Abfrageparameter
Die Endpunkte können die folgenden Abfrageparameter enthalten.
Header
Im Folgenden sind die Anforderungs- und Antwortheader aufgeführt.
Header | Beschreibung |
---|---|
AuthenticationToken | Anforderungsheader. Legen Sie diesen Header auf ein OAuth-Authentifizierungstoken fest. Informationen zum Abrufen eines Tokens finden Sie unter Authentifizieren Ihrer Anmeldeinformationen. |
Inhaltsspeicherort | Antwortheader. Eine URL, die den Speicher identifiziert, in den der Katalog eingefügt wurde. Dieser Header ist in der Antwort einer Insert-Anforderung enthalten. |
CustomerAccountId | Anforderungsheader. Die Konto-ID eines der Konten, die 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 Entwicklerzugriffstoken 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? |
Standort | Antwortheader. Eine URL, die den Speicher identifiziert, in den der Katalog eingefügt wurde. Dieser Header ist in der Antwort einer Insert-Anforderung enthalten. |
WebRequestActivityId | Antwortheader. Die ID des Protokolleintrags, der Details zur 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.
Jedes Objekt definiert den JSON-Schlüsselnamen und den XML-Elementnamen, die Sie abhängig vom Inhaltstyp verwenden, den Sie für die Anforderung angeben.
Objekt | Beschreibung |
---|---|
Katalog | Definiert einen Katalog. |
Kataloge | Definiert die Liste der Kataloge. |
Katalog
Definiert einen Katalog.
Name | Wert | Typ | XML-Elementname |
---|---|---|---|
Id | Eine ID, die den Katalog im Speicher eindeutig identifiziert. Dieses Feld ist schreibgeschützt. legen Sie dieses Feld nicht fest. |
Unsigned Long | <Id> |
Isdefault | Ein boolescher Wert, der bestimmt, ob der Katalog der Standardkatalog des Speichers ist. Ist true , wenn der Katalog der Standardkatalog des Speichers ist. andernfalls false. Wenn Sie einen Store erstellen, erhalten Sie einen Standardkatalog, in den Produkte geschrieben werden, wenn Sie keinen anderen Katalog angeben. Dieses Feld ist schreibgeschützt. legen Sie dieses Feld nicht fest. |
Boolesch | <is_default> |
isPublishingEnabled | Ein boolescher Wert, der bestimmt, ob Microsoft Produkte aus dem Katalog veröffentlichen darf. Auf TRUE festgelegt, wenn Microsoft Produkte aus dem Katalog veröffentlichen darf; legen Sie andernfalls false fest. Sie können dieses Feld aktualisieren. Sie können dieses Feld auch verwenden, um Ihre Anwendung zu testen, bevor Sie sie in der Produktion bereitstellen. Wenn Sie dieses Feld auf false festlegen, können Sie Produktressourcenaufrufe durchführen, ohne Ihre Produktionsdaten zu ändern oder zu veröffentlichen. |
Boolesch | <is_publishing_enabled> |
Markt | Der Markt, auf dem Produkte im Katalog veröffentlicht werden. HINWEIS: Dieses Feature hat noch nicht jeder. Wenn Sie dies nicht getan haben, machen Sie sich keine Sorgen – es kommt bald!. Im Folgenden sind die möglichen Märkte aufgeführt, die Sie angeben können.
Sie dürfen dieses Feld nicht aktualisieren, nachdem Sie den Katalog zum Speicher hinzugefügt haben. In der obigen Liste ist de-DE der Marktwert, den Sie angeben; (Deutsch-Deutschland) nicht in Ihre Marktzeichenfolge einschließen. |
Zeichenfolge | <Markt> |
Namen | Der Name des Katalogs. Der Name darf maximal 70 Zeichen enthalten. Sie können dieses Feld aktualisieren. |
Zeichenfolge | <Namen> |
Kataloge
Definiert eine Liste von Katalogen.
Name | Wert | Typ | XML-Elementname |
---|---|---|---|
Kataloge | Eine Liste der Kataloge im Speicher. | Katalog[] | <Kataloge> |
HTTP-Statuscodes
Die Anforderungen geben möglicherweise die folgenden HTTP-status-Codes zurück.
Statuscode | Beschreibung |
---|---|
200 | Erfolg. |
201 | Der Katalog wurde erfolgreich hinzugefügt. |
204 | Der Katalog wurde erfolgreich gelöscht. |
400 | Ungültige Anforderung. Entweder ist ein Abfrageparameterwert ungültig, oder etwas im Anforderungstext ist ungültig. |
401 | Unbefugt. Die Anmeldeinformationen des Benutzers sind ungültig. |
404 | Nicht gefunden. |
500 | Serverfehler. |