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

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

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

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

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

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

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

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

2. पूरे डोमेन के लोगों को डेटा का ऐक्सेस दें पैनल में, पूरे डोमेन के लोगों को डेटा का ऐक्सेस दें ऐक्सेस देना.

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

4. Client-ID फ़ील्ड में, सेवा खाता बनाने का तरीका ऊपर दिया गया है.

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

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

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

ध्यान दें: क्वेरी एपीआई को ऐक्सेस करने के लिए, आपकी सेवा को किसी ऐसे उपयोगकर्ता के नाम पर काम करना होगा जिसके पास ऐक्सेस हो Cloud Search में भी बदल सकते हैं. इसके अलावा, उपयोगकर्ता को कम से कम एक बार लॉग इन करना होगा और ने Google Workspace की सेवा की शर्तें स्वीकार कर ली हैं. क्वेरी एपीआई वापस आ जाएगा के नतीजे भी मिलते हैं.

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)