API приема продуктов для контейнеров

Статья
06/14/2024

API приема продуктов — это обновленный API, который объединяет все существующие API отправки во всех продуктах коммерческой платформы. Дополнительные сведения о начале работы см. в API приема продуктов.

В этой статье содержатся рекомендации по использованию API специально для контейнеров.

Получение существующих конфигураций ресурсов

Извлеките все ресурсы в определенном продукте в одном вызове API.

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

Вы можете получить все конфигурации ресурсов в определенном продукте с помощью типа ресурса resource-tree вместе с устойчивым идентификатором продукта. Указанная версия схемы используется в качестве максимально поддерживаемой версии для каждого из применимых ресурсов запрошенного продукта.

Примечание.

Если вы не знаете устойчивый идентификатор продукта, вы можете сначала получить ресурс продукта с помощью внешнего идентификатора продукта и запустить его. Дополнительные сведения см. в разделе API продукта: метод 1: дерево ресурсов.

Пример вызова GET:

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

Пример ответа:

{
  "$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.
  {
     ...
  }]
}

Синхронизировать частные аудитории

Для динамического продукта обновления частных аудиторий в черновике, предварительной версии и живых средах можно выполнять одновременно, не требуя публикации. Вы можете синхронизировать частную аудиторию с помощью ресурса price-and-availability-update-private-audiences, указав, какие аудитории нужно добавить или удалить из определенного плана. Это синхронизирует черновик, предварительную версию и динамические среды с одинаковыми значениями частной аудитории. При синхронизации частной аудитории не нужно предоставлять ресурс отправки.

Чтобы изменить черновик аудитории, используйте ресурс price-and-availability-plan и свойство privateAudiences. Это потребуется пройти через обычный поток публикации, чтобы значения были заданы в предварительной версии и в реальном времени.

Внимание

Если ваш продукт поддерживает несколько типов идентификаторов для настройки частной аудитории (например, идентификаторов клиентов и идентификаторов подписок), необходимо выполнить полную публикацию при первом предоставлении нового типа идентификатора. В этом случае вы не можете синхронизировать частную аудиторию.

Пример запроса для синхронизации конфигурации частной аудитории: