Odwołanie do pliku manifestu

Manifest (appsscript.json) to plik JSON w projekcie łącznika Apps Script. Zawiera ona określone informacje o łączniku społecznościowym, które są wymagane do wdrożenia i używania łącznika w Studio danych. 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: 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 łącznik i do jakich danych ma dostęp. Musisz hostować tę stronę i ją utrzymywać. Ta strona musi zawierać warunki korzystania z usługi i politykę prywatności lub linki do nich.
`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ć działanie konektora. Użytkownicy będą mogli to zobaczyć podczas przeglądania łączników w galerii.
`privacyPolicyUrl`	`string (link)`	Link do polityki prywatności dotyczącej łącznika lub organizacji dewelopera.
`termsOfServiceUrl`	`string (link)`	Link do warunków korzystania z usługi w przypadku łącznika lub organizacji dewelopera.
`authType`	`list(AuthType)`	Typ metody uwierzytelniania w przypadku oprogramowania sprzęgającego. 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ę połą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 Studia danych, 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 przeglądającego znajdziesz w sekcji Dane logowania źródła danych.
`useQueryConfig`	`boolean`	WYCOFANO: czy ten łącznik zwróci konfigurację zapytania dla funkcji `getData()`. Zamiast tego użyj funkcji `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()`. Więcej informacji znajdziesz w sekcji 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 być zgodny z jednym z prefiksów na tej liście. Może to pomóc chronić dane użytkowników. Więcej informacji znajdziesz w artykule 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 oprogramowanie sprzęgające nie wymaga uwierzytelniania.
`OAUTH2`	Wskazuje, że oprogramowanie sprzęgające używa 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 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 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 żądanie pull do repozytorium rejestru danych, aby dodać to źródło. Nazwa źródła może zawierać tylko wielkie litery i podkreślenia (np. Google Analytics będzie 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:

data-studio/appsscript.json

Wyświetl w GitHubie

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