使用服務帳戶

服務帳戶是一種 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 使用者,並將其連結至服務帳戶。

委派

  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. 全網域授權委派給這個服務帳戶,讓該帳戶模擬網域中的使用者。系統提示時,請提供下列 API 範圍:

    範圍意義
    https://www.googleapis.com/auth/display-video讀取/寫入權限。
    https://www.googleapis.com/auth/display-video-user-managementusers 服務的讀取/寫入權限。僅適用於服務帳戶使用者。

  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.v4.DisplayVideo;
import com.google.api.services.displayvideo.v4.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 = 'v4'
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;
    }
}