תחילת העבודה עם ה-API

במסמך הזה מוסבר איך להתחיל לכתוב אפליקציות שמשתמשות ב ממשק ה-API של Google Bid Manager. ה-API מאפשר לכם לנהל שאילתות ואחזור מטא-נתונים של דיווח.

Bid Manager API v2 היא הגרסה האחרונה שזמינה ומומלצת .

1. לפני שמתחילים

אם אתם לא מכירים את המושגים של Google Display & Video 360, כדאי לקרוא את המאמרים במרכז העזרה של Display & Video 360 ולנסות את ממשק המשתמש.

2. הכנה לאימות

כדי להתחיל להשתמש ב-Bid Manager API, קודם צריך להשתמש כלי ההגדרה, שמנחה אתכם איך ליצור פרויקט Google API Console, הפעלת ה-API ויצירת פרטי כניסה.

אם עדיין לא עשיתם זאת, לוחצים על Create credentials (יצירת פרטי כניסה) > OAuth client ID (מזהה לקוח OAuth) כדי ליצור את פרטי הכניסה ל-OAuth 2.0. אחרי שיצרתם את אפשר לראות את מזהה הלקוח בדף Credentials. לוחצים על מזהה הלקוח כדי לראות פרטים כמו סוד הלקוח, כתובות URI להפניה אוטומטית, כתובת המקור של JavaScript וכתובת האימייל.

מידע נוסף זמין במאמר הבא: אישור בקשות.

3. קריאה ל-Bid Manager API

בכרטיסיות הבאות תמצאו מדריכים למתחילים בנושא תכנות בשפות שונות. דומה את הקוד לדוגמה אפשר למצוא גם דוגמאות ל-Bid Manager API מאגר

JavaPythonPHP

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.doubleclickbidmanager.DoubleClickBidManager;
   import com.google.api.services.doubleclickbidmanager.model.ListQueriesResponse;
   import com.google.api.services.doubleclickbidmanager.model.Query;
   import java.io.Reader;
   import java.nio.file.Files;
   import java.nio.file.Paths;

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

   בפעם הראשונה שמבצעים את השלב הזה, מוצגת בקשה לאשר הרשאה בדפדפן. לפני שמאשרים, חשוב לוודא שנכנסתם לחשבון 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.
   DoubleClickBidManager service =
       new DoubleClickBidManager.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
           .setApplicationName("bidmanager-java-installed-app-sample")
           .build();

4. מבצעים פעולה.

   // Perform an operation.
   // Call the API, getting a list of 10 queries.
   ListQueriesResponse queriesResponse = service.queries().list().setPageSize(10).execute();
   
   // Print them out.
   System.out.println("Id\t\tName");
   if (queriesResponse.getQueries().size() > 0) {
     for (int i = 0; i < queriesResponse.getQueries().size(); i++) {
       Query currentQuery = queriesResponse.getQueries().get(i);
       System.out.printf(
           "%s\t%s%n",
           currentQuery.getQueryId(),
           currentQuery.getMetadata().getTitle());
     }
   } else {
     System.out.println("No queries exist.");
   }

למידע מפורט יותר על השימוש ב-Bid Manager API עם Java, אפשר לעיין בקובץ README בדוגמאות ל-Bid Manager API.

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

   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient import discovery

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

   בפעם הראשונה שמבצעים את השלב הזה, מוצגת בקשה לאשר הרשאה בדפדפן. לפני שמאשרים, חשוב לוודא שנכנסתם לחשבון 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://doubleclickbidmanager.googleapis.com/$discovery/rest?version=v2'
   
   # Build the API service.
   service = discovery.build(
       'doubleclickbidmanager',
       'v2',
       discoveryServiceUrl=discovery_url,
       credentials=credentials)

4. מבצעים פעולה.

   # Build and execute queries.listqueries request.
   response = service.queries().list(pageSize='10').execute()
   
   # Print queries out.
   if 'queries' in response:
     print('Id\t\tName')
     for query in response['queries']:
       print('%s\t%s' % (query['queryId'], query['metadata']['title']))
   else:
     print('No queries exist.')

למידע מפורט יותר על השימוש ב-Bid Manager API עם Python, אפשר לעיין בקובץ README בדוגמאות ל-Bid Manager API.

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

php -S localhost:8000 -t ./

1. מורידים ומתקינים את לקוח PHP של Google API.

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

   composer require google/apiclient:^2.12.1

   אחרי ההתקנה, חשוב לכלול את ה-autoloader

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

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

   $client = new Google_Client();

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

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

   // Set up the client.
   $client->setApplicationName('DBM 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_DoubleClickBidManager($client);

5. מבצעים פעולה.

   // Configure params for the Queries.listqueries request.
   $optParams = array('pageSize' => 10);
   
   // Execute the request.
   $result = $service->queries->listQueries($optParams);
   
   // Print the retrieved queries.
   if (!empty($result->getQueries())) {
     print('<pre><p>Id Name</p>');
     foreach ($result->getQueries() as $query) {
       printf('<p>%s %s</p>', $query->queryId, $query->metadata->title);
     }
     print('</pre>');
   } else {
     print '<p>No queries exist.</p>';
   }

למידע מפורט יותר על השימוש ב-Bid Manager API עם PHP, אפשר לעיין בקובץ README בדוגמאות ל-Bid Manager API.

4. השלבים הבאים

עכשיו, אחרי שספריית הלקוח מופעלת, כדאי לעיין במסמכי העזרה ולהתחיל לפתח את ההטמעה.

מדריכים נוספים זמינים גם ב: שימוש בדוחות מתוזמנים וגם לפעול בהתאם לשיטות המומלצות לדיווח.