Produkterfassungs-API für Container

Artikel
06/14/2024

Die Produktaufnahme-API ist eine modernisierte API, die alle vorhandenen Übermittlungs-APIs für alle kommerziellen Marketplace-Produkte vereint. Ausführliche Informationen zu den ersten Schritten finden Sie in der Produktaufnahme-API .

Dieser Artikel enthält Anleitungen zur Verwendung der APIs speziell für Container.

Abrufen vorhandener Ressourcenkonfigurationen

Rufen Sie alle Ressourcen innerhalb eines bestimmten Produkts in einem einzelnen API-Aufruf ab.

GET resource-tree/<product-durableID>?$version=<schema-version>

Sie können alle Ressourcenkonfigurationen innerhalb eines bestimmten Produkts abrufen, indem Sie den Ressourcentyp "resource-tree" zusammen mit der dauerhaften ID des Produkts verwenden. Die von Ihnen bereitgestellte Schemaversion wird als maximal unterstützte Version für jede der anwendbaren Ressourcen des angeforderten Produkts verwendet.

Hinweis

Wenn Sie die dauerhafte ID des Produkts nicht kennen, können Sie zuerst die Produktressource abrufen, indem Sie stattdessen die externe ID des Produkts verwenden und ausgeführt werden. Weitere Informationen finden Sie unter "Produkt-API: Methode 1: Ressourcenstruktur".

Get-Beispielanruf:

GET https://graph.microsoft.com/rp/product-ingestion/resource-tree/product/12345678-abcd-efgh-1234-12345678901?targetType=" Vorschau"&$version=2022-03-01-preview5

Beispielantwort:

{
  "$schema": "https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2",
  "root": "product/12345678-abcd-efgh-1234-12345678901",
  "target": {
    "targetType": "preview"
  },
  "resources": [
  { 
    "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3",
    "id": "product/12345678-abcd-efgh-1234-12345678901",
    "identity": {
      "externalID": "product_external_id_example"
    },
    "type": "azureContainer",
    "alias": "product_example"
  },
  { 
    "$schema": "https://schema.mp.microsoft.com/schema/commercial-marketplace-setup/2022-03-01-preview2",
    "id": "commercial-marketplace-setup/12345678-abcd-efgh-1234-12345678901",
    "product": "product/12345678-abcd-efgh-1234-12345678901",
    "sellThroughMicrosoft": true
  },
  {
    "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
    "id": "plan/12345678-abcd-efgh-1234-12345678901/98756328-04e9-55ae-9403-52b6c971a956
  ...
  }, 
     // The response would include all existing resources within this product.
  {
     ...
  }]
}

Private Zielgruppen synchronisieren

Für ein Liveprodukt können Updates für private Zielgruppen im Entwurf, in der Vorschau und in live-Umgebungen gleichzeitig ausgeführt werden, ohne dass eine Veröffentlichung erforderlich ist. Sie können die private Zielgruppe mit der Ressource "preis-and-availability-update-private-audiences" synchronisieren, indem Sie angeben, welche Benutzergruppen Sie einem bestimmten Plan hinzufügen oder entfernen möchten. Dadurch werden Entwürfe, Vorschau und Liveumgebungen synchronisiert, um die gleichen Privaten Zielgruppenwerte zu haben. Beim Synchronisieren der privaten Zielgruppe ist es nicht erforderlich, die Übermittlungsressource anzugeben.

Verwenden Sie zum Bearbeiten der Entwurfsgruppen die Ressource "Preis- und Verfügbarkeitsplan" und die Eigenschaft "privateAudiences". Dies muss den regulären Veröffentlichungsfluss durchlaufen, damit die Werte in der Vorschau und live festgelegt werden.

Wichtig

Wenn Ihr Produkt mehr als einen Bezeichnertyp zur Konfiguration der privaten Zielgruppe unterstützt (z. B. sowohl Mandanten-IDs als auch Abonnement-IDs), müssen Sie eine vollständige Veröffentlichung durchführen, wenn Sie zum ersten Mal einen neuen Bezeichnertyp bereitstellen. In diesem Fall können Sie die private Zielgruppe nicht synchronisieren.

Beispielanforderung zum Synchronisieren der Konfiguration der privaten Zielgruppe: