Manifest (appsscript.json) to plik JSON w projekcie łącznika Apps Script. Zawiera on określone informacje o Twoim oprogramowaniu sprzęgającym społeczności, które są wymagane do wdrożenia i używania go w Looker Studio. Więcej informacji o plikach manifestu w Apps Script
Manifest powinien zawierać te informacje:
| nazwa usługi, | Typ | Opis |
|---|---|---|
Wymagany (właściwość dataStudio)
|
||
name
|
string
|
Nazwa łącznika. Limit wynosi 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 oprogramowania sprzęgającego. Wymagane wymiary to 40 x 40 pikseli. |
addOnUrl
|
string (link)
|
Link do strony „Więcej informacji”, która powinna wyjaśniać, co robi Twój konektor i do jakich danych ma dostęp. Musisz hostować tę stronę i ją utrzymywać. Ta strona musi zawierać linki do warunków korzystania z usługi i polityki prywatności. |
supportUrl
|
string (link)
|
Link do strony pomocy dotyczącej obsługi tego łącznika. Użytkownicy powinni mieć możliwość zgłaszania problemów z Twoim łącznikiem pod tym linkiem. Musisz hostować tę stronę i ją utrzymywać. |
description
|
string
|
Opis łącznika. Użytkownicy zobaczą pełny opis na stronie konfiguracji konektora. Linki będą klikalne. |
Opcjonalny (właściwość dataStudio)
|
||
shortDescription
|
string
|
Limit: 114 znaków. Jeśli oprogramowanie sprzęgające zostanie opublikowane, ten krótki opis będzie widoczny na karcie galerii oprogramowania sprzęgającego. Użyj tego pola, aby krótko opisać, do czego służy Twój łącznik. Użytkownicy będą mogli zobaczyć tę informację podczas przeglądania złączy w galerii. |
privacyPolicyUrl
|
string (link)
|
Link do polityki prywatności organizacji dewelopera lub łącznika. |
termsOfServiceUrl
|
string (link)
|
Link do warunków korzystania z usługi dotyczących łącznika lub organizacji dewelopera. |
authType
|
list(AuthType)
|
Typ metody uwierzytelniania w przypadku łącznika. Patrz AuthType poniżej. |
feeType
|
list(FeeType)
|
Określa typ opłaty za złącze. Zobacz FeeType poniżej. |
sources
|
list(Sources)
|
Lista źródeł danych, z którymi ten łącznik może się łączyć. Zobacz Źródła poniżej. |
templates
|
Object
|
Lista szablonów, których można używać z tym łącznikiem. Obsługiwany jest tylko 1 szablon domyślny, który jest identyfikowany przez ustawienie klucza default. Wartość powinna być identyfikatorem raportu Looker Studio, który będzie używany jako szablon. Zapoznaj się z przewodnikiem na temat udostępniania szablonów raportów.
|
forceViewersCredentials
|
boolean
|
Określa, czy w przypadku źródeł danych utworzonych na podstawie tego oprogramowania sprzęgającego należy wymuszać dane logowania osoby przeglądającej. Ta właściwość jest opcjonalna, a jej domyślna wartość to false. Więcej informacji o danych logowania osoby przeglądającej znajdziesz w artykule Dane logowania do źródła danych.
|
useQueryConfig
|
boolean
|
WYCOFANO: czy ten łącznik zwróci konfigurację zapytania dla funkcji `getData()`. Zamiast tego użyj `advancedServices`. |
advancedServices.data
|
boolean
|
Określa, czy ten łącznik zwróci konfigurację zapytania dla funkcji `getData()`. Patrz usługi zaawansowane. |
advancedServices.schema
|
boolean
|
Określa, czy ten łącznik zwróci konfigurację zapytania dla funkcji `getSchema()`. Patrz usługi zaawansowane. |
| Opcjonalny (usługa na poziomie głównym) | ||
urlFetchWhitelist
|
list(string)
|
Lista prefiksów adresów URL HTTPS, których używa Twój łącznik. Każdy pobrany punkt końcowy adresu URL musi pasować do jednego z prefiksów na tej liście. Może to pomóc w ochronie danych użytkowników. Więcej informacji znajdziesz w sekcji Dodawanie adresów URL do listy dozwolonych. |
AuthType
Wartości typu metody uwierzytelniania mogą być jednymi z tych:
| Wartość typu wyliczeniowego | Opis |
|---|---|
NONE
|
Wskazuje, że złącze nie wymaga uwierzytelniania. |
OAUTH2 |
Wskazuje, że łącznik używa 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 lub tokena. |
PATH_USER_PASS |
Wskazuje, że łącznik używa ścieżki, nazwy użytkownika i hasła. |
PATH_KEY |
Wskazuje, że oprogramowanie sprzęgające używa ścieżki lub klucza. |
FeeType
Wartości typu opłaty mogą być dowolne z tych elementów:
| Wartość typu wyliczeniowego | Opis |
|---|---|
FREE |
Oznacza, że oprogramowanie sprzęgające jest całkowicie bezpłatne. |
FREE_TRIAL |
Wskazuje, że oprogramowanie sprzęgające ma opcję bezpłatnego okresu próbnego. |
PAID |
Wskazuje, że użytkownik będzie musiał zapłacić za korzystanie z tego oprogramowania sprzęgającego. |
Źródła
Sources to lista wyliczeń źródeł. Obecną listę źródeł znajdziesz w naszym repozytorium rejestru danych. Jeśli źródło, z którym chcesz się połączyć, nie istnieje w repozytorium, wyślij prośbę o scalenie do repozytorium rejestru danych, aby dodać źródło. Nazwa źródła może zawierać tylko wielkie litery i podkreślenia (np. Google Analytics to GOOGLE_ANALYTICS). W pliku manifestu złącza społecznościowego użyj wartości właściwości identyfikatora źródła danych, np. GOOGLE_ANALYTICS.
Przykładowy plik manifestu dla złącza społecznościowego
Oto przykład wypełnionego pliku manifestu: