服務帳戶是一種 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 使用者」分頁標籤。如要使用全網域委派功能,請選取「Delegation」分頁標籤。
DV360 使用者
您必須將 Display & Video 360 使用者連結至您的服務帳戶。
工作委派
- 您必須擁有管理員權限,能夠存取已向 G Suite 註冊的網域。
- 您必須將一或多位 Display & Video 360 使用者連結至您註冊 G Suite 網域下的帳戶。如果連結的是其他網域 (例如 gmail.com) 下的帳戶,則無法使用。
設定及使用服務帳戶
DV360 使用者
在 Google API 控制台中產生服務帳戶金鑰。
將 Display & Video 360 使用者與上一個步驟中取得的服務帳戶電子郵件地址建立關聯。詳情請參閱「在 Display & Video 360 中管理使用者」說明中心文章。
使用新建立的服務帳戶,在應用程式中實作伺服器對伺服器 OAuth 2.0 流程。詳情請參閱範例一節。
工作委派
在 Google API 控制台中產生服務帳戶金鑰。
將「全網域授權」委派給這個服務帳戶,允許該帳戶模擬您網域中的使用者。請在系統提示時提供下列 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 支援頁面。
範例
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 ImmutableSetOAUTH_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; } }