مرجع مانیفست

مانیفست ( appsscript.json ) یک فایل JSON در پروژه اتصال Apps Script شما است. حاوی اطلاعات خاصی در مورد Connector Community شما است که برای استقرار و استفاده از رابط شما در Looker Studio لازم است. درباره مانیفست‌ها در Apps Script بیشتر بخوانید.

مانیفست شما باید حاوی اطلاعات زیر باشد:

نام ملک تایپ کنید شرح
مورد نیاز (تحت ویژگی dataStudio )
name string نام کانکتور شما
محدود به 28 کاراکتر
company string نام سازمان یا توسعه دهنده.
companyUrl string (link) پیوند به وب سایت سازمان یا توسعه دهنده.
logoUrl string (image link) نشانی وب یک نماد برای رابط شما.
ابعاد مورد نیاز 40 پیکسل در 40 پیکسل است.
addOnUrl string (link) به صفحه اختصاصی «بیشتر بیاموزید» پیوند دهید که باید توضیح دهد که رابط شما چه کار می کند و داده هایی که به آن دسترسی دارد. شما باید این صفحه را میزبانی و نگهداری کنید.
این صفحه باید شامل شرایط خدمات و خط مشی رازداری شما باشد یا به آن پیوند داشته باشد.
supportUrl string (link) برای پشتیبانی از این رابط به صفحه پشتیبانی پیوند دهید. کاربران باید بتوانند مشکلات مربوط به رابط شما را در این پیوند گزارش کنند. شما باید این صفحه را میزبانی و نگهداری کنید.
description string توضیحات برای رابط شما.
کاربران توضیحات کامل را در صفحه پیکربندی رابط شما خواهند دید. لینک ها قابل کلیک خواهند بود.
اختیاری (تحت ویژگی dataStudio )
shortDescription string محدودیت: 114 کاراکتر. اگر رابط شما منتشر شده باشد، این توضیحات کوتاه در کارت گالری رابط شما قابل مشاهده خواهد بود. از این برای توضیح مختصر آنچه که کانکتور شما انجام می دهد استفاده کنید. هنگامی که کاربران از طریق رابط‌های موجود در گالری مرور می‌کنند، می‌توانند این را مشاهده کنند.
privacyPolicyUrl string (link) پیوند به خط مشی رازداری برای سازمان رابط / توسعه دهنده.
termsOfServiceUrl string (link) پیوند به شرایط خدمات برای سازمان رابط / توسعه دهنده.
authType list( AuthType ) نوع روش احراز هویت برای رابط شما. AuthType را در زیر ببینید.
feeType list( FeeType ) نوع کارمزد کانکتور شما را نشان می دهد. FeeType را در زیر ببینید.
sources list( Sources ) فهرست منابع داده ای که این رابط می تواند به آنها متصل شود. به منابع زیر مراجعه کنید.
templates Object لیست قالب هایی که می توان با این رابط استفاده کرد. فقط یک الگوی پیش‌فرض پشتیبانی می‌شود که با تنظیم یک کلید default شناسایی می‌شود. مقدار باید شناسه گزارش گزارش Looker Studio باشد که به عنوان الگو استفاده می شود. به راهنمای ارائه الگوهای گزارش مراجعه کنید.
forceViewersCredentials boolean اینکه آیا اعتبار بیننده باید برای منابع داده ایجاد شده از این رابط اجباری شود یا نه. این ویژگی اختیاری است و به طور پیش فرض false است. برای جزئیات بیشتر در مورد اعتبار بیننده، به اعتبار منبع داده مراجعه کنید.
useQueryConfig boolean منسوخ شده : اینکه آیا این رابط پیکربندی پرس و جو را برای «getData()» برمی گرداند یا نه. به جای آن از AdvancedServices استفاده کنید.
advancedServices.data boolean اینکه آیا این رابط پیکربندی پرس و جو را برای «getData()» برمی گرداند یا نه. خدمات پیشرفته را ببینید.
advancedServices.schema boolean اینکه آیا این رابط پیکربندی پرس و جو را برای «getSchema()» برمی گرداند یا نه. خدمات پیشرفته را ببینید.
اختیاری (ویژگی سطح ریشه)
urlFetchWhitelist list(string) فهرستی از پیشوندهای URL HTTPS که رابط شما استفاده می کند. هر نقطه پایان URL واکشی شده باید با یکی از پیشوندهای این لیست مطابقت داشته باشد. این می تواند به محافظت از داده های کاربر کمک کند. برای جزئیات بیشتر به فهرست کردن URL ها مراجعه کنید.

AuthType

مقادیر برای نوع روش احراز هویت می تواند یکی از موارد زیر باشد:

مقدار Enum شرح
NONE نشان می دهد که برای کانکتور نیازی به احراز هویت نیست.
OAUTH2 نشان می دهد که کانکتور از OAuth 2.0 استفاده می کند.
KEY نشان می دهد که کانکتور از کلید API استفاده می کند.
USER_PASS نشان می دهد که رابط از نام کاربری/رمز عبور استفاده می کند.
USER_TOKEN نشان می دهد که رابط از نام کاربری/توکن استفاده می کند.
PATH_USER_PASS نشان می دهد که رابط از مسیر / نام کاربری / رمز عبور استفاده می کند.
PATH_KEY نشان می دهد که کانکتور از مسیر/کلید استفاده می کند.

FeeType

مقادیر برای نوع کارمزد می تواند یکی از موارد زیر باشد:

مقدار Enum شرح
FREE نشان می دهد که کانکتور برای استفاده کاملا رایگان است.
FREE_TRIAL نشان می دهد که کانکتور دارای گزینه آزمایشی رایگان است.
PAID نشان می دهد که کاربر برای استفاده از کانکتور نیاز به پرداخت هزینه دارد.

منابع

منابع فهرستی از فهرست های فهرست منابع است. می‌توانید فهرست منابع موجود را در مخزن ثبت داده‌های ما مشاهده کنید. اگر منبعی که به آن متصل می شوید در مخزن وجود ندارد، یک درخواست کشش به مخزن ثبت داده ارسال کنید تا منبع را اضافه کنید. نام منبع فقط می تواند شامل نویسه های بزرگ و زیرخط باشد (به عنوان مثال Google Analytics GOOGLE_ANALYTICS خواهد بود). در مانیفست Connector Community خود، از مقدار ویژگی شناسه منبع داده، به عنوان مثال 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/"
  ]
}