パートナー コネクタの要件

公開の概要で、コネクタを公開するメリットと、必要なコミットメントのレベルを把握します。パートナー コネクタを公開するには、コネクタが以下の要件をすべて満たしている必要があります。

Apps Script

審査のためにコネクタを送信する前に、Apps Script で次の手順を完了します。

  1. 以下と Apps Script プロジェクトの表示アクセス権を共有します。
  2. Production という名前の Deployment を作成し、Production Deployment を公開するコードのバージョンに更新します。
  3. Production Deployment が、レビューするコードのバージョンに更新されていることを確認します。
  4. マニフェスト ファイルが Apps Script に表示されることを確認します。左側の [プロジェクトの設定] をクリックします。[「appsscript.json」マニフェスト ファイルをエディタで表示する] チェックボックスをオンにします。

マニフェスト

コネクタのマニフェストに以下を追加して、エディタに appsscript.json マニフェスト ファイルを表示するように Apps Script プロジェクトが構成されていることを確認します。

詳しくは、コミュニティ コネクタのマニフェスト リファレンスをご覧ください。

dataStudio

  1. description に、コネクタの基本を理解するための情報と手順が示されます。説明が不明瞭で不完全なコネクタは承認されません。
  2. addOnUrl には、コネクタに関する専用のホストページを指定します。可能であれば、独自のドメインでホストされているページを指定してください。ページには次のものを含める必要があります。
    • プライバシー ポリシー利用規約、またはこのコンテンツへのリンク(addOnUrl と同じドメイン)。
    • コネクタを使用するユーザーが知っておく必要がある詳細情報。
    • 登録用リンク(コネクタの使用にアカウントが必要な場合は)。
    • 希望するドメインでホストされるコンテンツ。https://sites.google.com/ でホストすることはできません。
    • サンプルとして、既存のパートナーのページ(FunnelSupermetricsCallRail)をご覧ください。
  3. supportUrl は、コネクタのサポートを受けるためにホストされたページである必要があります。メールアドレスまたは mailto リンクを指定することはできません。
  4. logoUrl は、コントロールでホストされている静的画像を指している必要があります。*.gstatic.com*.ggpht.com*.google.com*.googleusercontent.com などのドメインで Google サービスから提供されるイメージを使用することはできません。Google Cloud Storage を使用して *.googleapis.com ドメインから画像を提供することも可能で、ホスティング オプションとしておすすめです。
    • アニメーション アイコンが表示されているコネクタは承認されません。静止画像を使用します。
    • 48×48 ピクセル以上の画像を使用することをおすすめします。
    • 48×48 ピクセルに縮小したときに読みにくいテキストのみの画像は使用しないでください。
  5. sources プロパティに、コネクタが接続するすべてのソースを入力します。詳しくは、マニフェスト リファレンスのソースをご覧ください。
    • 既存のソースリストは、データ レジストリ リポジトリで確認できます。接続先のソースがリポジトリに存在しない場合は、データ レジストリ リポジトリに pull リクエストを送信してソースを追加します。マニフェストのソースがリポジトリに存在しない場合、コネクタはレビュー プロセスで失敗します。
    • この情報は、コネクタのメタデータとして追加され、ギャラリーでコネクタを検索する際のインデックスとして使用されます。ユーザーがギャラリーで特定のソースを検索すると、コネクタが検索結果に表示されます。
  6. shortDescriptionauthTypefeeTypeprivacyPolicyUrltermsOfServiceUrl に値を指定します。
  7. name は、コネクタの目的を直接表している必要があります。わかりやすい名前は、コネクタがニーズを満たしているかどうかを判断するのに役立ちます。ユーザーがすでにコネクタを指していることがわかっているため、名前に「コネクタ」という単語は使用しないでください。
    • コネクタの位置に注意を向けたり、位置を変更したりする目的で、特殊文字や非表示の文字を含めないでください。
  8. マニフェストの任意の場所に Looker Studio の略称を使用しないでください(GDS、DS など)。
  9. マニフェスト フィールド(descriptionshortDescriptionname など)では絵文字を使用できません。通常は、コネクタに注目を引くことを意図して特殊文字や非表示文字を使用しないでください。
  10. コネクタのスキーマが固定されている場合は、コネクタのレポート テンプレートを作成してマニフェストに追加します。レポートの [リンクで共有] を有効にします。

urlFetchWhitelist

  1. UrlFetchApp によって呼び出されるエンドポイントの数を、コネクタ機能に絶対に必要なエンドポイントに限定します。urlFetchWhitelist プロパティをマニフェストのルートレベルに追加します。詳細については、urlFetch ホワイトリストのリファレンスをご覧ください。
    • UrlFetchApp サービスで使用されるすべてのエンドポイントを含めます。
    • コネクタが UrlFetchApp サービスを使用してリソースを取得しない場合は、urlFetchWhitelist を空のリスト [] に設定します。
    • コネクタが固定エンドポイントのセットに接続しない場合、またはエンドポイントのプレフィックスが異なる場合は、urlFetchWhitelist プロパティを省略し、確認リクエストを送信するときに [urlFetchFetch の例外] フォーム フィールドに詳細を入力してください。

oauthScopes

  1. マニフェストで明示的な OAuth スコープを設定します。明示的な OAuth スコープのないコネクタは拒否されます。

コネクタ

  1. コネクタを使用するためにアカウントが必要な場合は、コネクタの descriptionaddOnUrl リンクで、アカウントを作成するための手順について説明する必要があります。
  2. 未完成またはベータ版のコネクタを公開することはできません。正常に機能する、完成されたコネクタを公開してください。コネクタはいつでも更新できますが、本番環境デプロイは、リリースする前にテストして、きちんと機能することを確認する必要があります。
  3. コネクタ内部エラーが発生したときには、具体的な対処方法を示すエラー メッセージをユーザーに表示する必要があります。これには、ユーザーが設定時に無効な値を入力したり、値を空白のままにしたりする場合も含まれます。
  4. shortDescriptiondescriptionaddOnUrl リンク、supportUrl リンク、OAuth ページ(該当する場合)に、スペルや文法上の誤りがないようにする必要があります。
  5. shortDescription に URL を含めることはできません。
  6. getAuthType() が提供する認証方法を使用します。getConfig() で認証情報をリクエストしないでください。
  7. OAuth クライアント確認プロセスを完了します。確認は、getAuthType() の認証方法に関係なく、すべてのコネクタに必須です。検証プロセスはコネクタのレビューとは異なるプロセスであり、Looker Studio ではなく別のチームが処理されます。詳しくは、OAuth API の確認に関するよくある質問をご覧ください。OAuth クライアントの確認プロセスが完了していない場合、コネクタは拒否されます。
    • OAuth 検証プロセスで、OAuth 同意画面の構成の一部として、コネクタに必要な OAuth スコープを追加します。必要なスコープをすべて追加しないと、OAuth 検証プロセスには合格する可能性がありますが、コネクタには未確認アプリ画面が表示されます。これにより、パートナー コネクタの検証プロセスが失敗します。
      OAuth 確認プロセスに合格した後、新しいアカウントを使用してコネクタを承認およびテストし、未確認アプリ画面がユーザーに表示されないようにします。
  8. Looker Studio ギャラリーの利用規約(提出者)を遵守していることを確認します。

すべての要件を確認したら、次のボタンをクリックしてコネクタの審査をリクエストしてください。

パートナー コネクタを公開する