Microsoft Edge アドオンの更新に REST API を使用する

この REST API を使用して、Microsoft Edge アドオン Web サイトで公開されている拡張機能をプログラムで更新し、拡張機能の新しいバージョンをアップロードして発行するプロセスを自動化します。 これらの REST API エンドポイントを継続的インテグレーション/継続的デリバリー (CI/CD) パイプラインに直接統合して、パートナー センターを使用せずに Microsoft Edge アドオン Web サイトに拡張機能パッケージの更新プログラムを発行できます。

この REST API では、次のエンドポイントが公開されます。

• 既存の申請を更新するためのパッケージのアップロード
• パッケージのアップロードの状態を確認する
• 申請の発行
• 発行状態の確認

これらのエンドポイントについては、以下で説明します。

この REST API を使用するには、まずパートナー センターの [API の発行] ページを使用して API を有効にします。

最初に新しい拡張機能を発行するには、パートナー センターを使用します。 拡張機能を更新するには、パートナー センターを手動で使用するか、プログラムでこの REST API を使用します。

提案とフィードバックを送信するには、 アドオン API に関する問題を入力します。

Update REST API のバージョン

2024 年 9 月 6 日の時点で、この Update REST API の v1.1 と v1 の両方がサポートされています。 v1 のサポートは 2024 年 12 月 31 日に終了します。

使用されるコンポーネント

v1.1

v1.1 では API キーが使用されます。 パートナー センターの UI には API キーが用意されています。

REST エンドポイントでは、v1.1 に特定の要求ヘッダーが使用されます。

v1

v1 では、API エンドポイントにアクセス トークンを送信する必要があります。 アクセス トークンを取得するには、アクセス トークン URL に POST メッセージを送信します。 パートナー センター UI には、アクセス トークンの URL が表示されます。

v1 はシークレットを使用します。 パートナー センターの UI にはシークレットが用意されています。

REST エンドポイントでは、v1 に特定の要求ヘッダーが使用されます。

Update REST API の使用の概要

Update REST API を使用するには:

v1.1

1. パートナー センターの開発者ダッシュボードで、API キーを使用する UI をオプトインします。次の [有効] ボタンをクリックして、新しいエクスペリエンスを有効にします。 詳細については、以下 の「パートナー センターで更新 REST API を有効にする」を参照してください。

2. クライアント ID と新しい API キーを書き留めます。

3. 必要に応じて、認証ワークフローを更新します。

4. API キーの代わりにアクセス トークンを使用するこの REST API の v1 の使用から変更する場合など、API キーの変更によって影響を受ける可能性がある継続的インテグレーション/継続的デリバリー (CI/CD) パイプラインを再構成します。

5. REST エンドポイントを使用する場合は、要求ヘッダーで ClientID キーと API キーを指定します。 詳細については、以下 の「API エンドポイントの使用」を参照してください。

v1

1. パートナー センターの開発者ダッシュボードで、アクセス トークン URL からアクセス トークンを取得します。 詳細については、以下 の「パートナー センターで更新 REST API を有効にする」を参照してください。

2. ClientID とシークレットを生成します。 クライアント ID に対して複数のクライアント シークレットを生成できます。 たとえば、複数のプロジェクトに対して複数のシークレットを作成できます。

3. 必要に応じて、認証ワークフローを更新します。

4. アクセス トークン URL の変更によって影響を受ける可能性がある既存の継続的インテグレーション/継続的デリバリー (CI/CD) パイプラインを再構成します。

5. アクセス トークンを取得します。 詳細については、以下 の「アクセス トークンを取得する」を参照してください。

6. REST エンドポイントを使用する場合は、要求ヘッダーでアクセス トークンを指定します。 詳細については、以下 の「API エンドポイントの使用」を参照してください。

詳細は以下のとおりです。

用語

用語	定義
operation	GET や POST などの REST 操作。
操作 ID	REST 操作の ID。
package	Microsoft Edge アドオンのファイルを含む .zip パッケージ。
積	Microsoft Edge 拡張機能またはテーマ。 Microsoft Edge アドオンとも呼ばれます。
製品 ID	下書きを発行する必要がある製品の製品 ID。 製品 ID は、パートナー センターの製品に関連付けられている 128 ビット GUID です。 例: d34f98f5-f9b7-42b1-bebb-98707202b21d。
提出	パートナー センターで既存の製品に送信される更新プログラム。 製品に対するすべての更新は、状態が In Draft、 In Review、または In the Store (公開) のいずれであるかに関係なく、申請です。

パートナー センターで Update REST API を有効にする

Microsoft Edge アドオン API を使用するには、まず、次のように API 資格情報を作成して、Microsoft パートナー センターでプロジェクトの API を有効にする必要があります。

v1.1

1. パートナー センターの開発者ダッシュボードで、アドオンの発行に使用したアカウントにサインインします。

2. Microsoft Edge プログラムで、[API の発行] を選択します。

3. "新しいエクスペリエンスを有効にする" というメッセージの横にある [ 有効にする ] ボタンをクリックします。

   

   上のスクリーンショットは、[有効] ボタンをクリックして v1.1 UI に切り替える前に、アクセス トークン URL とシークレットを含む v1 UI を示しています。

4. [ API の発行 ] ページで、[ API 資格情報の作成 ] ボタンをクリックします。 この手順が完了するまでに数分かかる場合があります。

   クライアント ID と新しい API キーが自動的に生成されます。

   

   これで API 資格情報が作成されました。API を有効または更新しました。 [ 発行 API] ページに次の項目が表示されるようになりました。

   • クライアント ID。
   • API キー。
     • 各 API キー の有効期限 日。

5. 次のように書き留めます。

   • クライアント ID。
   • 新しい API キー。

   REST エンドポイントを使用する場合は、要求ヘッダーでクライアント ID と API キーを使用します。

v1

1. パートナー センターの開発者ダッシュボードで、アドオンの発行に使用したアカウントにサインインします。

2. Microsoft Edge プログラムで、[API の発行] を選択します。

3. [ API の発行 ] ページで、[ API 資格情報の作成 ] ボタンをクリックします。 この手順が完了するまでに数分かかる場合があります。

   これで API 資格情報が作成されました。API を有効または更新しました。 [ 発行 API] ページに次の項目が表示されるようになりました。

   • クライアント ID。
   • アクセス トークン URL。
   • クライアント シークレット。
     • 各シークレットの有効期限。

   

4. 次のように書き留めます。

   • クライアント ID。
   • アクセス トークン URL。
   • 新しい クライアント シークレット。

   クライアント ID、アクセス トークン URL、およびクライアント シークレットを使用して、アクセス トークンを取得します。アクセス トークンの取得に関するページの下にあります。 次に、REST エンドポイントを使用するときに、要求ヘッダーのアクセス トークンを使用します。

重要

API を有効または更新した直後 (つまり、API 資格情報を作成した後) にのみ表示されるので、クライアント シークレットを今すぐ書き留めておいてください。 この特定のシークレットは再び表示されません。

クライアント ID に対して複数のクライアント シークレットを生成できます。 たとえば、複数のプロジェクトに対して複数のシークレットを作成できます。

アクセス トークンを取得する

アクセス トークンを取得するには、アクセス トークン URL に POST メッセージを送信します。 パートナー センター UI には、この記事と同じアクセス トークン URL が表示されます。 次に、既存の 申請を更新するためにパッケージをアップロードするためのエンドポイントなど、API エンドポイントを使用する場合は、ヘッダーにアクセス トークンを含めます。

アクセス トークンの取得に使用するエンドポイントの説明:

Endpoint: https://login.microsoftonline.com/5c9eedce-81bc-42f3-8823-48ba6258b391/oauth2/v2.0/token
Type: POST
Header Parameters: Content-Type: application/x-www-form-urlencoded

要求のサンプル

たとえば、アクセス トークンを取得するには、コマンド プロンプトで次のように curl コマンドを入力して、アクセス トークン URL に POST 要求を送信します。

> curl \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "client_id={$Client_ID}" \
-d "scope=https://api.addons.microsoftedge.microsoft.com/.default" \
-d "client_secret={$Client_Secret}" \
-d "grant_type=client_credentials" \
-v \
https://login.microsoftonline.com/5c9eedce-81bc-42f3-8823-48ba6258b391/oauth2/v2.0/token

応答のサンプル

次のようなアクセス トークンが返されます。

{
  "token_type": "Bearer",
  "expires_in": 3599,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1uQ19WWmNBVGZNNXBP..."
}

詳細については、「Microsoft ID プラットフォームでトークンを取得する」と「OAuth 2.0 クライアント資格情報フロー」を参照してください。

API エンドポイントの使用

Update REST API では、次のエンドポイントが公開されます。

• 既存の申請を更新するためのパッケージのアップロード
• パッケージのアップロードの状態を確認する
• 申請の発行
• 発行状態の確認

これらのエンドポイントを以下に紹介します。

この Microsoft Edge アドオン Update REST API を使用するには、上記に従って次のものが必要です。

v1.1

API キーとクライアント ID。

v1

アクセス トークン。

API は、エンドポイント ルート https://api.addons.microsoftedge.microsoft.comで使用できます。

次の REST API エンドポイントはありません。

• 新しい製品の作成。
• 説明など、製品のメタデータを更新する。

新しい製品を作成したり、製品のメタデータを更新したりするには、Microsoft パートナー センターを使用する必要があります。

既存の申請を更新するためのパッケージのアップロード

この REST API エンドポイントを使用して、アドオンのパッケージを更新します。 この API は、アドオン製品の既存の下書き申請を更新するパッケージをアップロードします。

「Microsoft Edge アドオンを更新するための REST API リファレンス」の「パッケージをアップロードして既存の申請を更新する」も参照してください。

エンドポイントの説明

v1.1

Endpoint: /v1/products/$productID/submissions/draft/package
Type: POST
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID; Content-Type: application/zip
Body content: the package file to upload

v1

Endpoint: /v1/products/$productID/submissions/draft/package
Type: POST
Header Parameters: Authorization: Bearer $TOKEN; Content-Type: application/zip
Body content: the package file to upload

$productID は、更新する Microsoft Edge アドオンの製品 ID です。

製品 ID を取得するには:

1. パートナー センター開発者ダッシュボードにサインインします。

2. [Microsoft Edge>Overview] に移動します。

3. 製品 ID が必要な拡張機能を選択します。

   [ 拡張機能の概要] ページが開きます。 製品 ID がページに表示されます。 (製品 ID は、 microsoftedge/ と /packagesの間のアドレス バーの URL にも GUID として表示されます)。

4. [ 拡張機能 ID ] セクション (またはアドレス バーから) で、 製品 ID を選択してコピーします。

要求のサンプル

パッケージをアップロードして既存の申請を更新するには、コマンド プロンプトで次のように curl コマンドを使用します。

v1.1

> curl \
-H "Authorization: ApiKey $ApiKey" \
-H "X-ClientID: $ClientID" \
-H "Content-Type: application/zip" \
-X POST \
-T $FILE_NAME \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package

v1

> curl \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/zip" \
-X POST \
-T $FILE_NAME \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package

要求が成功し、更新プロセスが開始されると、Location ヘッダーを含む202 Accepted応答状態コードを受け取ります。 この場所ヘッダーには、更新操作の状態を確認するために必要な operationID が含まれています。

関連項目:

• Microsoft Edge アドオンを更新するための REST API リファレンスで既存の申請を更新するパッケージをアップロードします。

パッケージのアップロードの状態を確認する

この API を使用して、パッケージのアップロードの状態をチェックします。

$operationID は、 既存の申請を更新するためのパッケージのアップロードまたは申請 の 発行から応答ヘッダーで返される操作 ID です。

Microsoft Edge アドオンの更新については、「REST API リファレンスで発行状態を確認する」も参照してください。

エンドポイントの説明

v1.1

Endpoint: /v1/products/$productID/submissions/draft/package/operations/$operationID
Type: GET
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID

v1

Endpoint: /v1/products/$productID/submissions/draft/package/operations/$operationID
Type: GET
Header Parameters: Authorization: Bearer $TOKEN

要求のサンプル

パッケージのアップロードの状態をチェックするには、コマンド プロンプトで次のように curl コマンドを使用します。

v1.1

> curl \
-H "Authorization: ApiKey $ApiKey" \
-H "X-ClientID: $ClientID" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package/operations/$operationID

v1

> curl \
-H "Authorization: Bearer $TOKEN" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package/operations/$operationID

関連項目:

• Microsoft Edge アドオンを更新するための REST API リファレンスでパッケージのアップロードの状態を確認します。

申請の発行

この API を使用して、製品の現在のドラフトを Microsoft Edge アドオン Web サイトに公開します。

Microsoft Edge アドオンの更新については、「REST API リファレンス」の「製品ドラフト申請を発行する」も参照してください。

エンドポイントの説明

v1.1

Endpoint: /v1/products/$productID/submissions
Type: POST
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID
Body content: Notes for certification, in JSON format

v1

Endpoint: /v1/products/$productID/submissions
Type: POST
Header Parameters: Authorization: Bearer $TOKEN
Body content: Notes for certification, in JSON format

要求のサンプル

申請を発行するには、コマンド プロンプトで次のように curl コマンドを使用します。

v1.1

> curl \
-H "Authorization: ApiKey $ApiKey" \
-H "X-ClientID: $ClientID" \
-X POST \
-d '{ "notes"="text value" }' \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions

v1

> curl \
-H "Authorization: Bearer $TOKEN" \
-X POST \
-d '{ "notes"="text value" }' \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions

要求が成功し、発行プロセスが開始されると、Location ヘッダーを含む202 Accepted応答状態コードが表示されます。 この場所ヘッダーには、発行操作の状態を確認するために必要な operationID が含まれています。

関連項目:

• Microsoft Edge アドオンを更新するための REST API リファレンスで製品ドラフト申請を発行します。

発行状態の確認

発行操作の状態をチェックするには、この API を使用します。

$operationID は、 既存の申請を更新するためのパッケージのアップロードまたは申請 の 発行から応答ヘッダーで返される操作 ID です。

Microsoft Edge アドオンの更新については、「REST API リファレンスで発行状態を確認する」も参照してください。

エンドポイントの説明

v1.1

Endpoint: /v1/products/$productID/submissions/operations/$operationID
Type: GET
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID

v1

Endpoint: /v1/products/$productID/submissions/operations/$operationID
Type: GET
Header Parameters: Authorization: Bearer $TOKEN

要求のサンプル

発行状態をチェックするには、コマンド プロンプトで次のように curl コマンドを使用します。

v1.1

> curl \
-H "Authorization: ApiKey $ApiKey" \
-H "X-ClientID: $ClientID" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/operations/$operationID

v1

> curl \
-H "Authorization: Bearer $TOKEN" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/operations/$operationID

関連項目:

• Microsoft Edge アドオンを更新するには、REST API リファレンスの発行状態を確認します。

関連項目

• Microsoft Edge アドオンを更新するための REST API リファレンス - 拡張機能を更新するための REST API。
• Microsoft Edge 拡張機能でサポートされている API - 拡張機能 を開発するための JavaScript API。

GitHub:

• Microsoft Edge Developer ドキュメントedge-developerリポジトリの問題。

Microsoft ID プラットフォーム:

• Microsoft ID プラットフォームと OAuth 2.0 クライアント資格情報フロー