مرجع البيان

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

يجب أن يحتوي البيان على المعلومات التالية:

اسم السمة Type الوصف
مطلوبة (ضمن السمة 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. يجب أن تكون القيمة رقم تعريف تقرير 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

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

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

FeeType

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

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

المصادر

تُعد المصادر قائمة تعدادات للمصادر. يمكنك الاطّلاع على قائمة المصادر الحالية في مستودع سجلّ البيانات. إذا لم يكن المصدر الذي تتصل به متاحًا في المستودع، أرسِل طلب سحب إلى مستودع سجلّ البيانات لإضافة المصدر. لا يمكن أن يحتوي اسم المصدر إلا على أحرف كبيرة وشرطات سفلية (على سبيل المثال، ستكون "إحصاءات Google" GOOGLE_ANALYTICS). في بيان "رابط المنتدى"، استخدِم قيمة موقع رقم تعريف مصدر البيانات، مثل 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/"
  ]
}