مرجع البيان

البيان (appsscript.json) هو ملف JSON في موصل برمجة تطبيقات Google مشروعك. تحتوي الرسالة على معلومات معيّنة حول "ملتقى المرشدين المحليين". مطلوب لنشر الموصِّل واستخدامه في Looker Studio. مزيد من المعلومات حول البيانات في "برمجة تطبيقات 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. يجب أن تكون القيمة هي رقم تعريف تقرير Looker. تقرير "استوديو YouTube" الذي سيتم استخدامه كنموذج راجِع الدليل بتوفير نماذج التقارير.
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/"
  ]
}