सेवा खाते का इस्तेमाल करना

सेवा खाता एक तरह का Google खाता है. इसका इस्तेमाल कोई ऐप्लिकेशन, OAuth 2.0 की मदद से प्रोग्राम के हिसाब से Google API को ऐक्सेस करने के लिए कर सकता है. इसके लिए किसी व्यक्ति की अनुमति की ज़रूरत नहीं होती. इसके बजाय, यह एक कुंजी फ़ाइल का इस्तेमाल करता है, जिसे सिर्फ़ आपका ऐप्लिकेशन ऐक्सेस कर सकता है.

सेवा खातों के बारे में ज़्यादा जानने से पहले, आसान और ज़्यादा सुझाए गए OAuth 2.0 इंस्टॉल किए गए ऐप्लिकेशन फ़्लो के बारे में सोचें. ऐप्लिकेशन को अनुमति देने के लिए, इस फ़्लो की ज़रूरत होती है. हालांकि, इसे सिर्फ़ एक बार पूरा किया जाना चाहिए और प्रोडक्शन एनवायरमेंट में ऐसा करना ज़रूरी नहीं है. इस फ़्लो से जनरेट किए गए रीफ़्रेश टोकन की समयसीमा कभी खत्म नहीं होती. इन्हें कैश मेमोरी में सेव किया जा सकता है और अलग-अलग प्लैटफ़ॉर्म पर डिप्लॉय किया जा सकता है. साथ ही, इनका इस्तेमाल बिना किसी उपयोगकर्ता इंटरैक्शन के, मांग पर ऐक्सेस टोकन जनरेट करने के लिए किया जा सकता है.

क्या आपको अब भी पढ़ना है? ठीक है, इनमें से किसी भी तरीके से सेवा खाते का इस्तेमाल किया जा सकता है:

  • अपने सेवा खाते से जुड़ा Display & Video 360 उपयोगकर्ता बनाएं. इस स्थिति में, आपका सेवा खाता किसी सामान्य उपयोगकर्ता खाते की तरह काम करता है और आपको उन सभी पार्टनर और विज्ञापन देने वालों को ऐक्सेस करने देता है जिनके लिए उपयोगकर्ता को प्रावधान किया गया है. यह Display & Video 360 के साथ सेवा खातों का इस्तेमाल करने का पसंदीदा तरीका है.
  • G Suite डोमेन के तहत आने वाले खातों से लिंक किए गए Display & Video 360 के एक या एक से ज़्यादा उपयोगकर्ताओं की ओर से अनुरोध करने के लिए, पूरे डोमेन को सौंपे जाने की सुविधा का इस्तेमाल करें. इस मामले में, आपके पास टारगेट डोमेन का एडमिन ऐक्सेस होना चाहिए. G Suite और/या डोमेन कॉन्फ़िगरेशन में मदद पाने के लिए, G Suite के सहायता पेज पर जाएं.

ज़रूरी शर्तें

किसी Display & Video 360 उपयोगकर्ता से जुड़े सेवा खाते का इस्तेमाल करने के लिए, नीचे DV360 उपयोगकर्ता टैब चुनें. पूरे डोमेन को सौंपे जाने की सुविधा इस्तेमाल करने के लिए, डेलिगेशन टैब चुनें.

DV360 उपयोगकर्ता

आपके Display & Video 360 उपयोगकर्ता को आपके सेवा खाते से लिंक होना चाहिए.

प्रतिनिधित्व

  1. आपके पास G Suite पर रजिस्टर किए गए डोमेन का एडमिन ऐक्सेस होना चाहिए.
  2. आपके पास Display & Video 360 के एक या उससे ज़्यादा उपयोगकर्ताओं को आपके G Suite-रजिस्टर किए गए डोमेन के खातों से लिंक होना चाहिए. दूसरे डोमेन (जैसे, gmail.com) के तहत खातों से जुड़े उपयोगकर्ताओं का इस्तेमाल नहीं किया जा सकता.

सेवा खाते को कॉन्फ़िगर करना और उसका इस्तेमाल करना

DV360 उपयोगकर्ता

  1. Google API (एपीआई) कंसोल में सेवा खाता कुंजी जनरेट करें.

  2. Display & Video 360 उपयोगकर्ता को पिछले चरण में पाए गए सेवा खाते के ईमेल से जोड़ें, जैसा कि Display & Video 360 में उपयोगकर्ताओं को मैनेज करें सहायता केंद्र लेख में बताया गया है.

  3. अपने ऐप्लिकेशन में, सर्वर-टू-सर्वर OAuth 2.0 फ़्लो लागू करें. इसके लिए, अपने नए बनाए गए सेवा खाते का इस्तेमाल करें. ज़्यादा जानकारी के लिए, उदाहरण सेक्शन देखें.

प्रतिनिधित्व

  1. Google API (एपीआई) कंसोल में सेवा खाता कुंजी जनरेट करें.

  2. इस सेवा खाते को पूरे डोमेन का अधिकार दें, ताकि यह आपके डोमेन में मौजूद उपयोगकर्ताओं के नाम पर काम कर सके. जब कहा जाए, तब ये एपीआई स्कोप उपलब्ध कराएं:

    स्कोप लिंक
    https://www.googleapis.com/auth/display-video पढ़ने/लिखने का ऐक्सेस.
    https://www.googleapis.com/auth/display-video-user-management users सेवा के लिए पढ़ने/लिखने का ऐक्सेस. यह सिर्फ़ सेवा खाते के उपयोगकर्ताओं के लिए उपलब्ध है.

  3. अपने ऐप्लिकेशन में, सर्वर-टू-सर्वर OAuth 2.0 फ़्लो लागू करें. इसके लिए, अपने नए बनाए गए सेवा खाते का इस्तेमाल करें. ज़्यादा जानकारी के लिए, उदाहरण सेक्शन देखें. याद रखें कि आपको झूठी पहचान बताने के लिए एक खाता देना होगा. साथ ही, यह खाता उस डोमेन से जुड़ा होना चाहिए जिसके लिए पिछले चरण में, आपके सेवा खाते को पूरे डोमेन पर अधिकार दिया गया था.

G Suite और / या डोमेन कॉन्फ़िगरेशन में मदद पाने के लिए, G Suite के सहायता पेज पर जाएं.

उदाहरण

Java

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.services.displayvideo.v3.DisplayVideo;
import com.google.api.services.displayvideo.v3.DisplayVideoScopes;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableSet;
import java.io.FileInputStream;

/**
 * This example demonstrates how to authenticate using a service account.
 */
public class AuthenticateUsingServiceAccount {
  // Path to a JSON file containing service account credentials for this application. This file can
  // be downloaded from the Credentials tab on the Google API Console.
  private static final String PATH_TO_JSON_FILE = "ENTER_PATH_TO_CLIENT_SECRETS_HERE";

  /**
   * An optional Google account email to impersonate. Only applicable to service accounts which have
   * enabled domain-wide delegation and wish to make API requests on behalf of an account within
   * their domain. Setting this field will not allow you to impersonate a user from a domain you
   * don't own (e.g., gmail.com).
   */
  private static final String EMAIL_TO_IMPERSONATE = "";

  // The OAuth 2.0 scopes to request.
  private static final ImmutableSet OAUTH_SCOPES =
      ImmutableSet.copyOf(DisplayVideoScopes.all());

  private static Credential getServiceAccountCredential(
      String pathToJsonFile, String emailToImpersonate) throws Exception {
    // Generate a credential object from the specified JSON file.
    GoogleCredential credential = GoogleCredential.fromStream(new FileInputStream(pathToJsonFile));

    // Update the credential object with appropriate scopes and impersonation info (if applicable).
    if (Strings.isNullOrEmpty(emailToImpersonate)) {
      credential = credential.createScoped(OAUTH_SCOPES);
    } else {
      credential =
          new GoogleCredential.Builder()
              .setTransport(credential.getTransport())
              .setJsonFactory(credential.getJsonFactory())
              .setServiceAccountId(credential.getServiceAccountId())
              .setServiceAccountPrivateKey(credential.getServiceAccountPrivateKey())
              .setServiceAccountScopes(OAUTH_SCOPES)
              // Set the email of the user you are impersonating (this can be yourself).
              .setServiceAccountUser(emailToImpersonate)
              .build();
    }

    return credential;
  }

  public static void main(String[] args) throws Exception {
    // Build service account credential.
    Credential credential = getServiceAccountCredential(PATH_TO_JSON_FILE, EMAIL_TO_IMPERSONATE);

    // Create a DisplayVideo service instance.
    //
    // Note: application name below should be replaced with a value that identifies your
    // application. Suggested format is "MyCompany-ProductName/Version.MinorVersion".
    DisplayVideo service =
        new DisplayVideo.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
            .setApplicationName("displayvideo-java-service-acct-sample")
            .build();

    // Make API requests.
  }
}

Python

"""This example demonstrates how to authenticate using a service account.

An optional Google account email to impersonate may be specified as follows:
    authenticate_using_service_account.py <path_to_json_file> -i <email>

This optional flag only applies to service accounts which have domain-wide
delegation enabled and wish to make API requests on behalf of an account
within that domain. Using this flag will not allow you to impersonate a
user from a domain you don't own (e.g., gmail.com).
"""

import argparse
import sys

from googleapiclient import discovery
import httplib2
from oauth2client import client
from oauth2client import tools
from oauth2client.service_account import ServiceAccountCredentials

# Declare command-line flags.
argparser = argparse.ArgumentParser(add_help=False)
argparser.add_argument(
    'path_to_service_account_json_file',
    help='Path to the service account JSON file to use for authenticating.')
argparser.add_argument(
    '-i',
    '--impersonation_email',
    help='Google account email to impersonate.')

API_NAME = 'displayvideo'
API_VERSION = 'v3'
API_SCOPES = ['https://www.googleapis.com/auth/display-video']


def main(argv):
  # Retrieve command line arguments.
  parser = argparse.ArgumentParser(
      description=__doc__,
      formatter_class=argparse.RawDescriptionHelpFormatter,
      parents=[tools.argparser, argparser])
  flags = parser.parse_args(argv[1:])

  # Authenticate using the supplied service account credentials
  http = authenticate_using_service_account(
      flags.path_to_service_account_json_file,
      flags.impersonation_email)

  # Build a service object for interacting with the API.
  service = discovery.build(API_NAME, API_VERSION, http=http)

  # Make API requests.

def authenticate_using_service_account(path_to_service_account_json_file,
                                       impersonation_email):
  """Authorizes an httplib2.Http instance using service account credentials."""
  # Load the service account credentials from the specified JSON keyfile.
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      path_to_service_account_json_file,
      scopes=API_SCOPES)

  # Configure impersonation (if applicable).
  if impersonation_email:
    credentials = credentials.create_delegated(impersonation_email)

  # Use the credentials to authorize an httplib2.Http instance.
  http = credentials.authorize(httplib2.Http())

  return http


if __name__ == '__main__':
  main(sys.argv)

PHP

/**
 * This example demonstrates how to authenticate using a service account.
 *
 * The optional flag email parameter only applies to service accounts which have
 * domain-wide delegation enabled and wish to make API requests on behalf of an
 * account within that domain. Using this flag will not allow you to impersonate
 * a user from a domain that you don't own (e.g., gmail.com).
 */
class AuthenticateUsingServiceAccount
{
    // The OAuth 2.0 scopes to request.
    private static $OAUTH_SCOPES = [Google_Service_DisplayVideo::DISPLAY_VIDEO];

    public function run($pathToJsonFile, $email = null)
    {
        // Create an authenticated client object.
        $client = $this->createAuthenticatedClient($pathToJsonFile, $email);

        // Create a Dfareporting service object.
        $service = new Google_Service_DisplayVideo($client);

        // Make API requests.
    }

    private function createAuthenticatedClient($pathToJsonFile, $email)
    {
        // Create a Google_Client instance.
        //
        // Note: application name should be replaced with a value that identifies
        // your application. Suggested format is "MyCompany-ProductName".
        $client = new Google_Client();
        $client->setApplicationName('PHP service account sample');
        $client->setScopes(self::$OAUTH_SCOPES);

        // Load the service account credentials.
        $client->setAuthConfig($pathToJsonFile);

        // Configure impersonation (if applicable).
        if (!is_null($email)) {
            $client->setSubject($email);
        }

        return $client;
    }
}