התקנה והגדרה של הלקוח

מומלץ להשתמש בספריות הלקוח של Google API עם Display & Video 360 API. כשמשתמשים בספריות לקוח, לא צריך ליצור בקשות HTTP ולנתח את התשובות באופן ידני. ספריות לקוח יכולות לספק שילוב טוב יותר של שפה, אבטחה משופרת ותמיכה בשליחת קריאות שמחייבות הרשאת משתמש.

ה-Display & Video 360 API מבוסס על HTTP ועל JSON. אם אתם מעדיפים, אתם יכולים להשתמש בכל לקוח HTTP רגיל כדי לשלוח בקשות ולנתח תשובות.

התקנה של ספריית לקוח

אנחנו מציעים ספריות לקוח שתומכות ב-Display & Video 360 API במגוון שפות תכנות. הרשימה המלאה של ספריות הלקוח זמינה בדף הדוגמאות והספריות.

במדריכי המפתחים של Display & Video 360 API מופיעים קטעי קוד בשפות הבאות:

• Java
• Python
• PHP

בנוסף לקטעי הקוד במדריכים שלנו, אנחנו מציעים דוגמאות מלאות לשילוב בשפות הבאות. דוגמאות כאלה אפשר למצוא במאגר GitHub של Display & Video 360 API.

הגדרת הלקוח

אחרי שמקבלים פרטי כניסה ב-OAuth 2.0 ומתקינים ספריית לקוח, אפשר להשתמש ב-Display & Video 360 API. כך מאשרים ומגדירים את הלקוח:

Java

1. מייבאים את הספריות הנדרשות.

   import static java.nio.charset.StandardCharsets.UTF_8;
   import com.google.api.client.auth.oauth2.Credential;
   import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
   import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
   import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
   import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
   import com.google.api.client.googleapis.util.Utils;
   import com.google.api.services.displayvideo.v4.DisplayVideo;
   import com.google.api.services.displayvideo.v4.DisplayVideo.Advertisers;
   import com.google.api.services.displayvideo.v4.model.Advertiser;
   import com.google.api.services.displayvideo.v4.model.ListAdvertisersResponse;
   import java.io.Reader;
   import java.nio.file.Files;
   import java.nio.file.Paths;
   

2. טוענים את קובץ אובייקטים מסוג secret של הלקוח ויוצרים פרטי הרשאה.

   בפעם הראשונה שמבצעים את השלב הזה, מופיעה בקשה לאישור בדפדפן. לפני שמאשרים, חשוב לוודא שאתם מחוברים לחשבון Google שיש לו גישה ל-Display & Video 360. לאפליקציה תהיה הרשאה לגשת לנתונים בשם החשבון שמחוברים אליו כרגע. לפרטים נוספים, אפשר לעיין במדריך שלנו בנושא הרשאות משתמש.

   // Read client secrets file.
   GoogleClientSecrets clientSecrets;
   try (Reader reader = Files.newBufferedReader(Paths.get(path-to-client-secrets-file), UTF_8)) {
     clientSecrets = GoogleClientSecrets.load(Utils.getDefaultJsonFactory(), reader);
   }
   
   // Generate authorization credentials.
   // Set up the authorization code flow.
   GoogleAuthorizationCodeFlow flow =
       new GoogleAuthorizationCodeFlow.Builder(
           Utils.getDefaultTransport(),
           Utils.getDefaultJsonFactory(),
           clientSecrets,
           oauth-scopes)
       .build();
   
   Credential credential =
       new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
   

3. יוצרים לקוח API מורשה.

   // Create authorized API client.
   DisplayVideo service =
       new DisplayVideo.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
           .setApplicationName("displayvideo-java-installed-app-sample")
           .build();
   

Python

1. מייבאים את הספריות הנדרשות.

   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient import discovery
   

2. טוענים את קובץ אובייקטים מסוג secret של הלקוח ויוצרים פרטי הרשאה.

   בפעם הראשונה שמבצעים את השלב הזה, מופיעה בקשה לאישור בדפדפן. לפני שמאשרים, חשוב לוודא שאתם מחוברים לחשבון Google שיש לו גישה ל-Display & Video 360. לאפליקציה תהיה הרשאה לגשת לנתונים בשם החשבון שמחוברים אליו כרגע. לפרטים נוספים, אפשר לעיין במדריך שלנו בנושא הרשאות משתמש.

   # Set up a flow object to create the credentials using the
   # client secrets file and OAuth scopes.
   credentials = InstalledAppFlow.from_client_secrets_file(
       path-to-client-secrets-file, oauth-scopes).run_local_server()
   

3. יוצרים לקוח API מורשה.

   # Build the discovery document URL.
   discovery_url = f'https://displayvideo.googleapis.com/$discovery/rest?version=v4'
   
   # Build the API service.
   service = discovery.build(
       'displayvideo',
       'v4',
       discoveryServiceUrl=discovery_url,
       credentials=credentials)
   

PHP

בדוגמה הזו מניחים שאתם מריצים את ה-PHP עם שרת אינטרנט מובנה והגדרתם את פרטי הכניסה להפניה אוטומטית לדף האינטרנט הרלוונטי. לדוגמה, אפשר להריץ את הקוד הזה בקובץ index.php באמצעות הפקודה הבאה ופרטי הכניסה שהוגדרו להפניה אוטומטית אל http://localhost:8000 אחרי אימות:

php -S localhost:8000 -t ./

1. מורידים ומתקינים את Google API PHP Client.

   השיטה המומלצת היא באמצעות Composer:

   composer require google/apiclient:^2.18.2 google/apiclient-services:=0.396.0

   אחרי ההתקנה, חשוב לכלול את טוען הכיתות האוטומטי:

   require_once '/path/to/your-project/vendor/autoload.php';
   

2. יוצרים אובייקט Google_Client.

   $client = new Google_Client();
   

3. הגדרת הלקוח, הפניה לכתובת URL לאימות אם צריך, ואחזור של אסימון גישה.

   בפעם הראשונה שמבצעים את השלב הזה, מופיעה בקשה לאישור בדפדפן. לפני שמאשרים, חשוב לוודא שאתם מחוברים לחשבון Google שיש לו גישה ל-Display & Video 360. לאפליקציה תהיה הרשאה לגשת לנתונים בשם החשבון שמחוברים אליו כרגע. לפרטים נוספים, אפשר לעיין במדריך שלנו בנושא הרשאות משתמש.

   // Set up the client.
   $client->setApplicationName('DV360 API PHP Samples');
   $client->addScope(oauth-scope);
   $client->setAccessType('offline');
   $client->setAuthConfigFile(path-to-client-secrets-file);
   
   // If the code is passed, authenticate. If not, redirect to authentication page.
   if (isset($_GET['code'])) {
     $client->authenticate($_GET['code']);
   } else {
     $authUrl = $client->createAuthUrl();
     header('Location: ' . $authUrl);
   }
   
   // Exchange authorization code for an access token.
   $accessToken = $client->getAccessToken();
   $client->setAccessToken($accessToken);
   

4. בונים לקוח לשירות Display & Video 360 API.

   $service = new Google_Service_DisplayVideo($client);