ジョブの状態と API を使用したプライベート オファーの詳細の取得
この記事には、パートナー センター API を使用して状態を確認し、プライベート オファーの詳細を取得する方法が含まれています。
既存ジョブの状態のクエリを実行する
既存ジョブの状態のクエリを実行するには、このメソッドを使用します。 要求の最大頻度が 1 分あたり 1 回というポーリング間隔で、既存ジョブの状態をポーリングできます。
要求
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01
要求ヘッダー
| Header | 型 | 説明 |
|---|---|---|
| 承認 | String | 必須。 フォームの Microsoft Entra アクセス トークン Bearer <token>。 |
要求パラメーター
- jobId – 必須。 これは、状態のクエリを実行する対象であるジョブの ID です。 これは、プライベート オファーの作成、削除、取り消し、またはアップグレードのための以前の要求中に生成された応答データで確認できます。
- $version - 必須。 これは、要求で使用されているスキーマのバージョンです。
要求本文
このメソッドでは、要求本文を使用できません。
回答
完了したジョブには、次の 3 つの応答が考えられます。
| jobResult | 説明 |
|---|---|
| 実行中 | ジョブはまだ完了していません。 |
| Succeeded | ジョブは正常に完了しました。 これにより、ジョブに関連するオファーを参照する resourceURI も返されます。 この resourceURI を使用して、オファーの完全な詳細を取得します。 |
| Failed | ジョブは失敗しました。 これにより、エラーの原因を特定するのに役立つ関連するエラーも返されます。 |
サンプル出力
実行中
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": []
}
Note
プライベート オファーを削除する要求によってジョブが作成された場合、応答に resourceURI は含まれません。
障害
{
"$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"
}
]
}
エラー コード
| エラー コード | 説明 |
|---|---|
| 401 | 認証エラー: 有効な Microsoft Entra アクセス トークンを使用していることを確認します。 |
既存のプライベート オファーの詳細を取得する
resourceURI とプライベート オファー ID のどちらを使用するかに応じて、これを行うメソッドは 2 つあります。
要求
GET https://graph.microsoft.com/rp/product-ingestion/private-offer/<id>?$ version=2023-07-15
または
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>?$version=2023-07-15
要求ヘッダー
| Header | 型 | 説明 |
|---|---|---|
| 承認 | String | 必須。 フォームの Microsoft Entra アクセス トークン Bearer <token>。 |
要求パラメーター
ID - 必須。 これは、すべての詳細を取得する対象であるプライベート オファーの ID です。 この ID は、jobId を使用して既存のマルチパーティ プライベート オファーの詳細を取得するために、前の要求中に生成された応答データで使用できます。
jobId - 必須。 これは、すべての詳細を取得する対象であるジョブの ID です。 この ID は、プライベート オファーの作成、削除、取り消し、またはアップグレードのための以前の要求中に生成された応答データで確認できます。
$version - 必須。 これは要求で使用されているスキーマのバージョンです。
要求本文
このメソッドでは要求本文を指定しないでください。
回答
プライベート オファーのすべての詳細が表示されます。 マルチパーティ プライベート オファーのクエリを実行する場合のチャネル パートナーの呼び出し元の例を次に示します。
{
"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 状態コード | 説明 |
|---|---|
| 401 | 認証エラー: 有効な Microsoft Entra アクセス トークンを使用していることを確認します。 |
| 404 | リソースが見つかりません。 要求で正しい ID を使用していることを確認します。 |