Поделиться через

Состояние задания и получение сведений о частном предложении с помощью API

  • Статья

В этой статье содержатся методы проверки состояния и получения сведений о частном предложении с помощью API Центра партнеров.

Запрос состояния существующего задания

Используйте этот метод для запроса состояния существующего задания. Вы можете опрашивать состояние существующего задания с интервалом опроса с максимальной частотой одного запроса в минуту.

Запросить

GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01

Заголовок запроса

Верхний колонтитул Тип Описание
Авторизация Строка Обязательный. Маркер доступа Microsoft Entra в форме Bearer <token>.

Параметры запроса

  • jobId — обязательный. Это идентификатор задания, для которого требуется запросить состояние. Он доступен в данных ответа, созданных во время предыдущего запроса, для создания, удаления, отзыва или обновления частного предложения.
  • $version — обязательный. Это версия схемы, которая используется в запросе.

Текст запроса

Текст запроса недоступен для этого метода.

Response

Существует три возможных ответа для завершенного задания:

jobResult Description
Выполняется Задание еще не завершено.
Выполнено Задание успешно выполнено. Это также возвращает URI ресурса, который ссылается на предложение, связанное с заданием. Используйте этот ресурс URI для получения полных сведений о предложении.
Неудачно Не удалось завершить задание. При этом также будут возвращены все соответствующие ошибки, которые помогут определить причину сбоя.

Пример выходных данных

Выполняется

JSON
{
    "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
    "jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
    "jobStatus": "running",
    "jobResult": "pending",
    "jobStart": "2021-12-21T21:29:54.9702903Z",
    "jobEnd": "2021-12-21T21:30:10.3649551Z",
    "errors": []
}

Выполнено

{
    "$schema": " https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
    "jobId": "b3f49dff-381f-480d-a10e-17f4ce49b65f",
    "jobStatus": "completed",
    "jobResult": "succeeded",
    "jobStart": "2021-12-21T21:29:54.9702903Z",
    "jobEnd": "2021-12-21T21:30:10.3649551Z",
    "resourceUri": "https://product-ingestion.mp.microsoft.com/configure/b3f49dff-381f-480d-a10e-17f4ce49b65f",
    "errors": []
}

Примечание.

Если задание было создано запросом на удаление частного предложения, в ответе не будет ресурса ресурса.

Сбой

{
    "$schema": " https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
    "jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
    "jobStatus": "completed",
    "jobResult": "failed",
    "jobStart": "2021-12-21T21:29:54.9702903Z",
    "jobEnd": "2021-12-21T21:30:10.3649551Z",
    "errors": [
        {
            "code": "Conflict",
            "message": "The start date should be defined"
        }
    ]
}

Коды ошибок

Код ошибки Description
401 Ошибка проверки подлинности: убедитесь, что вы используете действительный маркер доступа Microsoft Entra.

Получение сведений о существующем частном предложении

Это можно сделать двумя способами в зависимости от того, есть ли у вас идентификатор ресурса или частный идентификатор предложения.

Запросить

GET https://graph.microsoft.com/rp/product-ingestion/private-offer/<id>?$ version=2023-07-15

or

GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>?$version=2023-07-15

Заголовок запроса

Верхний колонтитул Тип Описание
Авторизация Строка Обязательный. Маркер доступа Microsoft Entra в форме Bearer <token>.

Параметры запроса

  • Идентификатор — обязательный. Это идентификатор частного предложения, который вы хотите получить полные сведения. Этот идентификатор доступен в данных ответа, созданных во время предыдущего запроса, чтобы получить сведения о существующем многопартийном частном предложении с помощью jobId.

  • jobId — обязательный. Это идентификатор задания, который вы хотите получить полные сведения. Этот идентификатор доступен в данных ответа, созданных во время предыдущего запроса, для создания, удаления, отзыва или обновления частного предложения.

  • $version — обязательный. Это версия схемы, которая используется в запросе

Текст запроса

Не предоставляйте текст запроса для этого метода.

Response

Вы получите полные сведения о частном предложении. Ниже приведен пример для вызывающего партнера канала при запросе многопартийного частного предложения.

{
    "id": "private-offer/30b90a6a-df19-43cc-a107-b0c62057da6d",
    "name": "mpo_api_test",
    "privateOfferType": "multiPartyPromotionChannelPartner",
    "offerPricingType": "editExistingOfferPricingOnly",
    "variableStartDate": true,
    "end": "2023-01-31",
    "acceptBy": "2023-01-21",
    "notificationContacts": [],
    "state": "draft",
    "originatorTermsAndConditionsDocs": [
        {
            "sasUrl": "https://promotionpmeprod.blob.core.windows.net/promotionsblobdata/44c2b38a-fa64-4861-806c-6c486ec19b6d-769f3960-45af-42db-ab3b-6391841683d6",
            "fileName": "test.pdf",
            "customerFacingDocumentName": "test1"}],
    "termsAndConditionsDocs": [],
    "beneficiaries": [
        {
            "id": "ac357579-e860-54a6-80b3-66958aea67fe:7471d04e-f696-4d20-af34-fa78d51e419c_2019-05-31",
            "description": "beneficiary Id"}],
    "partners": [
        {
            "id": "12345678",
            "partnerName": "Market Place Test",
            "location": "United States" }],
    "originatorPricing": [
        {
            "product": "product/11775d67-fb2b-46bf-ad0f-0e1d5e74ba03",
            "productName": "mpo_test_saas_site_1",
            "plan": "plan/11775d67-fb2b-46bf-ad0f-0e1d5e74ba03/570ebda0-467b-4ac3-a0d8-069131afd7ee",
            "planName": "MPO Site 1 - LTS 2",
            "discountType": "absolute",
            "priceDetails": "price-and-availability-private-offer-plan/11775d67-fb2b-46bf-ad0f-0e1d5e74ba03/2152924500014081860"},
        {
            "product": "product/6c73a19b-ba11-496c-b38b-1d4a3cc64d91",
            "productName": "mpo_test_vmsr",
            "plan": "plan/6c73a19b-ba11-496c-b38b-1d4a3cc64d91/24f34f12-df93-4a7b-93d7-d9336e02d44e",
            "planName": "MPO VMSR 4",
            "discountType": "percentage",
            "discountPercentage": 2.0 }],
    "lastModified": "2023-01-19",
    "eTag": "\"7d02cb1b-0000-0800-0000-63c9aee80000\"",
    "$schema": "https://schema.mp.microsoft.com/schema/private-offer/2023-07-15"
}

Коды ошибок

Код состояния HTTP Description
401 Ошибка проверки подлинности. Убедитесь, что вы используете действительный маркер доступа Microsoft Entra.
404 Ресурс не найден. Убедитесь, что вы используете правильный идентификатор в запросе.

Связанный контент