次の方法で共有

アドオンの申請の更新

  • [アーティクル]

既存のアドオン (アプリ内製品または IAP とも呼ばれます) の申請を更新するには、Microsoft Store 申請 API の以下のメソッドを使います。 このメソッドを使って申請を正常に更新した後は、インジェストと公開のために申請をコミットする必要があります。

このメソッドが Microsoft Store 申請 API を使ったアドオンの申請の作成プロセスにどのように適合するかについては、「アドオンの申請の管理」をご覧ください。

前提条件

このメソッドを使うには、最初に次の作業を行う必要があります。

  • Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
  • いずれかのアプリのアドオンの申請を作成します。 これは、パートナー センターで、またはアドオンの申請の作成メソッドを使用して実行できます。

要求

このメソッドの構文は次のとおりです。 ヘッダーと要求本文の使用例と説明については、次のセクションをご覧ください。

認証方法 要求 URI
PUT https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId}/submissions/{submissionId}

要求ヘッダー

Header 型 説明
承認 string 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。

要求パラメーター

名前 種類 説明
inAppProductId string 必須。 申請を更新するアドオンのストア ID です。 Store ID はパートナー センターで確認することができ、アドオンの作成またはアドオンの詳細の取得への要求の応答データに含まれています。
submissionId string 必須。 更新する申請の ID です。 この ID は、アドオンの申請の作成要求に対する応答データで確認できます。 アプリの申請をパートナー センターで作成した場合、この ID は、パートナー センターの申請ページの URL でも確認できます。

要求本文

要求本文には次のパラメーターがあります。

値 種類 説明
contentType string アドオンで提供されているコンテンツの種類です。 次のいずれかの値を指定できます。
  • NotSet
  • BookDownload
  • EMagazine
  • ENewspaper
  • MusicDownload
  • MusicStream
  • OnlineDataStorage
  • VideoDownload
  • VideoStream
  • Asp
  • OnlineDownload
keywords array アドオンのキーワードの文字列を最大 10 個含む配列です。 アプリでは、これらのキーワードを使ってアドオンを照会できます。
有効期間 string アドオンの有効期間です。 次のいずれかの値を指定できます。
  • 無期限
  • OneDay
  • ThreeDays
  • FiveDays
  • OneWeek
  • TwoWeeks
  • OneMonth
  • TwoMonths
  • ThreeMonths
  • SixMonths
  • OneYear
listings object アドオンの表示内容を含むオブジェクトです。 詳しくは、「表示リソース」をご覧ください。
価格 object アドオンの価格情報を含むオブジェクトです。 詳しくは、「価格リソース」をご覧ください。
targetPublishMode string 申請の公開モードです。 次のいずれかの値を指定できます。
  • 即時
  • 手動
  • SpecificDate
targetPublishDate string targetPublishMode が SpecificDate に設定されている場合、ISO 8601 形式での申請の公開日です。
tag string アドオンのカスタムの開発者データ(この情報は従来タグと呼ばれていました)。
参照可能範囲 string アドオンの可視性です。 次のいずれかの値を指定できます。
  • 非表示
  • パブリック
  • プライベート
  • NotSet

要求の例

次の例は、アドオンの申請を更新する方法を示しています。

PUT https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/9NBLGGH4TNMP/submissions/1152921504621230023 HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
{
  "contentType": "EMagazine",
  "keywords": [
    "books"
  ],
  "lifetime": "FiveDays",
  "listings": {
    "en": {
      "description": "English add-on description",
      "icon": {
        "fileName": "add-on-en-us-listing2.png",
        "fileStatus": "Uploaded"
      },
      "title": "Add-on Title (English)"
    },
    "ru": {
      "description": "Russian add-on description",
      "icon": {
        "fileName": "add-on-ru-listing.png",
        "fileStatus": "Uploaded"
      },
      "title": "Add-on Title (Russian)"
    }
  },
  "pricing": {
    "marketSpecificPricings": {
      "RU": "Tier3",
      "US": "Tier4",
    },
    "sales": [],
    "priceId": "Free"
  },
  "targetPublishDate": "2016-03-15T05:10:58.047Z",
  "targetPublishMode": "Immediate",
  "tag": "SampleTag",
  "visibility": "Public",
}

Response

次の例は、このメソッドが正常に呼び出された場合の JSON 応答本文を示しています。 応答本文には、更新された申請に関する情報が含まれています。 応答本文内の値について詳しくは、「アドオンの申請のリソース」をご覧ください。

{
  "id": "1152921504621243680",
  "contentType": "EMagazine",
  "keywords": [
    "books"
  ],
  "lifetime": "FiveDays",
  "listings": {
    "en": {
      "description": "English add-on description",
      "icon": {
        "fileName": "add-on-en-us-listing2.png",
        "fileStatus": "Uploaded"
      },
      "title": "Add-on Title (English)"
    },
    "ru": {
      "description": "Russian add-on description",
      "icon": {
        "fileName": "add-on-ru-listing.png",
        "fileStatus": "Uploaded"
      },
      "title": "Add-on Title (Russian)"
    }
  },
  "pricing": {
    "marketSpecificPricings": {
      "RU": "Tier3",
      "US": "Tier4",
    },
    "sales": [],
    "priceId": "Free"
  },
  "targetPublishDate": "2016-03-15T05:10:58.047Z",
  "targetPublishMode": "Immediate",
  "tag": "SampleTag",
  "visibility": "Public",
  "status": "PendingCommit",
  "statusDetails": {
    "errors": [
      {
        "code": "None",
        "details": "string"
      }
    ],
    "warnings": [
      {
        "code": "ListingOptOutWarning",
        "details": "You have removed listing language(s): []"
      }
    ],
    "certificationReports": [
      {
      }
    ]
  },
  "fileUploadUrl": "https://productingestionbin1.blob.core.windows.net/ingestion/26920f66-b592-4439-9a9d-fb0f014902ec?sv=2014-02-14&sr=b&sig=usAN0kNFNnYE2tGQBI%2BARQWejX1Guiz7hdFtRhyK%2Bog%3D&se=2016-06-17T20:45:51Z&sp=rwl",
  "friendlyName": "Submission 2"
}

エラー コード

要求を正常に完了できない場合、次の HTTP エラー コードのいずれかが応答に含まれます。

エラー コード Description
400 要求が無効なため、申請を更新できませんでした。
409 アドオンの現在の状態が原因で申請を更新できなかったか、または、アドオンで、現在 Microsoft Store 申請 API でサポートされていないパートナー センター機能が使用されています。