매니페스트 참조

매니페스트 (appsscript.json)는 Apps Script 커넥터 프로젝트의 JSON 파일입니다. 여기에는 Looker Studio에서 커넥터를 배포하고 사용하는 데 필요한 커뮤니티 커넥터에 대한 특정 정보가 포함되어 있습니다. Apps Script의 매니페스트에 관해 자세히 알아보세요.

매니페스트에는 다음 정보가 포함되어야 합니다.

속성 이름 유형 설명
필수 (dataStudio 속성 아래)
name string 커넥터의 이름입니다.
영문 기준 28자로 제한됨
company string 조직 또는 개발자 이름입니다.
companyUrl string (link) 조직 또는 개발자 웹사이트 링크
logoUrl string (image link) 커넥터 아이콘의 URL입니다.
필수 크기는 40x40픽셀입니다.
addOnUrl string (link) 커넥터의 기능과 커넥터에서 액세스하는 데이터를 설명하는 전용 '자세히 알아보기' 페이지의 링크를 제공합니다. 이 페이지를 호스팅하고 유지해야 합니다.
이 페이지에는 서비스 약관 및 개인정보처리방침이 포함되어 있거나 이러한 페이지로 연결되는 링크가 있어야 합니다.
supportUrl string (link) 이 커넥터를 지원하기 위한 지원 페이지 링크 사용자는 이 링크에서 커넥터 문제를 신고할 수 있습니다. 이 페이지를 호스팅하고 유지해야 합니다.
description string 커넥터에 대한 설명입니다.
사용자는 커넥터 구성 페이지에서 전체 설명을 볼 수 있습니다. 링크를 클릭할 수 있게 됩니다.
선택사항 (dataStudio 속성 아래)
shortDescription string 영문 기준 최대 114자(영문 기준) 커넥터가 게시되면 이 간단한 설명이 커넥터의 갤러리 카드에 표시됩니다. 이 속성을 사용하여 커넥터의 기능을 간략하게 설명합니다. 사용자가 갤러리에서 커넥터를 탐색할 때 이 ID를 볼 수 있습니다.
privacyPolicyUrl string (link) 커넥터 / 개발자 조직의 개인정보처리방침 링크
termsOfServiceUrl string (link) 커넥터 / 개발자 조직의 서비스 약관 링크
authType list(AuthType) 커넥터의 인증 방법 유형입니다. 아래의 AuthType을 참고하세요.
feeType list(FeeType) 커넥터의 요금 유형을 나타냅니다. 아래의 FeeType을 참고하세요.
sources list(Sources) 이 커넥터가 연결할 수 있는 데이터 소스의 목록입니다. 아래의 소스를 참고하세요.
templates Object 이 커넥터와 함께 사용할 수 있는 템플릿 목록입니다. default 키를 설정하여 식별되는 기본 템플릿은 하나만 지원됩니다. 이 값은 템플릿으로 사용할 Looker Studio 보고서의 보고서 ID여야 합니다. 보고서 템플릿 제공에 관한 가이드를 참고하세요.
forceViewersCredentials boolean 이 커넥터에서 만든 데이터 소스에 뷰어의 사용자 인증 정보를 강제로 적용해야 하는지 여부입니다. 이 속성은 선택사항이며 기본값은 false입니다. 뷰어의 사용자 인증 정보에 대한 자세한 내용은 데이터 소스 사용자 인증 정보를 참조하세요.
useQueryConfig boolean 지원 중단됨: 이 커넥터가 `getData()`의 쿼리 구성을 반환하는지 여부입니다. 대신 `advancedServices` 를 사용하세요.
advancedServices.data boolean 이 커넥터가 `getData()`에 대한 쿼리 구성을 반환하는지 여부를 나타냅니다. 고급 서비스를 참조하세요.
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 사용자가 커넥터를 사용하려면 비용을 지불해야 함을 나타냅니다.

출처

source는 소스의 enum 목록입니다. Data Registry 저장소에서 기존 소스 목록을 볼 수 있습니다. 연결하려는 소스가 저장소에 없는 경우 Data Registry Repository로 가져오기 요청을 전송하여 소스를 추가합니다. 소스 이름에는 대문자와 밑줄만 사용할 수 있습니다(예: Google 애널리틱스는 GOOGLE_ANALYTICS임). 커뮤니티 커넥터 매니페스트에서 데이터 소스 ID 속성의 값(예: GOOGLE_ANALYTICS)을 사용합니다.

커뮤니티 커넥터의 매니페스트 예

다음은 완성된 매니페스트의 예입니다.

data-studio/appsscript.json
{
  "dataStudio": {
    "name": "Nucleus by Hooli",
    "company": "Hooli Inc.",
    "companyUrl": "https://hooli.xyz",
    "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
    "addonUrl": "https://hooli.xyz/data-studio-connector",
    "supportUrl": "https://hooli.xyz/data-studio-connector/support",
    "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
    "shortDescription": "Connect to your data using Nucleus middle out optimization",
    "privacyPolicyUrl": "https://hooli.xyz/privacy",
    "termsOfServiceUrl": "https://hooli.xyz/tos",
    "authType": ["NONE"],
    "feeType": ["PAID"],
    "sources": ["HOOLI_CHAT_LOG", "ENDFRAME_SERVER_STREAM", "RETINABYTE_USER_ANALYTICS"],
    "templates": {
      "default": "872223s89f5fdkjnd983kjf"
    }
  },
  "urlFetchWhitelist": [
    "https://api.hooli.xyz/",
    "https://hooli.xyz/"
  ]
}