Plik manifestu (appsscript.json
) to plik JSON w projekcie oprogramowania sprzęgającego Apps Script. Zawiera on pewne informacje o społecznościowym oprogramowaniu sprzęgającym, które są wymagane do wdrożenia i używania oprogramowania sprzęgającego w Looker Studio. Dowiedz się więcej o plikach manifestu w Apps Script.
Plik manifestu powinien zawierać te informacje:
nazwa właściwości | Typ | Opis |
---|---|---|
Wymagany (w ramach właściwości dataStudio )
|
||
name
|
string
|
Nazwa Twojego oprogramowania sprzęgającego. Maksymalnie 28 znaków |
company
|
string
|
Nazwa organizacji lub dewelopera. |
companyUrl
|
string (link)
|
Link do witryny organizacji lub dewelopera. |
logoUrl
|
string (image link)
|
Adres URL ikony Twojego oprogramowania sprzęgającego. Wymagane wymiary to 40 x 40 pikseli. |
addOnUrl
|
string (link)
|
Link do specjalnej strony z informacjami o działaniu oprogramowania sprzęgającego i danych, do których uzyskuje dostęp. Zalecamy hostowanie i utrzymywanie tej strony. Ta strona musi zawierać Warunki korzystania z usługi i Politykę prywatności lub link do nich. |
supportUrl
|
string (link)
|
Link do strony pomocy technicznej związanej z obsługą tego oprogramowania sprzęgającego. Użytkownicy powinni mieć możliwość zgłaszania problemów z oprogramowaniem sprzęgającym za pomocą tego linku. Zalecamy hostowanie i utrzymywanie tej strony. |
description
|
string
|
Opis oprogramowania sprzęgającego. Użytkownicy będą widzieć pełny opis na stronie konfiguracji oprogramowania sprzęgającego. Będzie można kliknąć linki. |
Opcjonalny (w usłudze 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 Twojego oprogramowania sprzęgającego. Użyj tego pola, aby w skrócie opisać, jak działa oprogramowanie sprzęgające. Użytkownicy będą mogli go wyświetlić, przeglądając oprogramowanie sprzęgające w galerii. |
privacyPolicyUrl
|
string (link)
|
Link do polityki prywatności oprogramowania sprzęgającego lub organizacji dewelopera. |
termsOfServiceUrl
|
string (link)
|
Link do warunków korzystania z usługi dla oprogramowania sprzęgającego lub organizacji dewelopera. |
authType
|
list(AuthType)
|
Typ metody uwierzytelniania Twojego oprogramowania sprzęgającego. Zobacz AuthType poniżej. |
feeType
|
list(FeeType)
|
Wskazuje typ opłaty dla Twojego oprogramowania sprzęgającego. Zobacz sekcję FeeType poniżej. |
sources
|
list(Sources)
|
Lista źródeł danych, z którymi to oprogramowanie sprzęgające może się połączyć. Zobacz sekcję Źródła poniżej. |
templates
|
Object
|
Lista szablonów, których można używać z tym oprogramowaniem sprzęgającym. Obsługiwany jest tylko 1 szablon domyślny wskazany przez ustawienie klucza default . Wartość powinna być identyfikatorem raportu w narzędziu Looker Studio, który będzie używany jako szablon. Przeczytaj przewodnik po tworzeniu szablonów raportów.
|
forceViewersCredentials
|
boolean
|
Określa, czy w przypadku źródeł danych utworzonych w tym oprogramowaniu sprzęgającym należy wymuszać podanie danych logowania osoby przeglądającej. Ta właściwość jest opcjonalna i ma domyślnie wartość false . Więcej informacji o danych logowania osoby przeglądającej znajdziesz w sekcji Dane logowania do źródła danych.
|
useQueryConfig
|
boolean
|
WYCOFANE: określa, czy to oprogramowanie sprzęgające zwróci konfigurację zapytania dla funkcji „getData()”. Zamiast tego użyj typu „advancedServices”. |
advancedServices.data
|
boolean
|
Czy to oprogramowanie sprzęgające zwróci konfigurację zapytania dla funkcji `getData()`. Zobacz usługi zaawansowane. |
advancedServices.schema
|
boolean
|
Czy to oprogramowanie sprzęgające zwróci konfigurację zapytania dla funkcji `getSchema()`. Zobacz usługi zaawansowane. |
Opcjonalny (usługa na poziomie głównym) | ||
urlFetchWhitelist
|
list(string)
|
Lista prefiksów adresów URL HTTPS używanych przez oprogramowanie sprzęgające. Każdy pobrany punkt końcowy URL musi pasować do jednego z prefiksów na tej liście. Może to pomóc w ochronie danych użytkownika. Więcej informacji znajdziesz w sekcji Bezpieczne umieszczanie adresów URL. |
AuthType
Typ metody uwierzytelniania może mieć jedną z tych wartości:
Wartość wyliczeniowa | Opis |
---|---|
NONE
|
Wskazuje, że łącznik nie wymaga uwierzytelniania. |
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/tokena. |
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
Możliwe wartości typu opłaty:
Wartość wyliczeniowa | Opis |
---|---|
FREE |
Wskazuje, że oprogramowanie sprzęgające jest całkowicie bezpłatne. |
FREE_TRIAL |
Wskazuje, że oprogramowanie sprzęgające oferuje bezpłatną wersję próbną. |
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 wyliczeń dla źródeł. Istniejącą listę źródeł możesz wyświetlić w naszym repozytorium rejestru danych. Jeśli źródło, z którym łączysz się, nie istnieje w repozytorium, wyślij żądanie pobrania do repozytorium rejestru danych, aby dodać źródło. Nazwa źródła może zawierać tylko wielkie litery i podkreślenia (np. w Google Analytics będzie to GOOGLE_ANALYTICS
). W pliku manifestu społecznościowego oprogramowania sprzęgającego użyj wartości identyfikatora źródła danych, np. GOOGLE_ANALYTICS
.
Przykładowy plik manifestu społecznościowego oprogramowania sprzęgającego
Oto przykład gotowego pliku manifestu: