アドオンの申請の更新Update an add-on submission

既存のアドオン (アプリ内製品または IAP とも呼ばれます) の申請を更新するには、Microsoft Store 申請 API の以下のメソッドを使います。Use this method in the Microsoft Store submission API to update an existing add-on (also known as in-app product or IAP) submission. このメソッドを使って申請を正常に更新した後は、インジェストと公開のために申請をコミットする必要があります。After you successfully update a submission by using this method, you must commit the submission for ingestion and publishing.

このメソッドが Microsoft Store 申請 API を使ったアドオンの申請の作成プロセスにどのように適合するかについては、「アドオンの申請の管理」をご覧ください。For more information about how this method fits into the process of creating an add-on submission by using the Microsoft Store submission API, see Manage add-on submissions.

前提条件Prerequisites

このメソッドを使うには、最初に次の作業を行う必要があります。To use this method, you need to first do the following:

  • Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。Obtain an Azure AD access token to use in the request header for this method. アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。After you obtain an access token, you have 60 minutes to use it before it expires. トークンの有効期限が切れたら新しいトークンを取得できます。After the token expires, you can obtain a new one.
  • アプリのいずれかのアドオン送信を作成します。Create an add-on submission for one of your apps. パートナー センターでこれを行うかを使用してこれを行う、 、アドオンの提出の作成メソッド。You can do this in Partner Center, or you can do this by using the Create an add-on submission method.

要求Request

このメソッドの構文は次のとおりです。This method has the following syntax. ヘッダーと要求本文の使用例と説明については、次のセクションをご覧ください。See the following sections for usage examples and descriptions of the header and request body.

メソッドMethod 要求 URIRequest URI
PUTPUT https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId}/submissions/{submissionId}

要求ヘッダーRequest header

HeaderHeader 種類Type 説明Description
AuthorizationAuthorization stringstring 必須。Required. Bearer <トークン> という形式の Azure AD アクセス トークン。The Azure AD access token in the form Bearer <token>.

要求パラメーターRequest parameters

名前Name 種類Type 説明Description
inAppProductIdinAppProductId stringstring 必須。Required. 申請を更新するアドオンのストア ID です。The Store ID of the add-on for which you want to update a submission. Store ID は、パートナー センターで利用できるとするための要求応答のデータに含まれるアドオンを作成またはアドオンの詳細の取得します。The Store ID is available in Partner Center, and it is included in the response data for requests to Create an add-on or get add-on details.
submissionIdsubmissionId stringstring 必須。Required. 更新する申請の ID です。The ID of the submission to update. この ID は、アドオンの申請の作成要求に対する応答データで確認できます。This ID is available in the response data for requests to create an add-on submission. パートナー センターで作成された送信、この ID はパートナー センターでの送信 ページの URL で使用できるも。For a submission that was created in Partner Center, this ID is also available in the URL for the submission page in Partner Center.

要求本文Request body

要求本文には次のパラメーターがあります。The request body has the following parameters.

ValueValue 種類Type 説明Description
contentTypecontentType stringstring アドオンで提供されているコンテンツの種類です。The type of content that is provided in the add-on. 次のいずれかの値を使用できます。This can be one of the following values:
  • NotSetNotSet
  • BookDownloadBookDownload
  • EMagazineEMagazine
  • ENewspaperENewspaper
  • MusicDownloadMusicDownload
  • MusicStreamMusicStream
  • OnlineDataStorageOnlineDataStorage
  • VideoDownloadVideoDownload
  • VideoStreamVideoStream
  • AspAsp
  • OnlineDownloadOnlineDownload
keywordskeywords arrayarray アドオンのキーワードの文字列を最大 10 個含む配列です。An array of strings that contain up to 10 keywords for the add-on. アプリでは、これらのキーワードを使ってアドオンを照会できます。Your app can query for add-ons using these keywords.
lifetimelifetime stringstring アドオンの有効期間です。The lifetime of the add-on. 次のいずれかの値を使用できます。This can be one of the following values:
  • ForeverForever
  • OneDayOneDay
  • ThreeDaysThreeDays
  • FiveDaysFiveDays
  • OneWeekOneWeek
  • TwoWeeksTwoWeeks
  • OneMonthOneMonth
  • TwoMonthsTwoMonths
  • ThreeMonthsThreeMonths
  • SixMonthsSixMonths
  • OneYearOneYear
listingslistings オブジェクトobject アドオンの表示内容を含むオブジェクトです。An object that contains listing info for the add-on. 詳しくは、「表示リソース」をご覧ください。For more information, see Listing resource.
pricingpricing オブジェクトobject アドオンの価格情報を含むオブジェクトです。An object that contains pricing info for the add-on. 詳しくは、「価格リソース」をご覧ください。For more information, see Pricing resource.
targetPublishModetargetPublishMode stringstring 申請の公開モードです。The publish mode for the submission. 次のいずれかの値を使用できます。This can be one of the following values:
  • 即時Immediate
  • ManualManual
  • SpecificDateSpecificDate
targetPublishDatetargetPublishDate stringstring targetPublishMode が SpecificDate に設定されている場合、ISO 8601 形式での申請の公開日です。The publish date for the submission in ISO 8601 format, if the targetPublishMode is set to SpecificDate.
tagtag stringstring アドオンのカスタムの開発者データ(この情報は従来タグと呼ばれていました)。The custom developer data for the add-on (this information was previously called the tag).
visibilityvisibility stringstring アドオンの可視性です。The visibility of the add-on. 次のいずれかの値を使用できます。This can be one of the following values:
  • HiddenHidden
  • パブリックPublic
  • PrivatePrivate
  • NotSetNotSet

要求の例Request example

次の例は、アドオンの申請を更新する方法を示しています。The following example demonstrates how to update an add-on submission.

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 応答本文を示しています。The following example demonstrates the JSON response body for a successful call to this method. 応答本文には、更新された申請に関する情報が含まれています。The response body contains information about the updated submission. 応答本文内の値について詳しくは、「アドオンの申請のリソース」をご覧ください。For more details about the values in the response body, see Add-on submission resource.

{
  "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"
}

エラー コードError codes

要求を正常に完了できない場合、次の HTTP エラー コードのいずれかが応答に含まれます。If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

エラー コードError code 説明Description
400400 要求が無効なため、申請を更新できませんでした。The submission could not be updated because the request is invalid.
409409 アドオンでは、現在の状態であるため、送信を更新できませんでしたまたはアドオンであるパートナー センターの機能を使用して現在サポートされていません、Microsoft Store 送信 APIします。The submission could not be updated because of the current state of the add-on, or the add-on uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.