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

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

Bid Manager API v2 הוא הגרסה העדכנית והזמינה ביותר.

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

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

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

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

אם עדיין לא עשית זאת, עליך ליצור את פרטי הכניסה של OAuth 2.0 על ידי לחיצה על יצירת פרטי כניסה ו-gt. מזהה לקוח ב-OAuth. אחרי שיוצרים את פרטי הכניסה, אפשר לראות את מספר הלקוח בדף פרטי כניסה. לוחצים על מספר הלקוח כדי לקבל פרטים נוספים, כמו סוד לקוח, כתובות URI להפניה אוטומטית, כתובת המקור של JavaScript וכתובת אימייל.

למידע נוסף, ראו אישור בקשות.

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

הכרטיסיות הבאות מספקות הוראות מהירות לתכנות בשפות שונות. תוכלו למצוא קוד לדוגמה גם בדוגמאות של ממשק ה-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.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. טוענים את קובץ ה-Secrets של הלקוח ויוצרים פרטי כניסה להרשאה.

    בפעם הראשונה שתבצעו את השלב הזה, תתבקשו לאשר בקשת הרשאה בדפדפן. לפני האישור, צריך לוודא שאתם מחוברים לחשבון 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.

Python

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

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient import discovery
    
  2. טוענים את קובץ ה-Secrets של הלקוח ויוצרים פרטי כניסה להרשאה.

    בפעם הראשונה שתבצעו את השלב הזה, תתבקשו לאשר בקשת הרשאה בדפדפן. לפני האישור, צריך לוודא שאתם מחוברים לחשבון 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 ב-דוגמאות של Campaign Manager API.

PHP

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

php -S localhost:8000 -t ./

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

    השיטה המועדפת היא באמצעות מלחין:

    composer require google/apiclient:^2.12.1
    

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

    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('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. השלבים הבאים

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

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