Adobe XDプラグイン登録のワークフローが変更されました(要対応)

Creative Cloud UI/UX & Web

I/O Developer ConsoleへのAdobe XDプラグインの申請手順に関連する変更が行われました。昨年、プラグインAPIを公開して以来、ユーザーから寄せられたフィードバックを受けての改良です。この影響を受けるのは、XDプラグインマネージャー経由で、新しくプラグインを配布しようと考えている方/公開済みのプラグインを更新しようと考えている方です。

以下は今回の主な変更点です。マニフェストファイルの詳細情報は記事の後半で紹介します。

1. プロジェクト名がプラグイン名から独立

従来のフローでは、プラグイン登録の最初のステップが、公開時に使用することになるユニークなプラグイン名の入力でした。後から変更もできなかったため、最初のステップとしてはハードルが高いと感じていた人が多かったようです。

新しいフローでは、プラグイン名ではなく、プロジェクト名を入力します。この名前はプラグインマネージャーに表示されるプラグイン名とはまったく別のもので、一般に公開されることはありません。また、ユーザーごとにユニークであれば任意の名前を選択できます。例えば、「Test」もプロジェクト名として使えます。さらに、後からプロジェクト名を変更することも可能です。

ということで、これからはとりあえず適当な名前でプロジェクトを登録しても大丈夫です。

2. プラグインページのリニューアル

公開されたプラグインのページのデザインが変更され、Adobe Exchange Program for Creative Cloudへのリンクなど、プラグインのプロモーションに役立つリソースが表示されるようになりました。

3. 登録情報をマニフェストに一本化

従来のプラグイン提出フローでは、プラグインマネージャーに表示される情報をWebフォームに入力することが求められていました。マニフェストの項目と別に管理するのは二重の手間だし確認も面倒という声に応え、新しいフローでは、必要な情報の記述先がマニフェストファイルに一本化されています。

そのため、今後は、プラグインを提出する作業が単純になり、xdxファイルをアップロードしたら、そこから抽出された情報が表示されるページをレビューするだけです。マニフェストの検証もその瞬間に行われるため、従来のように、提出後にエラーの通知を受け取ることはもうありません。

マニフェストファイル仕様の変更点

この変更に伴い、マニフェストの仕様が一部更新されました。新しい仕様はこちらのページに記述されています。この記事では、変更点のみ解説します。

以下は、新しく追加された、もしくは変更があった項目のリストです。開発中のプラグインをXDでテストするだけなら、これからも新しく追加された要素は無しで問題ありません。ただし、プラグインを申請する時までには用意しておきましょう。ひとつでも欠けていると審査を通りません。

  • description: プラグインの説明を3~1,000文字で記述する。プラグインマネージャーの「詳細」をクリックすると表示される
  • summary: プラグインの簡単な紹介を3~30文字で記述する。プラグインマネージャーのリストに表示される
  • languages: プラグインがサポートする言語をISO 639-1に定義されたコードを使って指定する。現在指定可能なコードは、en, de, fr, ja, ko, zh, es, ptのみ
  • author: プラグインの制作者名を3~40文字で記述する。プラグインマネージャーのリストに表示される
  • helpUrl: プラグインのヘルプページのURLを標準的なフォーマットで1,000文字以内で記述する。リンク先のページにはサポートを受ける手段が記述されている必要がある
    (GitHubリポジトリの場合は、README.mdまたは他のマークダウンファイルにリンクして問題を登録する手段を記述するか、問題を投稿するフォームにリンクする。イシューリストへ直接リンクは避けること)
  • icons: 1MB以内の、PNGまたはJPGフォーマットの4種類の大きさの画像[48, 96, 144, 192]を用意して、パスを記述する。プラグインマネージャーのリストに表示される

iconsは新規ではありませんが、4つのアイコンの指定が必要になりました。4つとも以前のアイコンサイズとは異なるサイズです。

下は新しい仕様に従って記述されたマニフェストのサンプルです。太字になっているのが、今回追加または変更された項目です。

{
    "id": "EXAMPLE",
    "name": "EXAMPLE PLUGIN",
    "version": "1.0.0",
    "host": {
        "app": "XD",
        "minVersion": "13.0"
    },
    "description": "Description of your plugin.",
    "summary": "Summary of your plugin.",
    "languages": ["en"],
    "author": "Your Name",
    "helpUrl": "https://mywebsite.com/help",
    "icons": [
        { "width": 48, "height": 48, "path": "images/icon@1x.png" },
        { "width": 96, "height": 96, "path": "images/icon@2x.png" },
        { "width": 144, "height": 144, "path":"images/icon@3x.png"},
        { "width": 192, "height": 192, "path": "images/icon@4x.png"}
    ],
    "uiEntryPoints": [
        {
            "type": "menu",
            "label": "EXAMPLE PLUGIN",
            "commandId": "test"
        }
    ]
}

紹介した必須の項目以外にもオプションの項目が存在します。詳細は、マニフェストの解説ページのTop-level metadataの表をご覧ください。表の中の「Required」の欄に「Develop」と書かれた項目は、XDがプラグインを実行するために必要です。「Publish」と書かれた項目は、I/O Consoleに提出し、プラグインマネージャーに表示させる際に必要です。

今回のマニフェストの変更には、将来のプラグインマネージャー更新の前準備という意味もあるようです。今年の後半には、新しいプラグインマネージャーが公開される予定とのことなので、当面プラグイン更新の予定が無くても、今のうちに準備だけはしておいた方が良さそうです。

POSTED ON 2019.03.11