सेवा खाता, एक तरह का Google खाता होता है. इसका इस्तेमाल किसी ऐप्लिकेशन की मदद से, OAuth 2.0 के ज़रिए प्रोग्राम के हिसाब से Google API को ऐक्सेस करने के लिए किया जा सकता है. इसके लिए मैन्युअल तरीके से अनुमति लेने की ज़रूरत नहीं होती. इसके बजाय, इसमें एक मुख्य फ़ाइल का इस्तेमाल किया जाता है. इसे सिर्फ़ आपका ऐप्लिकेशन ऐक्सेस कर सकता है.
सेवा खातों के बारे में ज़्यादा जानने से पहले, OAuth 2.0 इंस्टॉल किए गए ऐप्लिकेशन फ़्लो को लागू करने के बजाय, ज़्यादा आसान और सुझाया गया तरीका अपनाएं. इस तरीके में उपयोगकर्ता को रीफ़्रेश टोकन जनरेट करने के लिए, ऐप्लिकेशन को मैन्युअल तौर पर अनुमति देनी होती है. हालांकि, यह काम एक बार करना होगा, क्योंकि इन टोकन की समयसीमा कभी खत्म नहीं होती.
क्या अब भी पढ़ रहे हैं? ठीक है, सेवा खाते को इनमें से किसी एक तरीके से लागू किया जा सकता है:
- अगर आपके उपयोगकर्ता अलग-अलग डोमेन पर रहते हैं, तो सेवा खाते का इस्तेमाल Campaign Manager 360 के उपयोगकर्ता के तौर पर करें. इसकी मदद से, हर खाते के लिए एक नई उपयोगकर्ता प्रोफ़ाइल बनाकर, अलग-अलग एजेंसियों के मालिकाना हक वाले कई खातों से कनेक्ट किया जा सकता है. साथ ही, उन सभी को एक ही सेवा खाते से जोड़ा जा सकता है. Campaign Manager 360 के साथ सेवा खातों को इस्तेमाल करने का यह पसंदीदा तरीका है.
- अगर आपके उपयोगकर्ता, मालिकाना हक वाले एक ही डोमेन पर रहते हैं, तो पूरे डोमेन के लिए डेलिगेशन की सुविधा लागू करें. इस मामले में आपके पास G Suite के साथ रजिस्टर किए गए डोमेन का एडमिन ऐक्सेस होना चाहिए. G Suite और / या डोमेन कॉन्फ़िगरेशन से जुड़ी मदद के लिए, G Suite सहायता पेज देखें.
ज़रूरी शर्तें
किसी सेवा खाते को Campaign Manager 360 के उपयोगकर्ता के तौर पर लागू करने के लिए, Campaign Manager 360 के उपयोगकर्ता टैब को चुनें. पूरे डोमेन के लिए डेटा का ऐक्सेस देने की सुविधा लागू करने के लिए, नीचे दिया गया डेलिगेशन टैब चुनें.
आपके पास Campaign Manager 360 खाते का ऐक्सेस होना चाहिए, जिसमें एपीआई का ऐक्सेस चालू हो.
- आपके पास Campaign Manager 360 खाते का ऐक्सेस होना चाहिए, जिसमें एपीआई का ऐक्सेस चालू हो.
- आपके पास G Suite के साथ रजिस्टर किए गए डोमेन का एडमिन ऐक्सेस होना चाहिए.
- आपके पास Campaign Manager 360 की उपयोगकर्ता प्रोफ़ाइल होनी चाहिए, जो G Suite से रजिस्टर किए गए डोमेन के एक या एक से ज़्यादा खातों से लिंक हो. उदाहरण के लिए, gmail.com जैसे दूसरे डोमेन के खातों से लिंक की गई उपयोगकर्ता प्रोफ़ाइलों का इस्तेमाल नहीं किया जा सकता.
सेवा खाता कॉन्फ़िगर करना और उसका इस्तेमाल करना
सेवा खाते का इस्तेमाल करके Campaign Manager 360 के उपयोगकर्ता के तौर पर जोड़ने के लिए, Campaign Manager 360 के उपयोगकर्ता टैब को चुनें. पूरे डोमेन के लिए डेटा का ऐक्सेस देने की सुविधा लागू करने के लिए, नीचे दिया गया डेलिगेशन टैब चुनें.
- Google API कंसोल में सेवा खाता कुंजी जनरेट करें.
चेतावनी: उस कुंजी फ़ाइल को सुरक्षित रखना ज़रूरी है जो सेवा खाते को Google की उन सेवाओं का ऐक्सेस देती है जिनके लिए उसे अनुमति दी गई है. - Campaign Manager 360 की उपयोगकर्ता प्रोफ़ाइल को पिछले चरण में मिले सेवा खाते के ईमेल से जोड़ें. इसके बारे में, सहायता केंद्र के उपयोगकर्ता ऐक्सेस मैनेज करना लेख में बताया गया है.
- अपने ऐप्लिकेशन में, सर्वर-टू-सर्वर OAuth 2.0 फ़्लो को लागू करने के लिए, अपने नए सेवा खाते का इस्तेमाल करें. ज़्यादा जानकारी के लिए, उदाहरण सेक्शन देखें.
- Google API कंसोल में सेवा खाता कुंजी जनरेट करें.
चेतावनी: उस कुंजी फ़ाइल को सुरक्षित रखना ज़रूरी है जो सेवा खाते को Google की उन सेवाओं का ऐक्सेस देती है जिनके लिए उसे अनुमति दी गई है. खास तौर पर, पूरे डोमेन के लोगों के डेटा का ऐक्सेस दें. ऐसा इसलिए, क्योंकि G Suite का डोमेन लेवल कंट्रोल, सेवा खाते को डोमेन में किसी उपयोगकर्ता के नाम का गलत इस्तेमाल करने की अनुमति देता है. सेवा खातों में, हर एक के लिए सिर्फ़ एक Google API को ऐक्सेस करने की अनुमति देना भी एक अच्छा तरीका है. इसके लिए, अगले चरण में दिए गए "स्कोप" फ़ील्ड का इस्तेमाल करें. इससे बचाव का तरीका यह है कि किसी सेवा खाते की मुख्य फ़ाइल के हैक हो जाने की स्थिति में, हमलावर उस डेटा को कम कर सकता है जिसे वह ऐक्सेस कर सकता है. - इस सेवा खाते को अपने डोमेन के उपयोगकर्ताओं के नाम पर काम करने की अनुमति देने के लिए, पूरे डोमेन के अधिकार का ऐक्सेस इस सेवा खाते को दें. जब कहा जाए, तब एपीआई के ये दायरे उपलब्ध कराएं:
दायरा मतलब https://www.googleapis.com/auth/dfatraffickingCampaign Manager 360 की ट्रैफ़िकिंग के लिए पढ़ने/लिखने का ऐक्सेस. https://www.googleapis.com/auth/dfareportingCampaign Manager 360 की रिपोर्टिंग के लिए पढ़ने/लिखने का ऐक्सेस. https://www.googleapis.com/auth/ddmconversionsCampaign Manager 360 के ऑफ़लाइन कन्वर्ज़न के लिए पढ़ने/लिखने का ऐक्सेस. - अपने ऐप्लिकेशन में, सर्वर-टू-सर्वर OAuth 2.0 फ़्लो को लागू करने के लिए, अपने नए सेवा खाते का इस्तेमाल करें. ज़्यादा जानकारी के लिए, उदाहरण सेक्शन देखें. याद रखें कि किसी दूसरे के नाम पर काम करने के लिए, आपको एक खाता उपलब्ध कराना होगा. साथ ही, यह खाता उस डोमेन से जुड़ा होना चाहिए जिसके लिए पिछले चरण में, आपके सेवा खाते को पूरे डोमेन के लिए अधिकार दिया गया था.
G Suite और / या डोमेन कॉन्फ़िगरेशन से जुड़ी मदद के लिए, G Suite सहायता पेज देखें.
उदाहरण
C#
/*
* Copyright 2015 Google Inc
*
* Licensed under the Apache License, Version 2.0(the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using Google.Apis.Auth.OAuth2;
using Google.Apis.Dfareporting.v4;
using Google.Apis.Dfareporting.v4.Data;
using Google.Apis.Json;
using Google.Apis.Services;
using System;
using System.Collections.Generic;
using System.IO;
namespace DfaReporting.Samples {
/// <summary>
/// This example demonstrates how to authenticate and make a basic request using a service
/// account.
/// </summary>
class AuthenticateUsingServiceAccount : SampleBase {
/// <summary>
/// The OAuth 2.0 scopes to request.
/// </summary>
private static readonly IEnumerable<string> OAuthScopes = new[] {
DfareportingService.Scope.Dfareporting
};
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description {
get {
return "This example demonstrates how to authenticate and make a basic request" +
" using a service account.\n";
}
}
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments.</param>
public static void Main(string[] args) {
SampleBase codeExample = new AuthenticateUsingServiceAccount();
Console.WriteLine(codeExample.Description);
codeExample.Run(null);
}
/// <summary>
/// Run the code example.
/// </summary>
/// <param name="service">Unused</param>
public override void Run(DfareportingService service) {
string pathToJsonFile = _T("ENTER_PATH_TO_JSON_FILE_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).
string emailToImpersonate = _T("");
// Build service account credential.
ServiceAccountCredential credential =
getServiceAccountCredential(pathToJsonFile, emailToImpersonate);
// Create a Dfareporting service object.
//
// Note: application name should be replaced with a value that identifies your application.
service = new DfareportingService(
new BaseClientService.Initializer {
HttpClientInitializer = credential,
ApplicationName = "C# service account sample"
}
);
// Retrieve and print all user profiles for the current authorized user.
UserProfileList profiles = service.UserProfiles.List().Execute();
foreach (UserProfile profile in profiles.Items) {
Console.WriteLine("Found user profile with ID {0} and name \"{1}\".",
profile.ProfileId, profile.UserName);
}
}
private ServiceAccountCredential getServiceAccountCredential(String pathToJsonFile,
String emailToImpersonate) {
// Load and deserialize credential parameters from the specified JSON file.
JsonCredentialParameters parameters;
using (Stream json = new FileStream(pathToJsonFile, FileMode.Open, FileAccess.Read)) {
parameters = NewtonsoftJsonSerializer.Instance.Deserialize<JsonCredentialParameters>(json);
}
// Create a credential initializer with the correct scopes.
ServiceAccountCredential.Initializer initializer =
new ServiceAccountCredential.Initializer(parameters.ClientEmail) {
Scopes = OAuthScopes
};
// Configure impersonation (if applicable).
if (!String.IsNullOrEmpty(emailToImpersonate)) {
initializer.User = emailToImpersonate;
}
// Create a service account credential object using the deserialized private key.
ServiceAccountCredential credential =
new ServiceAccountCredential(initializer.FromPrivateKey(parameters.PrivateKey));
return credential;
}
}
}
Java
// Copyright 2014 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.api.services.samples.dfareporting.auth;
import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.services.dfareporting.Dfareporting;
import com.google.api.services.dfareporting.DfareportingScopes;
import com.google.api.services.dfareporting.model.UserProfileList;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableSet;
import java.io.FileInputStream;
/**
* This example demonstrates how to authenticate and make a basic request using a service account.
*/
public class AuthenticateUsingServiceAccount {
private static final String PATH_TO_JSON_FILE = "ENTER_PATH_TO_JSON_FILE_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<String> OAUTH_SCOPES =
ImmutableSet.of(DfareportingScopes.DFAREPORTING);
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 runExample(Dfareporting reporting) throws Exception {
// Retrieve and print all user profiles for the current authorized user.
UserProfileList profiles = reporting.userProfiles().list().execute();
for (int i = 0; i < profiles.getItems().size(); i++) {
System.out.printf("%d) %s%n", i + 1, profiles.getItems().get(i).getUserName());
}
}
public static void main(String[] args) throws Exception {
// Build service account credential.
Credential credential = getServiceAccountCredential(PATH_TO_JSON_FILE, EMAIL_TO_IMPERSONATE);
// Create a Dfareporting client instance.
//
// Note: application name below should be replaced with a value that identifies your
// application. Suggested format is "MyCompany-ProductName/Version.MinorVersion".
Dfareporting reporting =
new Dfareporting.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
.setApplicationName("dfareporting-java-service-acct-sample")
.build();
runExample(reporting);
}
}
PHP
<?php
/*
* Copyright 2017 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
require_once dirname(__DIR__) . '/vendor/autoload.php';
/**
* This example demonstrates how to authenticate and make a basic request using
* a service account.
*
* This example is written to be run as a command line application, not as a
* webpage. An optional Google account email to impersonate may be specified as
* follows:
*
* AuthenticateUsingServiceAccount.php /path/to/client_secrets.json <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 that you don't own (e.g., gmail.com).
*/
class AuthenticateUsingServiceAccount
{
// The OAuth 2.0 scopes to request.
private static $OAUTH_SCOPES = [
Google_Service_Dfareporting::DFAREPORTING
];
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_Dfareporting($client);
$this->getUserProfiles($service);
}
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;
}
private function getUserProfiles($service)
{
// Retrieve and print all user profiles for the current authorized user.
$result = $service->userProfiles->listUserProfiles();
foreach ($result['items'] as $userProfile) {
printf(
"User profile \"%s\" (ID: %d) found for account %d.\n",
$userProfile->getUserName(),
$userProfile->getProfileId(),
$userProfile->getAccountId()
);
}
}
}
if ($argc < 2 || $argc >= 4) {
printf(
"Usage: %s /path/to/client_secrets.json [email_to_impersonate]\n",
$argv[0]
);
} else {
$sample = new AuthenticateUsingServiceAccount();
if ($argc == 2) {
$sample->run($argv[1]);
} else {
$sample->run($argv[1], $argv[2]);
}
}
Python
#!/usr/bin/python
#
# Copyright 2015 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""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.')
# The OAuth 2.0 scopes to request.
OAUTH_SCOPES = ['https://www.googleapis.com/auth/dfareporting']
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)
# Construct a service object via the discovery service.
service = discovery.build('dfareporting', 'v4', http=http)
try:
# Construct the request.
request = service.userProfiles().list()
# Execute request and print response.
response = request.execute()
for profile in response['items']:
print('Found user profile with ID %s and user name "%s".' %
(profile['profileId'], profile['userName']))
except client.AccessTokenRefreshError:
print('The credentials have been revoked or expired, please re-run the '
'application to re-authorize')
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=OAUTH_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)
Ruby
#!/usr/bin/env ruby
#
# Copyright:: Copyright 2016, Google Inc. All Rights Reserved.
#
# License:: Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# 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.rb <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).
require 'google/apis/dfareporting_v4'
require 'googleauth'
require 'optparse'
API_NAMESPACE = Google::Apis::DfareportingV4
def authenticate_using_service_account(path_to_json_file, impersonation_email)
# Create a Dfareporting service object.
#
# Note: application name should be replaced with a value that identifies
# your application. Suggested format is "MyCompany-ProductName".
service = API_NAMESPACE::DfareportingService.new
service.client_options.application_name = 'Ruby service account sample'
service.client_options.application_version = '1.0.0'
# Generate an authorization object from the specified JSON file.
File.open(path_to_json_file, 'r+') do |json|
service.authorization =
Google::Auth::ServiceAccountCredentials.make_creds(
json_key_io: json,
scope: [API_NAMESPACE::AUTH_DFAREPORTING]
)
end
# Configure impersonation (if applicable).
service.authorization.sub = impersonation_email unless
impersonation_email.nil?
service
end
def get_userprofiles(service)
# Get all user profiles.
result = service.list_user_profiles
# Display results.
result.items.each do |profile|
puts format(
'User profile with ID %d and name "%s" was found for account %d.',
profile.profile_id, profile.user_name, profile.account_id
)
end
end
if $PROGRAM_NAME == __FILE__
# Retrieve command line arguments.
impersonation_email = nil
optparse = OptionParser.new do |opts|
opts.banner = format('Usage: %s path_to_json_file [options]', $PROGRAM_NAME)
opts.on_tail('-i', '--impersonate EMAIL',
'Google account email to impersonate') do |email|
impersonation_email = email
end
end
optparse.parse!
if ARGV.empty?
puts optparse
exit(-1)
end
# Authenticate and initialize API service using service account.
service = authenticate_using_service_account(ARGV.shift, impersonation_email)
get_userprofiles(service)
end