Odwołanie do pliku manifestu

Plik manifestu (appsscript.json) jest plikiem JSON w oprogramowaniu sprzęgającym Apps Script w projektach AI. Zawiera on pewne informacje na temat społecznościowego oprogramowania sprzęgającego wymagane do wdrożenia i używania oprogramowania sprzęgającego w Looker Studio. Więcej informacji o plikach manifestu w Apps Script.

Plik manifestu powinien zawierać te informacje:

nazwa usługi Typ Opis
Wymagane (w ramach usługi dataStudio)
name string Nazwa oprogramowania sprzęgającego.
Ograniczony do 28 znaków
company string Nazwa organizacji lub dewelopera.
companyUrl string (link) Link do strony organizacji lub dewelopera.
logoUrl string (image link) Adres URL ikony oprogramowania sprzęgającego.
Wymagane wymiary to 40 x 40 pikseli.
addOnUrl string (link) Link do specjalnej sekcji „Więcej informacji” strony, na której powinna się znaleźć strona a także do danych, do których uzyskuje dostęp. Należy przechowywać i utrzymywać stronę.
Ta strona musi zawierać Warunki korzystania z usługi i Politykę prywatności albo link do nich Zasady.
supportUrl string (link) Link do strony pomocy dotyczącej tego oprogramowania sprzęgającego. Użytkownicy powinno być możliwe zgłaszanie problemów z oprogramowaniem sprzęgającym za pomocą tego linku. Ty powinien przechowywać i utrzymywać tę stronę.
description string Opis oprogramowania sprzęgającego.
Użytkownicy zobaczą pełny opis w oprogramowaniu sprzęgającym stronie konfiguracji. Linki będzie można klikać.
Opcjonalny (w sekcji właściwości dataStudio)
shortDescription string Limit: 114 znaków. Jeśli oprogramowanie sprzęgające zostało opublikowane, ten krótki opis będzie widoczny na karcie galerii dla . Opisz krótko, do czego służy oprogramowanie sprzęgające. Użytkownicy będzie to możliwe podczas przeglądania oprogramowania sprzęgającego w .
privacyPolicyUrl string (link) Link do polityki prywatności dotyczącej oprogramowania sprzęgającego lub organizacji deweloperów.
termsOfServiceUrl string (link) Link do Warunków korzystania z usługi oprogramowania sprzęgającego lub organizacji programistycznej.
authType list(AuthType) Typ metody uwierzytelniania oprogramowania sprzęgającego. Zobacz AuthType poniżej.
feeType list(FeeType) Wskazuje typ opłaty za oprogramowanie sprzęgające. Zobacz FeeType poniżej.
sources list(Sources) Lista źródeł danych, z którymi to oprogramowanie sprzęgające może się łączyć. Zobacz Źródła poniżej.
templates Object Lista szablonów, których można używać z tym oprogramowaniem sprzęgającym. Tylko jedna domyślna jest obsługiwany. Wskazuje to ustawienie default klawisz. Wartość powinna być identyfikatorem raportu Lookera Raport Studio, który zostanie użyty jako szablon. Zapoznaj się z przewodnikiem na temat dostarczania szablonów raportów.
forceViewersCredentials boolean Określa, czy dane logowania osoby przeglądającej mają być wymuszane w przypadku źródeł danych utworzony za pomocą tego oprogramowania sprzęgającego. Ta właściwość jest opcjonalna i domyślnie przyjmuje wartość false Zobacz Dane źródłowe dane logowania, aby dowiedzieć się więcej o danych logowania osoby przeglądającej.
useQueryConfig boolean WYCOFANE: określa, czy to oprogramowanie sprzęgające zwróci konfigurację zapytania dla `getData()`. Użyj interfejsu „advancedServices”.
advancedServices.data boolean Określa, czy to oprogramowanie sprzęgające zwróci konfigurację zapytania dla `getData()`. Zobacz zaawansowane usługi.
advancedServices.schema boolean Określa, czy to oprogramowanie sprzęgające zwróci konfigurację zapytania dla `getSchema()`. Zobacz zaawansowane usługi.
Opcjonalny (usługa na poziomie głównym)
urlFetchWhitelist list(string) Lista prefiksów adresów URL HTTPS używanych przez oprogramowanie sprzęgające. Dowolny punkt końcowy URL pobrane muszą być zgodne z jednym z prefiksów na tej liście. Może to pomóc: ochrony danych użytkowników. Zobacz Safelisting adresów URL, aby dowiedzieć się więcej.

AuthType

Typ metody uwierzytelniania może mieć następujące wartości:

Wartość typu wyliczeniowego Opis
NONE Wskazuje, że uwierzytelnianie nie jest wymagane w przypadku .
OAUTH2 Wskazuje, że oprogramowanie sprzęgające korzysta z protokołu OAuth 2.0.
KEY Wskazuje, że oprogramowanie sprzęgające używa klucza interfejsu API.
USER_PASS Wskazuje, że oprogramowanie sprzęgające używa nazwy użytkownika i hasła.
USER_TOKEN Wskazuje, że oprogramowanie sprzęgające używa nazwy użytkownika/tokenu.
PATH_USER_PASS Wskazuje, że oprogramowanie sprzęgające używa ścieżki, nazwy użytkownika i hasła.
PATH_KEY Wskazuje, że oprogramowanie sprzęgające używa ścieżki/klucza.

FeeType

Typ opłaty może mieć następujące wartości:

Wartość typu wyliczeniowego Opis
FREE Wskazuje, że oprogramowanie sprzęgające jest całkowicie bezpłatne.
FREE_TRIAL Wskazuje, że oprogramowanie sprzęgające oferuje opcję bezpłatnej wersji próbnej.
PAID Wskazuje, że użytkownik będzie musiał zapłacić za korzystanie z oprogramowania sprzęgającego.

Źródła

Źródła to lista wyliczeniowych źródeł. Możesz wyświetlić aktualną listę znajdziesz w naszym repozytorium rejestru danych. Jeśli źródło, z którym łączysz się nie istnieje w repozytorium, wyślij żądanie pull do rejestru danych Repozytorium, aby dodać źródło. Nazwa źródła może zawierać tylko wielkie litery znaki i podkreślenia (np. Google Analytics będzie zawierać GOOGLE_ANALYTICS). W pliku manifestu społecznościowego oprogramowania sprzęgającego użyj wartości identyfikatora źródła danych. usłudze, np. GOOGLE_ANALYTICS

Przykładowy plik manifestu społecznościowego oprogramowania sprzęgającego

Oto przykład kompletnego pliku manifestu:

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