الزامات اتصال شریک

برای درک مزایا و سطح تعهد مورد نیاز برای انتشار یک رابط، نمای کلی انتشار را مرور کنید. برای انتشار یک رابط همکار ، رابط شما باید تمام الزامات شرح داده شده در زیر را برآورده کند.

اسکریپت برنامه‌ها

قبل از ارسال کانکتور خود برای بررسی، موارد زیر را در Apps Script تکمیل کنید:

  1. دسترسی مشاهده پروژه Apps Script خود را با موارد زیر به اشتراک بگذارید :
  2. یک استقرار با نام Production ایجاد کنید و استقرار Production را به نسخه کدی که قصد انتشار آن را دارید، به‌روزرسانی کنید.
  3. تأیید کنید که استقرار Production را به نسخه کدی که می‌خواهید بررسی کنید، به‌روزرسانی کرده‌اید.
  4. تأیید کنید که فایل مانیفست در Apps Script قابل مشاهده است. در سمت چپ، روی پروژه کلیک کنید. کادر انتخاب نمایش فایل مانیفست "appsscript.json" در ویرایشگر را علامت بزنید.

مانیفست

موارد زیر را در مانیفست کانکتور خود وارد کنید و تأیید کنید که پروژه Apps Script شما برای نمایش فایل مانیفست appsscript.json در ویرایشگر پیکربندی شده است.

برای اطلاعات بیشتر به مرجع مانیفست Community Connector مراجعه کنید.

dataStudio

  1. description باید اطلاعات و دستورالعمل‌هایی برای درک اولیه از کانکتور و نحوه استفاده از آن ارائه دهد. کانکتورهایی با توضیحات مبهم و ناقص رد خواهند شد.
  2. addOnUrl باید یک صفحه میزبانی شده اختصاصی در مورد رابط شما باشد، ترجیحاً در دامنه خودتان میزبانی شود. این صفحه باید شامل موارد زیر باشد:
    • سیاست حفظ حریم خصوصی و شرایط استفاده یا پیوندی به این محتوا، در همان دامنه addOnUrl .
    • جزئیاتی که کاربر برای استفاده از کانکتور شما باید بداند.
    • لینک ثبت نام، در صورتی که برای استفاده از رابط شما به حساب کاربری نیاز باشد.
    • محتوا ترجیحاً روی دامنه شما میزبانی شود. میزبانی روی https://sites.google.com/ مجاز نیست.
    • به صفحات نمونه از شرکای فعلی مراجعه کنید: Funnel ، Supermetrics ، CallRail .
  3. supportUrl باید یک صفحه میزبانی شده باشد تا بتوانید از رابط خود پشتیبانی دریافت کنید. این نمی‌تواند یک لینک ایمیل یا mailto باشد.
  4. logoUrl باید به یک تصویر ثابت که تحت کنترل شما میزبانی می‌شود اشاره کند. شما نمی‌توانید از تصاویری که توسط سرویس‌های گوگل در دامنه‌هایی مانند *.gstatic.com ، *.ggpht.com ، *.google.com ، *.googleusercontent.com ارائه می‌شوند استفاده کنید. استفاده از فضای ذخیره‌سازی ابری گوگل برای ارائه تصاویر از دامنه *.googleapis.com قابل قبول است و یک گزینه میزبانی توصیه شده است.
    • رابط‌هایی که آیکون‌های متحرک دارند، رد می‌شوند. از تصاویر ثابت استفاده کنید.
    • توصیه می‌شود حداقل از یک تصویر ۴۸ در ۴۸ پیکسل استفاده کنید.
    • از تصاویر صرفاً متنی که خواندن آنها در ابعاد ۴۸ در ۴۸ پیکسل دشوار است، خودداری کنید.
  5. sources را پر کنید ویژگی با تمام منابعی که کانکتور شما به آنها متصل می‌شود. برای جزئیات بیشتر به مرجع منابع در مانیفست مراجعه کنید.
    • شما می‌توانید لیست منابع موجود را در مخزن ثبت داده‌ها (Data Registry Repository) مشاهده کنید. اگر منبعی که به آن متصل می‌شوید در مخزن وجود ندارد، یک درخواست pull به مخزن ثبت داده‌ها (Data Registry Repository) ارسال کنید تا منبع اضافه شود. اگر منابع موجود در مانیفست شما در مخزن وجود نداشته باشند، اتصال‌دهنده شما در فرآیند بررسی با شکست مواجه خواهد شد.
    • این یک فراداده اضافی برای رابط است که برای قابلیت جستجو در گالری فهرست‌بندی می‌شود. رابط شما هنگامی که کاربران منبع خاصی را در گالری جستجو می‌کنند، در نتایج جستجو نمایش داده می‌شود.
  6. ارائه مقادیر برای shortDescription ، authType ، feeType ، privacyPolicyUrl و termsOfServiceUrl .
  7. name باید مستقیماً هدف کانکتور را نشان دهد. یک نام واضح به کاربران کمک می‌کند تا تشخیص دهند که آیا کانکتور شما نیازهای آنها را برآورده می‌کند یا خیر. از استفاده از کلمه کانکتور در نام خودداری کنید زیرا کاربران از قبل می‌دانند که به یک کانکتور نگاه می‌کنند.
    • از کاراکترهای خاص یا نامرئی با هدف جلب توجه یا تغییر احتمالی موقعیت کانکتور خود استفاده نکنید.
  8. از نام‌های اختصاری برای Data Studio در هیچ کجای مانیفست استفاده نکنید (مثلاً GDS، DS و غیره).
  9. استفاده از ایموجی‌ها در هیچ فیلد مانیفست ( description ، shortDescription ، name و غیره) مجاز نیست. به طور کلی، از کاراکترهای خاص یا نامرئی با هدف جلب توجه به کانکتور خود استفاده نکنید.
  10. اگر کانکتور شما طرحواره ثابتی دارد، یک الگوی گزارش برای کانکتور خود ایجاد کنید و آن را به مانیفست اضافه کنید. اشتراک‌گذاری بر اساس لینک را برای گزارش فعال کنید.

urlFetchWhitelist

  1. تعداد نقاط پایانی فراخوانی شده توسط UrlFetchApp را به مواردی که برای عملکرد کانکتور کاملاً مورد نیاز هستند محدود کنید. ویژگی urlFetchWhitelist را به سطح ریشه مانیفست خود اضافه کنید. برای اطلاعات بیشتر به مرجع urlFetchWhitelist مراجعه کنید.
    • تمام نقاط پایانی مورد استفاده با سرویس UrlFetchApp را لحاظ کنید.
    • اگر کانکتور شما با استفاده از سرویس UrlFetchApp منابع را دریافت نمی‌کند، urlFetchWhitelist را روی یک لیست خالی [] تنظیم کنید.
    • اگر رابط شما به مجموعه‌ای از نقاط پایانی ثابت متصل نمی‌شود یا پیشوند نقطه پایانی متفاوت است، ویژگی urlFetchWhitelist را حذف کنید و هنگام ارسال درخواست بررسی، جزئیات را در فیلد فرم Exception for urlFetchWhitelist ارائه دهید.

oauthScopes

  1. محدوده‌های OAuth را به طور صریح در مانیفست تنظیم کنید . کانکتورهایی که محدوده‌های OAuth صریح نداشته باشند، رد خواهند شد.

کانکتور

  1. اگر کاربر برای استفاده از کانکتور به یک حساب کاربری نیاز دارد، مطمئن شوید که description کانکتور یا لینک addOnUrl دستورالعمل‌هایی برای کمک به کاربر در ایجاد آن ارائه می‌دهد.
  2. کانکتور شما نمی‌تواند در وضعیت ناتمام یا بتا باشد. شما باید یک کانکتور کامل و کاربردی منتشر کنید. همیشه می‌توانید کانکتور خود را به‌روزرسانی کنید، اما نسخه نهایی که برای کاربران منتشر می‌شود باید آزمایش شده و از نظر ویژگی‌ها کامل باشد.
  3. وقتی کاربران با خطای داخلی Connector مواجه می‌شوند، پیام‌های خطای معنادار و قابل پیگیری به آنها ارائه دهید. این شامل مواردی می‌شود که کاربر ورودی نامعتبر/خالی در پیکربندی ارائه می‌دهد.
  4. shortDescription ، description ، addOnUrl link، supportUrl link و صفحه OAuth (در صورت وجود) باید عاری از خطاهای املایی و دستوری باشند.
  5. shortDescription نمی‌تواند شامل URL باشد.
  6. از روش‌های احراز هویت ارائه شده توسط getAuthType() استفاده کنید. از طریق getConfig() درخواست اعتبارنامه نکنید.
  7. فرآیند تأیید اعتبار کلاینت OAuth را تکمیل کنید. تأیید اعتبار برای همه کانکتورها صرف نظر از روش تأیید اعتبار در getAuthType() الزامی است. فرآیند تأیید اعتبار فرآیندی متفاوت از بررسی کانکتور است و توسط یک تیم جداگانه، نه Data Studio، انجام می‌شود. برای اطلاعات بیشتر به سوالات متداول تأیید اعتبار API OAuth مراجعه کنید. در صورت عدم تکمیل فرآیند تأیید اعتبار کلاینت OAuth، کانکتور شما رد خواهد شد.
  8. مطمئن شوید که به شرایط خدمات گالری‌های دیتا استودیو (ارسال‌کننده) پایبند هستید.

پس از اینکه تمام شرایط لازم را رعایت کردید، برای درخواست بررسی کانکتور خود، روی دکمه زیر کلیک کنید:

رابط شریک خود را منتشر کنید