Konto usługi to typ konta Google, dzięki któremu aplikacja może programowo uzyskiwać dostęp do interfejsów API Google przy użyciu protokołu OAuth 2.0. Nie wymaga to autoryzacji przez człowieka, lecz pliku klucza, do którego dostęp ma tylko Twoja aplikacja.
Zanim przeczytasz więcej o kontach usługi, zapoznaj się z prostszym i bardziej zdecydowanie zalecanym procesem instalacji aplikacji OAuth 2.0. Ta procedura wymaga ręcznej autoryzacji przez użytkownika, ale można to zrobić tylko raz w środowisku produkcyjnym. Tokeny odświeżania generowane przez ten przepływ nigdy nie wygasają. Można je buforować i wdrażać w różnych środowiskach. Można ich też używać do generowania tokenów dostępu na żądanie bez konieczności interakcji ze strony użytkownika.
Nadal czytasz? Konta usługi możesz używać w jeden z tych sposobów:
- Utwórz użytkownika Display & Video 360 powiązanego z Twoim kontem usługi. W tym scenariuszu Twoje konto usługi działa jak zwykłe konto użytkownika i umożliwia dostęp do wszystkich partnerów i reklamodawców, do których użytkownik ma dostęp. Jest to preferowany sposób używania kont usługi w Display & Video 360.
- korzystać z przekazywania dostępu w całej domenie, aby wysyłać żądania w imieniu co najmniej jednego użytkownika Display & Video 360 połączonego z kontami w domenie G Suite; W takim przypadku musisz mieć dostęp administracyjny do domeny docelowej. Jeśli potrzebujesz pomocy związanej z G Suite lub konfiguracją domeny, odwiedź stronę pomocy G Suite.
Wymagania wstępne
Aby użyć konta usługi powiązanego z użytkownikiem Display & Video 360, wybierz poniżej kartę Użytkownik DV360. Aby korzystać z przekazywania dostępu w całej domenie, wybierz kartę Delegation (Przekazywanie dostępu).
Użytkownik DV360
Musisz mieć konto usługi połączone z kontem użytkownika Display & Video 360.
Przekazywanie
- Musisz mieć dostęp administratora do domeny zarejestrowanej w G Suite.
- Musisz mieć co najmniej jednego użytkownika Display & Video 360 powiązanego z kontem w zarejestrowanej domenie G Suite. Nie można korzystać z kont użytkowników połączonych z kontami w innych domenach (np. gmail.com).
Konfigurowanie konta usługi i korzystanie z niego
Użytkownik DV360
Wygeneruj klucz konta usługi w Konsoli interfejsów API Google.
Powiąż użytkownika Display & Video 360 z adresem e-mail konta usługi uzyskanym w poprzednim kroku zgodnie z opisem w artykule Zarządzanie użytkownikami w Display & Video 360 w Centrum pomocy.
Zaimplementuj w swojej aplikacji przepływ protokołu OAuth 2.0 między serwerami, korzystając z nowo utworzonego konta usługi. Więcej informacji znajdziesz w sekcji przykłady.
Przekazywanie
Wygeneruj klucz konta usługi w Konsoli interfejsów API Google.
Przekaż do tego konta usługi uprawnienia obejmujące całą domenę, aby umożliwić mu przyjmowanie tożsamości użytkowników w domenie. Gdy pojawi się prośba, podaj te zakresy interfejsu API:
Zakres Znaczenie https://www.googleapis.com/auth/display-videoUprawnienia do odczytu/zapisu. https://www.googleapis.com/auth/display-video-user-managementUprawnienia do zapisu i odczytu w usłudze users. Dostępne tylko dla użytkowników kont usługi.Zaimplementuj w swojej aplikacji przepływ protokołu OAuth 2.0 między serwerami, korzystając z nowo utworzonego konta usługi. Więcej informacji znajdziesz w sekcji przykłady. Pamiętaj, że musisz podać konto używane do podszywania się pod inne osoby. Musi ono należeć do domeny, dla której w poprzednim kroku przyznano Ci uprawnienia dotyczące całej domeny.
Aby uzyskać pomoc dotyczącą G Suite lub konfiguracji domeny, odwiedź stronę pomocy G Suite.
Przykłady
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;
}
}