पूरे Google Workspace एडमिन को ऐक्सेस देना

Cloud Search Query API के लिए यह ज़रूरी है कि एपीआई कॉल को OAuth क्रेडेंशियल का इस्तेमाल करके अनुमति दी गई हो. यह क्रेडेंशियल आपके डोमेन के लाइसेंस वाले उपयोगकर्ता के होने चाहिए. सेवा खातों का इस्तेमाल डिफ़ॉल्ट रूप से, इंडेक्स और कॉन्फ़िगरेशन एपीआई को ऐक्सेस करने के लिए नहीं किया जाता. क्वेरी एपीआई कॉल के लिए इनका इस्तेमाल नहीं किया जा सकता. ऐसा इसलिए, क्योंकि ये ऐसे डोमेन उपयोगकर्ता नहीं हैं जिनके पास Cloud Search या Google Workspace का लाइसेंस हो. अगर आपको क्वेरी एपीआई कॉल की पुष्टि करते समय किसी सेवा खाते का इस्तेमाल करना है, तो डोमेन एडमिन पूरे खाते के लिए उपयोगकर्ता के डेटा का ऐक्सेस दे सकता है — इसे पूरे डोमेन के उपयोगकर्ताओं को डेटा का ऐक्सेस देना कहा जाता है. जिस सेवा खाते को सेवा देने के अधिकार दिए गए हैं वह किसी भी उपयोगकर्ता के नाम पर काम कर सकता है. इसमें Cloud Search का ऐक्सेस रखने वाले उपयोगकर्ता भी शामिल हैं.

सेवा खाता और क्रेडेंशियल बनाना

अगर आपके पास सेवा खाते के क्रेडेंशियल नहीं हैं, तो सेवा खाते के क्रेडेंशियल बनाना देखें.

अपने सेवा खाते को पूरे डोमेन के अधिकार सौंपना

Google Workspace डोमेन पर उपयोगकर्ता का डेटा ऐक्सेस करने के लिए, आपको जो सेवा खाता बनाना है उसे डोमेन के सुपर एडमिन से ऐक्सेस देना होगा. पूरे डोमेन के लिए डेटा का ऐक्सेस देने के बारे में ज़्यादा जानने के लिए, पूरे डोमेन के लिए डेटा का ऐक्सेस दें और Google Workspace API का ऐक्सेस कंट्रोल करना लेख पढ़ें.

किसी सेवा खाते को पूरे डोमेन का अधिकार देने के लिए:

  1. अपने डोमेन के Admin console में, मुख्य मेन्यू > सुरक्षा > ऐक्सेस और डेटा कंट्रोल > एपीआई कंट्रोल पर जाएं.

  2. डोमेन वाइड डेलिगेशन पैनल में, डोमेन वाइड डेलिगेशन मैनेज करें चुनें.

  3. नया जोड़ें पर क्लिक करें.

  4. क्लाइंट आईडी फ़ील्ड में, वह क्लाइंट आईडी डालें जो सेवा खाता बनाने के लिए ऊपर बताए गए तरीके से मिला है.

  5. OAuth का दायरा फ़ील्ड में, आपके ऐप्लिकेशन के लिए ज़रूरी दायरों की कॉमा-डीलिमिटेड सूची डालें. क्वेरी एपीआई का इस्तेमाल करके, खोज ऐप्लिकेशन के लिए https://www.googleapis.com/auth/cloud_search.query स्कोप का इस्तेमाल करें.

  6. अनुमति दें पर क्लिक करें.

आपके सेवा खाते के पास अब पूरे डोमेन के लिए Cloud Search Query API का ऐक्सेस है. और इस दायरे में आपके डोमेन के किसी भी उपयोगकर्ता के नाम पर काम किया जा सकता है. आप अपने डोमेन के उपयोगकर्ताओं की ओर से, अनुमति वाले Cloud Search API सेवा ऑब्जेक्ट को इंस्टैंशिएट करने के लिए तैयार हैं.

Cloud Search API सेवा ऑब्जेक्ट को इंस्टैंशिएट करें

इस सेक्शन में बताया गया है कि Cloud Search API सेवा ऑब्जेक्ट को कैसे इंस्टैंशिएट करें. इसके बाद, इसे OAuth 2.0 और अपने सेवा खाते के क्रेडेंशियल का इस्तेमाल करके, एपीआई अनुरोध करने की अनुमति कैसे दें, ताकि पूरे Google Workspace डोमेन पर डेटा का ऐक्सेस दिया जा सके. इन उदाहरणों में, 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)