マニフェスト(appsscript.json
)は Apps Script コネクタ プロジェクトの JSON ファイルであり、このページには、コミュニティ コネクタに関する特定の情報が含まれています。
Looker Studio でコネクタをデプロイして使用するために必要です。詳しくは、Apps Script のマニフェストをご覧ください。
マニフェストには、次の情報が含まれている必要があります。
プロパティ名 | 型 | 説明 |
---|---|---|
必須(dataStudio の下位プロパティ)
|
||
name
|
string
|
コネクタの名前。 28 文字以内で指定します。 |
company
|
string
|
組織またはデベロッパーの名前。 |
companyUrl
|
string (link)
|
組織またはデベロッパーのウェブサイトへのリンク。 |
logoUrl
|
string (image link)
|
コネクタのアイコンへの URL。 サイズは 40×40 ピクセルにする必要があります。 |
addOnUrl
|
string (link)
|
コネクタの動作とアクセスするデータを説明する専用の「詳細」ページへのリンク。このページをホストして保守する必要があります。 このページに、利用規約とプライバシー ポリシー(またはそれらのページへのリンク)を含めてください。 |
supportUrl
|
string (link)
|
このコネクタのサポートページへのリンク。ユーザーがこのリンクからコネクタの問題を報告できるようにします。このページをホストして保守する必要があります。 |
description
|
string
|
コネクタの説明。 説明の全文はコネクタの設定ページに表示されます。リンクはクリック可能です。 |
省略可(dataStudio の下位のプロパティ)
|
||
shortDescription
|
string
|
上限: 半角 114 文字(全角 57 文字)。コネクタが公開されている場合は、この簡単な説明がコネクタのギャラリー カードに表示されます。コネクタの機能について簡潔に説明してください。ユーザーは、ギャラリー内のコネクタをブラウジングするときにこの説明を読むことができます。 |
privacyPolicyUrl
|
string (link)
|
コネクタまたはデベロッパーの会社で規定されているプライバシー ポリシーへのリンク。 |
termsOfServiceUrl
|
string (link)
|
コネクタまたはデベロッパーの会社で規定されている利用規約へのリンク。 |
authType
|
list(AuthType)
|
コネクタの認証方法のタイプ。後述の AuthType をご覧ください。 |
feeType
|
list(FeeType)
|
コネクタの料金タイプ。後述の FeeType をご覧ください。 |
sources
|
list(Sources)
|
このコネクタが接続できるデータソースのリスト。後述の Sources をご覧ください。 |
templates
|
Object
|
このコネクタで使用できるテンプレートのリスト。サポートされているデフォルト テンプレートは 1 つのみで、default キーを設定して識別します。値には、Looker のレポート ID を指定します。
テンプレートとして使用される Studio レポートです。レポート テンプレートの提供のガイドをご覧ください。 |
forceViewersCredentials
|
boolean
|
このコネクタから作成されるデータソースに対して、閲覧者の認証情報の使用を強制するかどうか指定します。このプロパティは省略可能で、デフォルト値は false です。閲覧者の認証情報について詳しくは、データソースの認証情報をご覧ください。 |
useQueryConfig
|
boolean
|
非推奨: このコネクタが次のクエリ構成を返すかどうか `getData()`.代わりに「advancedServices」を使用してください。 |
advancedServices.data
|
boolean
|
このコネクタが `getData()` のクエリ設定を返すかどうかを指定します。Advanced Services をご覧ください。 |
advancedServices.schema
|
boolean
|
このコネクタが次のクエリ構成を返すかどうか `getSchema()`.上級者向け サービス。 |
省略可(ルートレベルのプロパティ) | ||
urlFetchWhitelist
|
list(string)
|
コネクタが使用する HTTPS URL 接頭辞のリスト。取得された URL エンドポイントは、このリストのいずれかの接頭辞に一致する必要があります。このプロパティは、ユーザーデータの保護に役立ちます。セーフリスティング情報をご覧ください。 URL をご覧ください。 |
AuthType
認証方式の種類の値は次のいずれかになります。
列挙値 | 説明 |
---|---|
NONE
|
コネクタに認証が必要ないことを示します。 |
OAUTH2 |
コネクタが OAuth 2.0 を使用することを示します。 |
KEY |
コネクタが API キーを使用することを示します。 |
USER_PASS |
コネクタがユーザー名/パスワードを使用することを示します。 |
USER_TOKEN |
コネクタがユーザー名/トークンを使用することを示します。 |
PATH_USER_PASS |
コネクタがパス/ユーザー名/パスワードを使用することを示します。 |
PATH_KEY |
コネクタがパス/キーを使用することを示します。 |
FeeType
料金タイプの値は、次のいずれかになります。
列挙値 | 説明 |
---|---|
FREE |
コネクタが無料で使用できることを示します。 |
FREE_TRIAL |
コネクタに無料のトライアル オプションがあることを示します。 |
PAID |
コネクタを使用するには料金の支払いが必要であることを示します。 |
Sources
Sources は、ソースの列挙値のリストです。既存のソースリストは、データ レジストリのリポジトリで確認できます。接続先のソースがリポジトリに存在しない場合は、データ レジストリのリポジトリに pull リクエストを送信して、ソースの追加を依頼してください。ソース名に使用できるのは大文字とアンダースコアのみです(例: Google アナリティクスは GOOGLE_ANALYTICS
になります)。コミュニティ コネクタ マニフェストで、データソース ID プロパティの値(GOOGLE_ANALYTICS
など)を使用します。
コミュニティ コネクタのマニフェストの例
完成したマニフェストの例を次に示します。