पूरे 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 स्कोप फ़ील्ड में, अपने ऐप्लिकेशन के लिए ज़रूरी स्कोप की कॉमा लगाकर अलग की गई सूची डालें. Query API का इस्तेमाल करके, खोज से जुड़े ऐप्लिकेशन के लिए scope https://www.googleapis.com/auth/cloud_search.query का इस्तेमाल करें.

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

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

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

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