最初に公開の概要を参照して、コネクタ公開の利点とデベロッパーに求められる役割などを確認してください。コネクタをパートナー コネクタとして公開する場合は、審査のリクエストを送信する前に、以下の要件を満たしているかどうかご確認ください。
Apps Script
- 次の両方のアドレスに Apps Script プロジェクトの閲覧権を共有します。
- デプロイを作成し、
Production
という名前を付けます。Production
デプロイを更新して、公開するコードのバージョンを格納します。 Production
デプロイの作成後にコードに変更を加えた場合は、コネクタを公開する前に、デプロイに選択されているコードが適切なバージョンのものかどうか確認してください。
マニフェスト
コネクタのマニフェストには、以下のプロパティを含める必要があります。各プロパティの詳細については、マニフェスト リファレンスをご覧ください。
description
には、コネクタの基本情報とコネクタを使用するために必要な手順を含めてください。説明が不明瞭または不完全な場合、コネクタは審査で不承認となります。addOnUrl
には、コネクタの専用のホストページを指定します。可能であれば、お客様ご自身のドメインでホストされているページを指定してください。- このページには、
addOnUrl
と同じドメインでホストされているプライバシー ポリシーと利用規約の両方が記載されている(または、その両方にリンクしている)必要があります。 - コネクタを使用するユーザーが知っておくべき詳細情報はすべて、このページに記載してください。
- コネクタを使用するためにアカウント登録が必要な場合は、このページ上に登録用のリンクを表示してください。
- ページは、
https://sites.google.com/
でホストできません。 - サンプルとして、既存のパートナーのページ(Funnel、Supermetrics、CallRail)をご覧ください。
- このページには、
supportUrl
には、ユーザーがコネクタに関するサポートを受けられるホストページを指定してください。メールアドレスまたは mailto リンクを指定することはできません。sources
プロパティには、コネクタが接続するソースをすべて事前に入力しておく必要があります。詳しくは、マニフェスト リファレンスの Sources をご覧ください。- 既存のソースリストは、データ レジストリのリポジトリで確認できます。接続先のソースがリポジトリに存在しない場合は、データ レジストリのリポジトリに pull リクエストを送信して、ソースの追加を依頼してください。マニフェストで指定されているソースがリポジトリに存在しない場合、コネクタは審査で不承認となります。
- この情報は、コネクタのメタデータとして追加され、ギャラリーでコネクタを検索する際のインデックスとして使用されます。ユーザーがギャラリーで該当するデータソースを検索すると、検索結果にこのコネクタが表示されます。
- ギャラリーでは、「データソース別のコネクタ」機能が提供されているので、ユーザーはデータソース別にコネクタを検索することができます。
- コネクタでは、
UrlFetchApp
によって呼び出されるエンドポイントの数を制限する必要があります。コネクタの機能に不可欠なもののみに限定するため、urlFetchWhitelist
プロパティをマニフェストのルートレベルに追加します。詳しくは、urlFetchWhitelist リファレンスをご覧ください。
- このプロパティには、コネクタが
UrlFetchApp
呼び出しを使用して接続するすべての URL が含まれている必要があります。 - コネクタが
UrlFetchApp
の呼び出しを実行しない場合は、プロパティ値を空のリスト[]
に設定してください。 - コネクタが接続するドメインが固定されていないか、エンドポイントの接頭辞が変化する場合は、マニフェストの
urlFetchWhitelist
プロパティは省略してください。
- このプロパティには、コネクタが
- マニフェストには、
shortDescription
、authType
、feeType
、privacyPolicyUrl
、およびtermsOfServiceUrl
の値を含める必要があります。 - コネクタの
name
は、コネクタが具体的に行うことを直接表すものでなければなりません。そうすることで、コネクタの機能が明確になり、ユーザーが必要に適った正しいコネクタを識別することができます。
テンプレートとレポート
- コネクタのスキーマが固定されている場合は、コネクタ用のレポート テンプレートを作成し、マニフェストに追加します。リンクによるレポートの共有を有効にします。
- コネクタのデモレポートを少なくとも 1 つ作成し、データポータルのギャラリーに提出します。デモレポートには、テンプレート レポートのレプリカを使用できます。あるいは、デモ用のレポートを新たに作成して、コネクタの多様な機能を紹介することもできます。
- デモレポートを追加すると、コネクタのプロモーション(特集される、ニュースレターとブログ記事で紹介される、ケーススタディとして取り上げられるなど)のチャンスが得られるようになります。
コネクタ
- コネクタを使用するためにアカウントが必要な場合は、コネクタの
description
かaddOnUrl
リンクで、アカウントを作成するための手順について説明する必要があります。 - 未完成またはベータ版のコネクタを公開することはできません。正常に機能する、完成されたコネクタを公開してください。コネクタはいつでも更新できますが、本番環境デプロイは、リリースする前にテストして、きちんと機能することを確認する必要があります。
- コネクタ内部エラーが発生したときには、具体的な対処方法を示すエラー メッセージをユーザーに表示する必要があります。これには、ユーザーが設定時に無効な値を入力したり、値を空白のままにしたりする場合も含まれます。
- コネクタの
shortDescription
、description
、addOnUrl
リンク、supportUrl
リンク、OAuth ページ(該当する場合)には、変換ミスおよび文法上の誤りがないようにする必要があります。 getAuthType()
で適切な認証方法を使用してください。getConfig()
を使用して認証情報をリクエストしないでください。- OAuth クライアント確認プロセスを完了します。確認は、
getAuthType()
の認証方法に関係なく、すべてのコネクタに必須です。確認プロセスは別のチームによって処理されます。 詳しくは、OAuth API 確認に関するよくある質問をご覧ください。確認プロセスが完了していない場合、コネクタは公開されません。
- OAuth 確認プロセス中に、OAuth 同意画面の設定の一部として、コネクターに必要な OAuth スコープを追加します。必要なすべてのスコープを追加しないと、OAuth 検証プロセスが成功する可能性はありますが、コネクタにはアプリが未確認であることを通知する画面が表示されます。これにより、パートナー コネクタの確認プロセスは失敗します。
OAuth 確認プロセスに成功した後、新しいアカウントを使用してコネクタを承認およびテストし、アプリが未確認であることを通知する画面がユーザーに表示されないようにします。
- OAuth 確認プロセス中に、OAuth 同意画面の設定の一部として、コネクターに必要な OAuth スコープを追加します。必要なすべてのスコープを追加しないと、OAuth 検証プロセスが成功する可能性はありますが、コネクタにはアプリが未確認であることを通知する画面が表示されます。これにより、パートナー コネクタの確認プロセスは失敗します。
- データポータル ギャラリーの利用規約(提出者)を遵守している必要があります。
すべての要件を確認したら、次のボタンをクリックしてコネクタの審査をリクエストしてください。