Python – krótkie wprowadzenie

Przewodniki szybkiego startu wyjaśniają, jak skonfigurować i uruchamiać aplikację, która wywołuje interfejs Google Workspace API.

Szybkie starty Google Workspace korzystają z bibliotek klienta interfejsu API do obsługi niektórych szczegółów procesu uwierzytelniania i autoryzacji. Zalecamy używanie bibliotek klienta w przypadku własnych aplikacji. W tym krótkim wprowadzeniu użyjemy uproszczonego podejścia do uwierzytelniania, które jest odpowiednie dla środowiska testowego. W przypadku środowiska produkcyjnego zalecamy zapoznanie się z informacjami na temat uwierzytelniania i autoryzacji, zanim wybierzesz odpowiednie dla swojej aplikacji poświadczenia dostępu.

Utwórz aplikację wiersza poleceń w Pythonie, która wysyła żądania do interfejsu Google Drive Activity API.

Cele

  • skonfigurować środowisko,
  • Zainstaluj bibliotekę klienta.
  • Skonfiguruj próbkę.
  • Uruchom przykład.

Wymagania wstępne

Aby wykonać ten samouczek, musisz spełnić te wymagania wstępne:

  • konto Google;

Konfigurowanie środowiska

Aby rozpocząć krótkie wprowadzenie, skonfiguruj środowisko.

Włącz API

Zanim zaczniesz korzystać z interfejsów API Google, musisz je włączyć w projekcie Google Cloud. W jednym projekcie Google Cloud możesz włączyć 1 lub więcej interfejsów API.

Jeśli do wykonania tego samouczka używasz nowego projektu Google Cloud, skonfiguruj ekran akceptacji OAuth i dodaj siebie jako użytkownika testowego. Jeśli ten krok został już wykonany w przypadku Twojego projektu Cloud, przejdź do następnej sekcji.

  1. W konsoli Google Cloud kliknij Menu  > Interfejsy API i usługi > Ekran zgody OAuth.

    Otwórz ekran zgody OAuth

  2. W polu Typ użytkownika wybierz Wewnętrzny, a następnie kliknij Utwórz.
  3. Wypełnij formularz rejestracji aplikacji, a potem kliknij Zapisz i kontynuuj.

  4. Możesz pominąć dodawanie zakresów i kliknąć Zapisz i kontynuuj. Gdy w przyszłości będziesz tworzyć aplikację do użytku poza organizacją Google Workspace, musisz zmienić Typ użytkownika na Zewnętrzny, a następnie dodać zakresy autoryzacji wymagane przez aplikację.

  5. Sprawdź podsumowanie rejestracji aplikacji. Aby wprowadzić zmiany, kliknij Edytuj. Jeśli rejestracja aplikacji wygląda dobrze, kliknij Powrót do panelu.

Autoryzowanie danych logowania do aplikacji na komputer

Aby uwierzytelniać użytkowników i dostępować do ich danych w aplikacji, musisz utworzyć co najmniej 1 identyfikator klienta OAuth 2.0. Identyfikator klienta wskazuje konkretną aplikację na serwerach OAuth Google. Jeśli Twoja aplikacja działa na kilku platformach, musisz utworzyć osobny identyfikator klienta dla każdej z nich.
  1. W konsoli Google Cloud kliknij Menu  > Interfejsy API i usługi > Dane logowania.

    Przejdź do danych logowania

  2. Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
  3. Kliknij Typ aplikacji > Aplikacja na komputer.
  4. W polu Nazwa wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
  5. Kliknij Utwórz. Pojawi się ekran utworzonego klienta OAuth z nowym identyfikatorem klienta i tajnym kluczem klienta.
  6. Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji Identyfikatory klienta OAuth 2.0.
  7. Zapisz pobrany plik JSON jako credentials.json i przenieś go do katalogu roboczego.

Instalowanie biblioteki klienta Google

  • Zainstaluj bibliotekę klienta Google dla Pythona:

    pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib

Konfigurowanie próbki

  1. W katalogu roboczym utwórz plik o nazwie quickstart.py.

  2. Dodaj do pliku quickstart.py ten kod:

    drive/activity-v2/quickstart.py
    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# If modifying these scopes, delete the file token.json.
SCOPES = ["https://www.googleapis.com/auth/drive.activity.readonly"]


def main():
  """Shows basic usage of the Drive Activity API.

  Prints information about the last 10 events that occured the user's Drive.
  """
  creds = None
  # The file token.json stores the user's access and refresh tokens, and is
  # created automatically when the authorization flow completes for the first
  # time.
  if os.path.exists("token.json"):
    creds = Credentials.from_authorized_user_file("token.json", SCOPES)
  # If there are no (valid) credentials available, let the user log in.
  if not creds or not creds.valid:
    if creds and creds.expired and creds.refresh_token:
      creds.refresh(Request())
    else:
      flow = InstalledAppFlow.from_client_secrets_file(
          "credentials.json", SCOPES
      )
      creds = flow.run_local_server(port=0)
    # Save the credentials for the next run
    with open("token.json", "w") as token:
      token.write(creds.to_json())

  service = build("driveactivity", "v2", credentials=creds)

  # Call the Drive Activity API
  try:
    results = service.activity().query(body={"pageSize": 10}).execute()
    activities = results.get("activities", [])

    if not activities:
      print("No activity.")
    else:
      print("Recent activity:")
      for activity in activities:
        time = getTimeInfo(activity)
        action = getActionInfo(activity["primaryActionDetail"])
        actors = map(getActorInfo, activity["actors"])
        targets = map(getTargetInfo, activity["targets"])
        actors_str, targets_str = "", ""
        actor_name = actors_str.join(actors)
        target_name = targets_str.join(targets)

        # Print the action occurred on drive with actor, target item and timestamp
        print(f"{time}: {action}, {actor_name}, {target_name}")

  except HttpError as error:
    # TODO(developer) - Handleerrors from drive activity API.
    print(f"An error occurred: {error}")


# Returns the name of a set property in an object, or else "unknown".
def getOneOf(obj):
  for key in obj:
    return key
  return "unknown"


# Returns a time associated with an activity.
def getTimeInfo(activity):
  if "timestamp" in activity:
    return activity["timestamp"]
  if "timeRange" in activity:
    return activity["timeRange"]["endTime"]
  return "unknown"


# Returns the type of action.
def getActionInfo(actionDetail):
  return getOneOf(actionDetail)


# Returns user information, or the type of user if not a known user.
def getUserInfo(user):
  if "knownUser" in user:
    knownUser = user["knownUser"]
    isMe = knownUser.get("isCurrentUser", False)
    return "people/me" if isMe else knownUser["personName"]
  return getOneOf(user)


# Returns actor information, or the type of actor if not a user.
def getActorInfo(actor):
  if "user" in actor:
    return getUserInfo(actor["user"])
  return getOneOf(actor)


# Returns the type of a target and an associated title.
def getTargetInfo(target):
  if "driveItem" in target:
    title = target["driveItem"].get("title", "unknown")
    return f'driveItem:"{title}"'
  if "drive" in target:
    title = target["drive"].get("title", "unknown")
    return f'drive:"{title}"'
  if "fileComment" in target:
    parent = target["fileComment"].get("parent", {})
    title = parent.get("title", "unknown")
    return f'fileComment:"{title}"'
  return f"{getOneOf(target)}:unknown"


if __name__ == "__main__":
  main()

Uruchamianie przykładu

  1. W katalogu roboczym skompiluj i uruchom przykład:

    python3 quickstart.py
  1. Gdy uruchomisz próbkę po raz pierwszy, pojawi się prośba o autoryzację dostępu:
    1. Jeśli nie zalogowano się na konto Google, zaloguj się, gdy pojawi się taka prośba. Jeśli logujesz się na kilka kont, wybierz jedno konto, którego chcesz użyć do autoryzacji.
    2. Kliknij Accept (Zaakceptuj).

    Twoja aplikacja w Pythonie działa i wywołuje interfejs Google Drive Activity API.

    Informacje autoryzacyjne są przechowywane w systemie plików, więc następnym razem, gdy uruchomisz przykładowy kod, nie pojawi się prośba o autoryzację.

Dalsze kroki