Interfejs Cloud Search Query API wymaga autoryzacji wywołań interfejsu API przy użyciu danych logowania OAuth należących do licencjonowanego użytkownika w Twojej domenie. Domyślnie konta usługi używane do uzyskiwania dostępu do interfejsów API indeksowania i konfiguracji nie mogą być używane do wywołań interfejsu API zapytań, ponieważ nie są to użytkownicy domeny z licencjami na Cloud Search ani Google Workspace. Jeśli chcesz używać konta usługi do uwierzytelniania wywołań interfejsu API zapytań, administrator domeny może przyznać temu kontu dostęp do danych użytkowników w całej domenie. Jest to tzw. przekazywanie uprawnień w całej domenie. Konto usługi z przekazanymi uprawnieniami może przyjmować tożsamość dowolnego użytkownika, w tym użytkowników z dostępem do Cloud Search.
Tworzenie konta usługi i danych logowania
Jeśli nie masz jeszcze danych logowania do konta usługi, zapoznaj się z sekcją Tworzenie danych logowania do konta usługi.
Przekaż do konta usługi uprawnienia do całej domeny
Aby umożliwić dostęp do danych użytkownika w domenie Google Workspace, superadministrator domeny musi przyznać dostęp do utworzonego przez Ciebie konta usługi. Więcej informacji o przekazywaniu dostępu w całej domenie znajdziesz w artykule Kontrola nad dostępem do interfejsów Google Workspace API przy użyciu przekazywania dostępu w całej domenie.
Aby przekazać kontu usługi uprawnienia do całej domeny:
- W konsoli administracyjnej domeny otwórz Menu główne > Zabezpieczenia > Dostęp do danych i kontrola nad nimi > Dostęp do interfejsów API.
W panelu Przekazywanie dostępu w całej domenie wybierz Zarządzaj przekazywaniem dostępu w całej domenie.
Kliknij Dodaj nową.
W polu Identyfikator klienta wpisz identyfikator klienta uzyskany w ramach procedur tworzenia konta usługi powyżej.
W polu Zakresy protokołu OAuth wpisz rozdzieloną przecinkami listę zakresów wymaganych dla Twojej aplikacji. W przypadku wyszukiwarek korzystających z interfejsu Query API używaj zakresu
https://www.googleapis.com/auth/cloud_search.query.Kliknij Autoryzuj.
Twoje konto usługi ma teraz dostęp w całej domenie do interfejsu Cloud Search Query API i może przyjmować tożsamość innych użytkowników z Twojej domeny w tym zakresie. Możesz teraz uruchomić autoryzowany obiekt usługi Cloud Search API w imieniu użytkowników w domenie.
Tworzenie instancji obiektu usługi interfejsu Cloud Search API
W tej sekcji pokazujemy, jak utworzyć instancję obiektu usługi Cloud Search API, a następnie autoryzować go do wysyłania żądań do interfejsu API przy użyciu OAuth 2.0 i danych logowania do konta usługi w celu przekazywania dostępu w całej domenie Google Workspace. Przykłady odczytują informacje o koncie usługi z pliku klucza prywatnego w formacie JSON.
Java
import java.util.Collections;
import java.io.FileInputStream;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.services.cloudsearch.v1.CloudSearch;
import com.google.api.services.cloudsearch.v1.CloudSearchScopes;
...
/** Path to the Service Account's Private Key file */
private static final String SERVICE_ACCOUNT_FILE_PATH = "/path/to/key.json";
/**
* Build and return a Cloud Search service object authorized with the service
* account that acts on behalf of the given user.
*
* @param userEmail The email of the user to impersonate. Needs permissions to access Cloud Search.
* @return CloudSearch service object that is ready to make requests.
*/
public static CloudSearch getCloudSearchAPIService(String userEmail)
throws FileNotFoundException, IOException {
FileInputStream credsFile = new FileInputStream(SERVICE_ACCOUNT_FILE_PATH);
GoogleCredential init = GoogleCredential.fromStream(credsFile);
HttpTransport httpTransport = init.getTransport();
JsonFactory jsonFactory = init.getJsonFactory();
GoogleCredential creds = new GoogleCredential.Builder()
.setTransport(httpTransport)
.setJsonFactory(jsonFactory)
.setServiceAccountId(init.getServiceAccountId())
.setServiceAccountPrivateKey(init.getServiceAccountPrivateKey())
.setServiceAccountScopes(Collections.singleton(CloudSearchScopes.CLOUD_SEARCH_QUERY))
.setServiceAccountUser(userEmail)
.build();
CloudSearch service = new CloudSearch.Builder(httpTransport, jsonFactory, creds).build();
return service;
}
Python
from google.oauth2 import service_account
from googleapiclient.discovery import build
# Path to the Service Account's Private Key file
SERVICE_ACCOUNT_FILE_PATH = "/path/to/key.json"
def create_query_api_service(user_email):
"""Build and return a CloudSearch service object authorized with the service
account that acts on behalf of the given user.
Args:
user_email: The email of the user to impersonate. Needs permissions to access Cloud Search.
Returns:
Cloud Search Query API service object that is ready to make requests.
"""
credentials = service_account.Credentials.from_service_account_file(
SERVICE_ACCOUNT_FILE_PATH,
scopes=['https://www.googleapis.com/auth/cloud_search.query'])
delegated_credentials = credentials.with_subject(user_email)
return build("cloudsearch", "v1", credentials=delegated_credentials)