Szybki start z Google Apps Script

Tworzenie skryptu Google Apps Script , który wysyła żądania do interfejsu Google Chat API

Krótkie wprowadzenia wyjaśniają, jak skonfigurować i uruchomić aplikację, która wywołuje interfejs Google Workspace API. W tym krótkim wprowadzeniu używamy uproszczonego podejścia do uwierzytelniania, które jest odpowiednie dla środowiska testowego. W przypadku środowiska produkcyjnego zalecamy zapoznanie się z uwierzytelnianiem i autoryzacją przed wybraniem danych logowania, które są odpowiednie dla Twojej aplikacji.

W Apps Script krótkie wprowadzenia do Google Workspace używają zaawansowanych usług Google do wywoływania interfejsów Google Workspace API i obsługi niektórych szczegółów procesu uwierzytelniania i autoryzacji.

Cele

  • Skonfiguruj środowisko.
  • Utwórz i skonfiguruj skrypt.
  • Uruchom skrypt.

Wymagania wstępne

Konfigurowanie projektu w chmurze

Jeśli do wykonania tego krótkiego wprowadzenia używasz nowego projektu Google Cloud, musisz go skonfigurować i dodać siebie jako użytkownika testowego. Jeśli te kroki zostały już wykonane w przypadku Twojego projektu w chmurze, przejdź do następnej sekcji.

Otwieranie projektu w chmurze w konsoli Google Cloud

Jeśli nie jest jeszcze otwarty, otwórz projekt w chmurze, którego chcesz użyć w tym przykładzie:

  1. W konsoli Google Cloud otwórz stronę Wybierz projekt.

    Wybierz projekt w chmurze

  2. Wybierz projekt w chmurze Google, którego chcesz użyć. Możesz też kliknąć Utwórz projekt i postępować zgodnie z instrukcjami wyświetlanymi na ekranie. Jeśli utworzysz projekt Google Cloud, może być konieczne włączenie w nim płatności.

Włączanie interfejsu Chat API

Zanim zaczniesz korzystać z interfejsów API Google, musisz je włączyć w projekcie w chmurze Google. W jednym projekcie Google Cloud możesz włączyć co najmniej 1 interfejs API.

  • W konsoli Google Cloud włącz interfejs Google Chat API.

    Włączanie API

  1. W konsoli interfejsów API Google otwórz Menu > Platforma uwierzytelniania Google > Branding.

    Otwórz Branding

  2. Jeśli platforma uwierzytelniania Google jest już skonfigurowana, możesz skonfigurować te ustawienia ekranu zgody OAuth w sekcjach Branding, Odbiorcy i Dostęp do danych. Jeśli zobaczysz komunikat Platforma uwierzytelniania Google nie została jeszcze skonfigurowana, kliknij Rozpocznij:
    1. W sekcji Informacje o aplikacji w polu Nazwa aplikacji wpisz nazwę aplikacji.
    2. W polu Adres e-mail dla użytkowników potrzebujących pomocy wybierz adres e-mail, na który użytkownicy mogą się z Tobą skontaktować, jeśli mają pytania dotyczące zgody.
    3. Kliknij Dalej.
    4. W sekcji Odbiorcy wybierz Wewnętrzni.
    5. Kliknij Dalej.
    6. W sekcji Dane kontaktowe wpisz Adres e-mail, na który chcesz otrzymywać powiadomienia o wszelkich zmianach w projekcie.
    7. Kliknij Dalej.
    8. W sekcji Zakończ zapoznaj się z Zasadami dotyczącymi danych użytkownika w usługach interfejsu API Google. Jeśli się z nimi zgadzasz, zaznacz pole Akceptuję zasady dotyczące danych użytkownika w usługach interfejsu API Google.
    9. Kliknij Dalej.
    10. Kliknij Utwórz.
  3. Na razie możesz pominąć dodawanie zakresów. W przyszłości, gdy będziesz tworzyć aplikację do użytku poza organizacją Google Workspace, musisz zmienić Typ użytkownika na Zewnętrzny. Następnie dodaj zakresy autoryzacji wymagane przez aplikację. Więcej informacji znajdziesz w pełnym przewodniku Konfigurowanie ekranu zgody OAuth.

Konfigurowanie aplikacji Google Chat

Aby wywoływać interfejs Google Chat API, musisz skonfigurować aplikację Google Chat. W przypadku wszystkich żądań zapisu Google Chat przypisuje aplikację Google Chat w interfejsie na podstawie tych informacji.

  1. W konsoli interfejsów API Google otwórz stronę Konfiguracja interfejsu Chat API:

    Otwórz stronę konfiguracji interfejsu Chat API

  2. W sekcji Informacje o aplikacji wpisz te informacje:

    1. W polu Nazwa aplikacji wpisz Chat API quickstart app.
    2. W polu Adres URL awatara wpisz https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. W polu Opis wpisz Quickstart for calling the Chat API.

  3. W sekcji Funkcje interaktywne kliknij przełącznik Włącz funkcje interaktywne, aby wyłączyć funkcje interaktywne aplikacji do obsługi czatu.

  4. Kliknij Zapisz.

Tworzenie skryptu

  1. Utwórz nowy skrypt w edytorze skryptów Apps Script, otwierając stronę script.google.com/create.
  2. Zastąp zawartość edytora skryptów tym kodem:

chat/quickstart/Code.gs
/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken,
    });
    // Handle response pages
    if (responsePage.spaces) {
      for (const space of responsePage.spaces) {
        console.log(space);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

  1. Kliknij Zapisz .
  2. Kliknij Projekt bez tytułu, wpisz Krótkie wprowadzenie i kliknij Zmień nazwę.

Konfigurowanie skryptu

Kopiowanie numeru projektu w chmurze

  1. W konsoli interfejsów API Google otwórz Menu > Administracja > Ustawienia.

    Otwórz Ustawienia w obszarze Administracja

  2. W polu Numer projektu skopiuj wartość.
  1. Otwórz projekt Apps Script.
  2. Kliknij Ustawienia projektu .
  3. W sekcji Projekt Google Cloud Platform (GCP) kliknij Zmień projekt.
  4. W polu Numer projektu GCP wklej numer projektu w chmurze Google.
  5. Kliknij Ustaw projekt.

Włączanie interfejsu Google Chat API

Otwórz projekt Apps Script.

  1. Kliknij Ustawienia projektu .
  2. W sekcji Ustawienia ogólne włącz opcję Wyświetlaj plik manifestu „appsscript.json” w edytorze.
  3. Kliknij Editor , wybierz plik appscript.json i zastąp jego zawartość tym kodem:

chat/quickstart/appsscript.json
{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": ["https://www.googleapis.com/auth/chat.spaces.readonly"],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [
      {
        "userSymbol": "Chat",
        "version": "v1",
        "serviceId": "chat"
      }
    ]
  }
}

Uruchamianie przykładu

W edytorze skryptów Apps Script kliknij Uruchom.

Gdy uruchomisz przykład po raz pierwszy, pojawi się prośba o autoryzację dostępu:

  1. Kliknij Sprawdź uprawnienia.
  2. Wybierz konto.
  3. Kliknij Zezwól.

Dziennik wykonania skryptu pojawi się u dołu okna.

Dalsze kroki