حساب سرویس نوعی حساب Google است که می تواند توسط یک برنامه کاربردی برای دسترسی برنامه نویسی به API های Google از طریق OAuth 2.0 استفاده شود. این به مجوز انسانی نیاز ندارد، اما در عوض از یک فایل کلیدی استفاده می کند که فقط برنامه شما می تواند به آن دسترسی داشته باشد.
قبل از خواندن اطلاعات بیشتر در مورد حساب‌های سرویس، جریان برنامه نصب شده OAuth 2.0 ساده‌تر و توصیه‌شده‌تر را در نظر بگیرید. در حالی که این جریان نیاز به تعامل دستی کاربر برای تأیید برنامه شما دارد، این مرحله باید فقط یک بار انجام شود و نیازی به انجام آن در محیط تولید شما نیست. توکن‌های تازه‌سازی تولید شده توسط این جریان هرگز منقضی نمی‌شوند، می‌توانند در حافظه پنهان ذخیره شوند و در محیط‌های مختلف مستقر شوند و ممکن است برای تولید نشانه‌های دسترسی در صورت تقاضا و بدون تعامل کاربر استفاده شوند.
هنوز در حال خواندن؟ بسیار خوب، می‌توانید از یکی از راه‌های زیر از حساب سرویس استفاده کنید:
- یک کاربر Display & Video 360 مرتبط با حساب سرویس خود ایجاد کنید. در این سناریو، حساب سرویس شما مانند یک حساب کاربری معمولی رفتار می کند و به شما امکان می دهد به همه شرکا و تبلیغ کنندگانی که کاربر در اختیار آنها قرار گرفته است دسترسی داشته باشید. این روش ترجیحی برای استفاده از حساب‌های سرویس با Display & Video 360 است.
- برای درخواست از طرف یک یا چند کاربر Display & Video 360 که به حساب‌های تحت دامنه G Suite پیوند داده شده‌اند ، از تفویض اختیار در سطح دامنه استفاده کنید. در این صورت باید دسترسی مدیر به دامنه هدف داشته باشید. برای راهنمایی در مورد پیکربندی G Suite و/یا دامنه، صفحه پشتیبانی G Suite را ببینید.
پیش نیازها
برای استفاده از حساب سرویس مرتبط با کاربر Display & Video 360، برگه کاربر DV360 را در زیر انتخاب کنید. برای استفاده از تفویض اختیار در دامنه، برگه Delegation را انتخاب کنید.
کاربر DV360
شما باید یک کاربر Display & Video 360 به حساب سرویس خود پیوند داده باشید.
هیئت نمایندگی
- باید به دامنه‌ای که با G Suite ثبت شده است دسترسی سرپرست داشته باشید.
- باید یک یا چند کاربر Display & Video 360 به حساب‌های زیر دامنه ثبت‌شده در G Suite شما پیوند داده شده باشند. کاربرانی که به حساب های تحت دامنه های دیگر (به عنوان مثال، gmail.com) پیوند داده شده اند، قابل استفاده نیستند.
پیکربندی و استفاده از حساب سرویس
کاربر DV360
یک کلید حساب سرویس در کنسول API Google ایجاد کنید.
کاربر Display & Video 360 را با ایمیل حساب سرویس به دست آمده در مرحله قبل همانطور که در مقاله مدیریت کاربران در مرکز راهنمایی Display & Video 360 توضیح داده شده است مرتبط کنید.
جریان OAuth 2.0 سرور به سرور را در برنامه خود با استفاده از حساب سرویس جدید ایجاد شده خود پیاده سازی کنید. برای اطلاعات بیشتر به بخش نمونه ها مراجعه کنید.
هیئت نمایندگی
یک کلید حساب سرویس در کنسول API Google ایجاد کنید.
اختیارات گسترده دامنه را به این حساب سرویس تفویض کنید تا به آن اجازه دهید هویت کاربران دامنه شما را جعل کند. هنگامی که از شما خواسته شد، دامنه های API زیر را ارائه دهید:
دامنه معنی https://www.googleapis.com/auth/display-videoدسترسی خواندن/نوشتن https://www.googleapis.com/auth/display-video-user-managementدسترسی خواندن/نوشتن برای سرویس users. فقط برای کاربران حساب خدمات موجود است.جریان OAuth 2.0 سرور به سرور را در برنامه خود با استفاده از حساب سرویس جدید ایجاد شده خود پیاده سازی کنید. برای اطلاعات بیشتر به بخش نمونه ها مراجعه کنید. به یاد داشته باشید که برای جعل هویت باید یک حساب ارائه دهید، و این حساب باید به دامنه ای تعلق داشته باشد که در مرحله قبل به حساب سرویس شما مجوز در سراسر دامنه واگذار شده است.
برای راهنمایی در مورد پیکربندی G Suite و/یا دامنه، صفحه صفحه پشتیبانی G Suite را ببینید.
نمونه ها
جاوا
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.
}
}
پایتون
"""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;
}
}