مرجع البيان

البيان (appsscript.json) هو ملف JSON في مشروع موصّل برمجة تطبيقات. يحتوي على معلومات معيّنة حول أداة ربطك المخصّصة التي يجب توفيرها لنشر أداة الربط واستخدامها في "مركز البيانات". يمكنك الاطّلاع على مزيد من المعلومات حول بيانات التطبيق في "برمجة تطبيقات Google".

تنبيه: يجب اعتبار أي معلومات تدرجها في ملف البيان معلومات عامة.

يجب أن يتضمّن البيان المعلومات التالية:

اسم الموقع	النوع	الوصف
مطلوبة (ضمن السمة dataStudio)
name	string	اسم الموصل يجب ألا يتجاوز 28 حرفًا
company	string	اسم المؤسسة أو المطوّر
companyUrl	string (link)	رابط يؤدي إلى الموقع الإلكتروني للمؤسسة أو المطوّر
logoUrl	string (image link)	عنوان URL لرمز الموصل الأبعاد المطلوبة هي 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. يجب أن تكون القيمة هي معرّف التقرير في تقرير "مركز البيانات" الذي سيتم استخدامه كنموذج. راجِع الدليل حول توفير نماذج التقارير.
forceViewersCredentials	boolean	تحديد ما إذا كان يجب فرض بيانات اعتماد المشاهد على مصادر البيانات التي تم إنشاؤها من خلال أداة الربط هذه هذه السمة اختيارية وقيمتها التلقائية هي false. يمكنك الاطّلاع على بيانات اعتماد مصدر البيانات لمزيد من التفاصيل حول بيانات اعتماد المشاهد.
useQueryConfig	boolean	تم إيقاف هذا الحقل نهائيًا: يحدّد ما إذا كان هذا الرابط سيعرض إعدادات طلب بحث للدالة `getData()` أم لا. استخدِم `advancedServices` بدلاً من ذلك.
advancedServices.data	boolean	تحدّد ما إذا كان هذا الرابط سيعرض إعدادات طلب بحث للدالة `getData()` أم لا. يُرجى الاطّلاع على الخدمات المتقدّمة.
advancedServices.schema	boolean	تحدّد هذه السمة ما إذا كان الموصل سيعرض إعدادات طلب بحث للدالة `getSchema()` أم لا. يمكنك الاطّلاع على الخدمات المتقدّمة.
اختيارية (سمة على مستوى الجذر)
urlFetchWhitelist	list(string)	قائمة ببادئات عناوين URL عبر بروتوكول HTTPS التي يستخدمها الموصّل. يجب أن تتطابق أي نقطة نهاية لعنوان URL يتم جلبها مع إحدى البادئات في هذه القائمة. ويمكن أن يساعد ذلك في حماية بيانات المستخدمين. يمكنك الاطّلاع على إضافة عناوين URL إلى القائمة الآمنة لمزيد من التفاصيل.

AuthType

يمكن أن تكون قيم نوع طريقة المصادقة إحدى القيم التالية:

قيمة التعداد	الوصف
NONE	تشير إلى أنّه لا يلزم إجراء مصادقة للموصل.
OAUTH2	تشير إلى أنّ الموصل يستخدم بروتوكول OAuth 2.0.
KEY	تشير إلى أنّ أداة الربط تستخدم مفتاح واجهة برمجة التطبيقات.
USER_PASS	يشير إلى أنّ الموصل يستخدم اسم المستخدم وكلمة المرور.
USER_TOKEN	يشير إلى أنّ الموصل يستخدم اسم المستخدم/الرمز المميز.
PATH_USER_PASS	تشير إلى أنّ الموصل يستخدم المسار/اسم المستخدم/كلمة المرور.
PATH_KEY	يشير إلى أنّ الموصل يستخدم المسار/المفتاح.

FeeType

يمكن أن تكون قيم نوع الرسوم أيًّا ممّا يلي:

قيمة التعداد	الوصف
FREE	يشير إلى أنّ الموصل مجاني الاستخدام تمامًا.
FREE_TRIAL	تشير إلى أنّ الموصل يتضمّن خيارًا للاستفادة من فترة تجريبية مجانية.
PAID	تشير إلى أنّ المستخدم سيحتاج إلى الدفع لاستخدام الموصل.

المصادر

المصادر هي قائمة بتعدادات للمصادر. يمكنك الاطّلاع على القائمة الحالية بالمصادر في مستودع سجلّ البيانات. إذا لم يكن المصدر الذي تريد الربط به متوفّرًا في المستودع، أرسِل طلب سحب إلى مستودع "سجلّ البيانات" لإضافة المصدر. يمكن أن يحتوي اسم المصدر على أحرف كبيرة وشرطات سفلية فقط (على سبيل المثال، ستكون "إحصاءات Google" GOOGLE_ANALYTICS). في بيان Community Connector، استخدِم قيمة السمة الخاصة بمعرّف مصدر البيانات، مثل GOOGLE_ANALYTICS.

مثال على ملف البيان الخاص بـ "أداة ربط مخصّصة"

في ما يلي مثال على ملف بيان مكتمل:

data-studio/appsscript.json

عرض على GitHub

{
  "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/"]
}