الزامات اتصال شریک
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
برای درک مزایا و سطح تعهد لازم برای انتشار یک رابط، نمای کلی انتشار را مرور کنید. برای انتشار یک رابط شریک ، رابط شما باید همه شرایطی را که در زیر توضیح داده شده است، برآورده کند.
اسکریپت برنامه ها
قبل از ارسال رابط خود برای بررسی، موارد زیر را در Apps Script تکمیل کنید:
- دسترسی مشاهده پروژه Apps Script خود را با موارد زیر به اشتراک بگذارید :
- یک استقرار به نام
Production ایجاد کنید و استقرار Production را به نسخه کدی که قصد انتشار آن را دارید به روز کنید. - تأیید کنید که استقرار
Production را به نسخه کدی که می‌خواهید بازبینی کنید، به‌روزرسانی کرده‌اید. - تأیید کنید که فایل مانیفست در Apps Script قابل مشاهده است. در سمت چپ، روی settings تنظیمات پروژه کلیک کنید. کادر بررسی نمایش فایل مانیفست "appsscript.json" در ویرایشگر را انتخاب کنید.
آشکار
موارد زیر را در مانیفست رابط خود وارد کنید و تأیید کنید که پروژه Apps Script شما برای نمایش فایل مانیفست appsscript.json در ویرایشگر پیکربندی شده است.
برای اطلاعات بیشتر ، مرجع مانیفست Connector Community را مشاهده کنید.
dataStudio
-
description باید اطلاعات و دستورالعمل هایی را برای درک اولیه کانکتور و نحوه استفاده از آن ارائه دهد. رابط هایی با توضیحات مبهم و ناقص رد می شوند. -
addOnUrl باید یک صفحه میزبان اختصاصی در مورد رابط شما باشد، ترجیحاً در دامنه خود میزبانی شود. صفحه باید شامل موارد زیر باشد:- یک خط‌مشی رازداری و شرایط استفاده یا پیوندی به این محتوا، در همان دامنه
addOnUrl . - جزئیاتی که کاربر برای استفاده از رابط شما باید بداند.
- پیوند ثبت نام، در صورتی که برای استفاده از رابط شما نیاز به حساب کاربری دارید،.
- محتوایی که ترجیحاً در دامنه شما میزبانی می شود. میزبانی در
https://sites.google.com/ مجاز نیست. - صفحات نمونه از شرکای موجود را ببینید: Funnel ، Supermetrics ، CallRail .
-
supportUrl باید یک صفحه میزبان برای دریافت پشتیبانی از کانکتور شما باشد. این نمی تواند یک پیوند ایمیل یا نامه به ایمیل باشد. -
logoUrl باید به یک تصویر ثابت که تحت کنترل شما میزبانی می شود اشاره کند. شما نمی توانید از تصاویر ارائه شده توسط سرویس های Google در دامنه هایی مانند *.gstatic.com ، *.ggpht.com ، *.google.com ، *.googleusercontent.com استفاده کنید. استفاده از Google Cloud Storage برای ارائه تصاویر از دامنه *.googleapis.com قابل قبول است و یک گزینه میزبانی توصیه شده است.- اتصالات دارای نمادهای متحرک رد خواهند شد. از تصاویر ثابت استفاده کنید.
- توصیه می شود حداقل از یک تصویر 48x48 پیکسل استفاده کنید.
- از تصاویر فقط متنی که خواندن آنها با کوچک شدن تا 48x48 پیکسل دشوار است خودداری کنید.
-
sources را پر کنید دارایی با تمام منابعی که کانکتور شما به آنها متصل است. برای جزئیات بیشتر به منابع در مرجع مانیفست مراجعه کنید.- می‌توانید فهرست منابع موجود را در Data Registry Repository مشاهده کنید. اگر منبعی که به آن متصل می شوید در مخزن وجود ندارد، یک درخواست کشش به مخزن ثبت داده ارسال کنید تا منبع را اضافه کنید. اگر منابع موجود در مانیفست شما در مخزن وجود نداشته باشند، کانکتور شما فرآیند بررسی را با شکست مواجه خواهد کرد.
- این ابرداده اضافی برای رابط است که برای ویژگی جستجو در گالری نمایه می شود. هنگامی که کاربران منبع خاصی را در گالری جستجو می کنند، رابط شما در نتایج جستجو نشان داده می شود.
- ارائه مقادیر برای
shortDescription ، authType ، feeType ، privacyPolicyUrl ، و termsOfServiceUrl . -
name باید به طور مستقیم هدف اتصال را نشان دهد. یک نام واضح به کاربران کمک می کند تا تشخیص دهند که آیا رابط شما نیازهای آنها را برآورده می کند یا خیر. از استفاده از کلمه اتصال در نام خودداری کنید زیرا کاربران از قبل می دانند که به یک رابط نگاه می کنند.- نویسه‌های خاص یا غیرقابل مشاهده را به قصد جلب توجه یا تغییر بالقوه موقعیت کانکتور خود وارد نکنید.
- از نام های کوتاه برای Looker Studio در هیچ کجای مانیفست استفاده نکنید (مانند GDS، DS، و غیره).
- ایموجی ها در هیچ فیلد مانیفست مجاز نیستند (
description ، shortDescription ، name ، و غیره). به طور کلی، کاراکترهای خاص یا غیر قابل مشاهده را به قصد جلب توجه به رابط خود وارد نکنید. - اگر کانکتور شما طرحی ثابت دارد، یک الگوی گزارش برای رابط خود ایجاد کنید و آن را به مانیفست اضافه کنید. اشتراک گذاری با پیوند را برای گزارش فعال کنید.
urlFetchWhitelist
- تعداد نقاط پایانی فراخوانی شده توسط
UrlFetchApp را به نقاط پایانی که برای عملکرد رابط ضروری هستند محدود کنید. ویژگی urlFetchWhitelist را به سطح ریشه مانیفست خود اضافه کنید. برای اطلاعات بیشتر ، مرجع urlFetchWhitelist را مشاهده کنید.
- شامل تمام نقاط پایانی مورد استفاده با سرویس
UrlFetchApp باشد. - اگر رابط شما منابع را با استفاده از سرویس
UrlFetchApp واکشی نمی کند، urlFetchWhitelist روی یک لیست خالی [] تنظیم کنید. - اگر رابط شما به مجموعه‌ای از نقاط پایانی ثابت وصل نمی‌شود یا پیشوند نقطه پایانی متفاوت است، ویژگی
urlFetchWhitelist را حذف کنید و هنگام ارسال درخواست بررسی، جزئیات را در قسمت فرم Exception for urlFetchWhitelist ارائه دهید.
oauthScopes
- محدوده های OAuth صریح را در مانیفست تنظیم کنید . رابط‌های بدون محدوده OAuth صریح رد خواهند شد.
رابط
- اگر کاربر برای استفاده از رابط نیاز به یک حساب دارد، مطمئن شوید که
description رابط یا پیوند addOnUrl دستورالعمل‌هایی برای کمک به کاربر در ایجاد آن ارائه می‌دهد. - رابط شما نمی تواند در وضعیت ناتمام یا بتا باشد. باید یک کانکتور کامل و کاربردی منتشر کنید. همیشه می‌توانید کانکتور خود را به‌روزرسانی کنید، اما استقرار تولیدی که برای کاربران منتشر می‌شود باید آزمایش شود و ویژگی کامل شود.
- هنگامی که کاربران با خطای داخلی Connector مواجه می‌شوند، پیام‌های خطای معنی‌دار و کاربردی را به کاربران ارائه دهید. این شامل مواردی می شود که کاربر ورودی نامعتبر/خالی را در پیکربندی ارائه می دهد.
-
shortDescription ، description ، پیوند addOnUrl ، پیوند supportUrl و صفحه OAuth (در صورت وجود) باید عاری از اشتباهات املایی و دستوری باشد. -
shortDescription نمی تواند حاوی URL باشد. - از روش های احراز هویت ارائه شده توسط
getAuthType() استفاده کنید. از طریق getConfig() درخواست اعتبار نکنید.
- فرآیند تأیید مشتری OAuth را تکمیل کنید. تایید برای همه کانکتورها بدون توجه به روش احراز هویت در
getAuthType() اجباری است. فرآیند تأیید فرآیندی متفاوت از بررسی رابط است و توسط یک تیم جداگانه، نه استودیو Looker اداره می‌شود. برای اطلاعات بیشتر ، سؤالات متداول تأیید OAuth API را ببینید. اگر فرآیند تأیید مشتری OAuth تکمیل نشود، رابط شما رد خواهد شد.
- اطمینان حاصل کنید که به شرایط خدمات استودیو Looker Galleries (ارسال کننده) پایبند هستید.
هنگامی که تمام شرایط مورد نیاز را برآورده کردید، روی دکمه زیر کلیک کنید تا کانکتور خود را بررسی کنید:
رابط شریک خود را منتشر کنید
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eTo publish a Partner Connector, ensure it meets all requirements outlined for Apps Script, Manifest, and the Connector itself.\u003c/p\u003e\n"],["\u003cp\u003eBefore submitting, share view access of your Apps Script project, create a Production deployment, and confirm the manifest file is visible.\u003c/p\u003e\n"],["\u003cp\u003eThe manifest must include specific details such as description, URLs, sources, and authentication information.\u003c/p\u003e\n"],["\u003cp\u003eYour connector needs to be fully functional, handle errors gracefully, adhere to style guidelines, and complete OAuth client verification.\u003c/p\u003e\n"],["\u003cp\u003eOnce all requirements are met, submit a review request using the provided link.\u003c/p\u003e\n"]]],[],null,["# Partner Connector requirements\n\nReview the [Publishing overview](/looker-studio/connector/publish-connector) to understand the benefits and required level\nof commitment for publishing a connector. To publish a *Partner Connector*, your\nconnector must meet all of the requirements described below.\n\nApps Script\n-----------\n\nBefore submitting your connector for review, complete the following in Apps\nScript:\n\n1. [Share view access](https://support.google.com/drive/answer/2494822) of your Apps Script project with the following:\n - [data-studio-contrib-qa@googlegroups.com](mailto:data-studio-contrib-qa@googlegroups.com)\n - [data-studio-contrib@google.com](mailto:data-studio-contrib@google.com)\n2. [Create a deployment](/looker-studio/connector/deploy#create_separate_deployments) named `Production` and update the `Production` deployment to the version of code you intend to publish.\n3. Confirm that you've updated the `Production` deployment to the version of code you want reviewed.\n4. Confirm that the manifest file is visible in Apps Script. At the left, click **Project Settings** settings. Select the **Show \"appsscript.json\" manifest file in editor** checkbox.\n\nManifest\n--------\n\nInclude the following in your connector's manifest and confirm that your Apps\nScript project is configured to show the `appsscript.json` manifest file in the\neditor.\n\nView the [Community Connector manifest reference](/looker-studio/connector/manifest) for more\ninformation.\n\n### `dataStudio`\n\n1. `description` should provide information and instructions for a basic understanding of the connector and how to use it. Connectors with vague and incomplete descriptions will be rejected.\n2. `addOnUrl` should be a dedicated hosted page about your connector, preferably hosted on your own domain. The page must include the following:\n - A **Privacy Policy** and **Terms of Use** or a link to this content, on the same domain as the `addOnUrl`.\n - Details the user will need to know to use your connector.\n - The sign up link, if an account is required to use your connector,.\n - Content hosted preferably on your domain. Hosting on `https://sites.google.com/` is not allowed.\n - See example pages from existing partners: [Funnel](https://funnel.io/marketing-reporting-google-data-studio), [Supermetrics](https://supermetrics.com/product/data-studio), [CallRail](https://www.callrail.com/integrations/googledatastudio/).\n3. `supportUrl` should be a hosted page to get support for your connector. This cannot be an email or mailto link.\n4. `logoUrl` should point to a static image hosted under your control. You **cannot** use images served by Google services on domains such as `*.gstatic.com`, `*.ggpht.com`, `*.google.com`, `*.googleusercontent.com`. Using Google Cloud Storage to serve images from the `*.googleapis.com` domain is acceptable and is a recommended hosting option.\n - Connectors with animated icons will be rejected. Use static images.\n - It's recommended to use at minimum, a 48x48-pixel image.\n - Avoid text-only images that are difficult to read when scaled down to 48x48-pixels.\n5. Populate the `sources` property with all sources your connector connects to. See [Sources in Manifest reference](/looker-studio/connector/manifest#sources-ref) for details.\n - You can view the existing list of sources at [Data Registry Repository](https://github.com/googledatastudio/ds-data-registry). If the source you are connecting to does not exist in the repository, send a [pull request to the Data Registry Repository](https://github.com/googledatastudio/ds-data-registry/compare?expand=1) to add the source. **Your\n connector will fail the review process if the sources in your manifest\n do not exist in the repository.**\n - This is additional metadata for the connector that will be indexed for search feature in the gallery. Your connector will show up in the search results when users search for a specific source in the gallery.\n6. Provide values for `shortDescription`, `authType`, `feeType`, `privacyPolicyUrl`, and `termsOfServiceUrl`.\n7. `name` should directly represent the purpose of the connector. A clear name will help users determine whether your connector meets their needs. Avoid using the word *connector* in the name since users already know they are looking at a connector.\n - Do not include special or non-visible characters with the intention of drawing attention to or potentially altering the position of your connector.\n8. Do not use shorthand names for Looker Studio anywhere in the manifest (e.g. GDS, DS, etc.).\n9. Emojis are not allowed in any manifest field (`description`, `shortDescription`, `name`, etc). In general, do not include special or non-visible characters with the intention of drawing attention to your connector.\n10. If your connector has a fixed schema, [create a report template](/looker-studio/connector/report-templates#how_to_create_a_report_template) for your connector and add it to the manifest. Enable **Sharing by link** for the report. \n\n### `urlFetchWhitelist`\n\n1. Limit the number of endpoints called by `UrlFetchApp` to those absolutely required for connector functionality. Add the `urlFetchWhitelist` property to the root level of your manifest. View the [urlFetchWhitelist reference](/apps-script/manifest/allowlist-url) for more info. \n - Include all endpoints used with the `UrlFetchApp` service.\n - If your connector does not fetch resources using the `UrlFetchApp` service, set `urlFetchWhitelist` to an empty list `[]`.\n - If your connector does not connect to a set of fixed endpoints or the endpoint prefix varies, omit the `urlFetchWhitelist` property and provide details in the *Exception for urlFetchWhitelist* form field when submitting the review request.\n\n### `oauthScopes`\n\n1. [Set explicit OAuth scopes](/apps-script/concepts/scopes) in the manifest. Connectors without explicit OAuth scopes will be rejected.\n\nConnector\n---------\n\n1. If the user needs an account to use the connector, make sure the connector `description` or the `addOnUrl` link provides instructions to help the user create one.\n2. Your connector cannot be in unfinished or beta status. You have to publish a complete and functional connector. You can always update your connector but the production deployment that is released to users should be tested and feature complete.\n3. Provide meaningful and actionable error messages to users when users encounter a [Connector internal error](/looker-studio/connector/error-handling#connector-internal-error). This includes cases when a user provides invalid/blank input at configuration.\n4. `shortDescription`, `description`, `addOnUrl` link, `supportUrl` link, and OAuth page (if applicable) should be free of spelling and grammatical errors.\n5. `shortDescription` cannot contain URLs.\n6. Use authentication methods provided by `getAuthType()`. Do not request credentials via `getConfig()`. \n7. Complete the [OAuth Client Verification](/apps-script/guides/client-verification) process. The verification is mandatory for all connectors regardless of the authentication method in `getAuthType()`. The verification process is a different process from the connector review and is handled by a separate team, not Looker Studio. Consult the [OAuth API Verification FAQ](https://support.google.com/cloud/answer/9110914) for more info. **Your connector\n will be rejected if the OAuth Client Verification process is not\n completed.** \n - During the *OAuth verification process* , [add your connector's required OAuth scopes](/static/looker-studio/connector/images/scopes-for-oauth-consent-screen.png) as part of the OAuth consent screen configuration. If you fail to add *all* required scopes, you might pass the *OAuth verification process* but your connector will still show the [Unverified app screen](/static/apps-script/images/unverified2.png). This will cause the *Partner\n Connector verification process* to fail. \n Authorize and test your connector using a new account after passing the *OAuth verification process* to ensure that [Unverified app screen](/static/apps-script/images/unverified2.png) is not displayed to your users.\n8. Ensure you adhere to the [Looker Studio Galleries Terms of Service (Submitter)](https://support.google.com/looker-studio/answer/7539411?ref_topic=7156687).\n\nOnce you have met all the requirements, click the following button to request a\nreview for your connector:\n\n[Publish your\nPartner Connector](https://goo.gl/KvuMcU)"]]
