مرجع مانیفست

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

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

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

نوع احراز هویت

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

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

نوع هزینه

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

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

منابع

منابع (Sources) فهرستی از enumها برای منابع است. می‌توانید فهرست منابع موجود را در مخزن ثبت داده‌های ما مشاهده کنید. اگر منبعی که به آن متصل می‌شوید در مخزن وجود ندارد، یک درخواست pull به مخزن ثبت داده‌ها ارسال کنید تا منبع اضافه شود. نام منبع فقط می‌تواند شامل حروف بزرگ و زیرخط باشد (مثلاً Google Analytics برابر با GOOGLE_ANALYTICS خواهد بود). در مانیفست اتصال‌دهنده انجمن خود، از مقدار ویژگی شناسه منبع داده، مثلاً GOOGLE_ANALYTICS ، استفاده کنید.

مثال مانیفست برای یک رابط انجمن

نمونه‌ای از یک مانیفست تکمیل‌شده به شرح زیر است:

دیتا-استودیو/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/"]
}