Kurzanleitung zur Authentifizierung mit OAuth

Die einfachste Möglichkeit zur Authentifizierung bei der Gemini API ist die Konfiguration eines API-Schlüssels, wie in der Kurzanleitung für die Gemini API beschrieben. Wenn Sie strengere Zugriffskontrollen benötigen, können Sie stattdessen OAuth verwenden. In dieser Anleitung erfahren Sie, wie Sie die Authentifizierung mit OAuth einrichten.

In dieser Anleitung wird ein vereinfachter Authentifizierungsansatz verwendet, der für eine Testumgebung geeignet ist. Für eine Produktionsumgebung sollten Sie sich mit der Authentifizierung und Autorisierung vertraut machen, bevor Sie die für Ihre App geeigneten Zugangsdaten auswählen.

Ziele

  • Cloud-Projekt für OAuth einrichten
  • Standardanmeldedaten für Anwendungen einrichten
  • Anmeldedaten in Ihrem Programm verwalten, anstatt gcloud auth zu verwenden

Vorbereitung

Für diese Kurzanleitung benötigen Sie Folgendes:

Cloud-Projekt einrichten

Für diese Kurzanleitung müssen Sie zuerst Ihr Cloud-Projekt einrichten.

1. API aktivieren

Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren.

  • Aktivieren Sie in der Google Cloud Console die Google Generative Language API.

    API aktivieren

2. OAuth-Zustimmungsbildschirm konfigurieren

Konfigurieren Sie als Nächstes den OAuth-Zustimmungsbildschirm des Projekts und fügen Sie sich selbst als Testnutzer hinzu. Wenn Sie diesen Schritt bereits für Ihr Cloud-Projekt ausgeführt haben, fahren Sie mit dem nächsten Abschnitt fort.

  1. Rufen Sie in der Google Cloud Console das Menü > Google Auth Platform > Übersicht auf.

    Google Auth Platform aufrufen

  2. Füllen Sie das Formular zur Projektkonfiguration aus und legen Sie im Abschnitt Zielgruppe den Nutzertyp auf Extern fest.

  3. Füllen Sie den Rest des Formulars aus, akzeptieren Sie die Nutzungsbedingungen der Richtlinie zu Nutzerdaten und klicken Sie dann auf Erstellen.

  4. Sie können das Hinzufügen von Bereichen vorerst überspringen und auf Speichern und fortfahren klicken. Wenn Sie später eine App für die Verwendung außerhalb Ihrer Google Workspace-Organisation erstellen, müssen Sie die Autorisierungsbereiche hinzufügen und bestätigen, die Ihre App benötigt.

  5. Testnutzer hinzufügen:

    1. Rufen Sie die Seite „Zielgruppe“ der Google Auth Platform auf.
    2. Klicken Sie unter Testnutzer auf Nutzer hinzufügen.
    3. Geben Sie Ihre E-Mail-Adresse und die E-Mail-Adressen aller anderen autorisierten Testnutzer ein und klicken Sie dann auf Speichern.

3. Anmeldedaten für eine Desktopanwendung autorisieren

Für die Authentifizierung als Endnutzer und für den Zugriff auf Nutzerdaten in Ihrer Anwendung müssen Sie mindestens eine OAuth 2.0-Client-ID erstellen. Eine Client-ID wird zur Identifizierung einer einzelnen Anwendung bei den OAuth-Servern von Google verwendet. Wenn Ihre Anwendung auf mehreren Plattformen ausgeführt wird, müssen Sie für jede Plattform eine separate Client-ID erstellen.

  1. Rufen Sie in der Google Cloud Console das Menü > Google Auth Platform > Clients auf.

    Zu den Anmeldedaten

  2. Klicken Sie auf Client erstellen.

  3. Klicken Sie auf Anwendungstyp > Desktopanwendung.

  4. Geben Sie im Feld Name einen Namen für die Anmeldedaten ein. Dieser Name wird nur in der Google Cloud Console angezeigt.

  5. Klicken Sie auf Erstellen. Der Bildschirm „OAuth-Client erstellt“ wird angezeigt und enthält Ihre neue Client-ID und Ihren neuen Clientschlüssel.

  6. Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter OAuth 2.0-Client-IDs angezeigt.

  7. Klicken Sie auf die Schaltfläche zum Herunterladen, um die JSON-Datei zu speichern. Sie wird als client_secret_<identifier>.json gespeichert. Benennen Sie sie in client_secret.json um und verschieben Sie sie in Ihr Arbeitsverzeichnis.

Standardanmeldedaten für Anwendungen einrichten

Wenn Sie die Datei client_secret.json in nutzbare Anmeldedaten umwandeln möchten, übergeben Sie ihren Speicherort an das Argument --client-id-file des Befehls gcloud auth application-default login.

gcloud auth application-default login \
    --client-id-file=client_secret.json \
    --scopes='https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/generative-language.retriever'

Die vereinfachte Projekteinrichtung in dieser Anleitung löst das Dialogfeld "Diese App wurde von Google nicht bestätigt" aus. Das ist normal. Wählen Sie "Weiter" aus.

Dadurch wird das resultierende Token an einem bekannten Speicherort platziert, sodass es von gcloud oder den Clientbibliotheken aufgerufen werden kann.

gcloud auth application-default login 
--no-browser --client-id-file=client_secret.json
--scopes='https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/generative-language.retriever'

Sobald Sie die Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) eingerichtet haben, benötigen die Clientbibliotheken in den meisten Sprachen nur wenig oder gar keine Hilfe, um sie zu finden.

Curl

Die schnellste Möglichkeit, zu testen, ob dies funktioniert, ist der Zugriff auf die REST API mit curl:

access_token=$(gcloud auth application-default print-access-token)
project_id=<MY PROJECT ID>
curl -X GET https://generativelanguage.googleapis.com/v1/models \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer ${access_token}" \
    -H "x-goog-user-project: ${project_id}" | grep '"name"'

Python

In Python sollten die Clientbibliotheken sie automatisch finden:

pip install google-genai

Ein minimales Skript zum Testen könnte so aussehen:

from google import genai

client = genai.Client()
print('Available base models:', [m.name for m in client.models.list()])

Nächste Schritte

Wenn das funktioniert, können Sie die semantische Suche auf Ihre Textdaten anwenden. Semantic retrieval on your text data.

Anmeldedaten selbst verwalten [Python]

In vielen Fällen steht der Befehl gcloud nicht zur Verfügung, um das Zugriffstoken aus der Client-ID (client_secret.json) zu erstellen. Google bietet Bibliotheken in vielen Sprachen an, mit denen Sie diesen Prozess in Ihrer App verwalten können. In diesem Abschnitt wird der Prozess in Python veranschaulicht. Entsprechende Beispiele für diese Art von Verfahren für andere Sprachen finden Sie in der Drive API-Dokumentation

1. Erforderliche Bibliotheken installieren

Installieren Sie die Google-Clientbibliothek für Python und die Gemini-Clientbibliothek.

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

2. Anmeldedatenmanager schreiben

Um die Anzahl der Klicks auf den Autorisierungsbildschirmen zu minimieren, erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen load_creds.py, in der eine token.json-Datei zwischengespeichert wird, die später wiederverwendet oder bei Ablauf aktualisiert werden kann.

Beginnen Sie mit dem folgenden Code, um die Datei client_secret.json in ein Token umzuwandeln, das mit genai.configure verwendet werden kann:

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow

SCOPES = ['https://www.googleapis.com/auth/generative-language.retriever']

def load_creds():
    """Converts `client_secret.json` to a credential object.

    This function caches the generated tokens to minimize the use of the
    consent screen.
    """
    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(
                'client_secret.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())
    return creds

3. Programm schreiben

Erstellen Sie jetzt Ihr script.py:

import pprint
from google import genai
from load_creds import load_creds

creds = load_creds()

client = genai.Client(credentials=creds)

print()
print('Available base models:', [m.name for m in client.models.list()])

4. Programm ausführen

Führen Sie das Beispiel in Ihrem Arbeitsverzeichnis aus:

python script.py

Wenn Sie das Skript zum ersten Mal ausführen, wird ein Browserfenster geöffnet und Sie werden aufgefordert, den Zugriff zu autorisieren.

  1. Wenn Sie noch nicht in Ihrem Google-Konto angemeldet sind, werden Sie aufgefordert, sich anzumelden. Wenn Sie in mehreren Konten angemeldet sind, wählen Sie unbedingt das Konto aus, das Sie beim Konfigurieren Ihres Projekts als „Testkonto“ festgelegt haben.

  2. Die Autorisierungsinformationen werden im Dateisystem gespeichert. Wenn Sie den Beispielcode das nächste Mal ausführen, werden Sie nicht zur Autorisierung aufgefordert.

Sie haben die Authentifizierung erfolgreich eingerichtet.