מומלץ להשתמש בספריות הלקוח של Google API עם Bid Manager API, כדי שלא תצטרכו לעבד באופן ידני בקשות ותשובות של HTTP. ספריות הלקוח של Google API יכולות לספק שילוב טוב יותר של שפה, אבטחה משופרת ותמיכה בשליחת קריאות שמחייבות הרשאת משתמש.
ממשק Bid Manager API מבוסס על HTTP ועל JSON. אם אתם מעדיפים לעבד בקשות ותשובות באופן ידני, אתם יכולים להשתמש בכל לקוח HTTP רגיל.
התקנה של ספריית לקוח
אנחנו מציעים ספריות לקוח שתומכות ב-Bid Manager API במגוון שפות תכנות. רשימה מלאה של ספריות לקוח זמינה בכרטיסייה 'דוגמאות וספריות'.
במדריכי המפתחים של Bid Manager API יש קטעי קוד בשלוש השפות הבאות:
דוגמאות לשילוב מלא בשפות האלה אפשר למצוא במאגר Bid Manager API examples ב-GitHub.
הגדרת הלקוח
אחרי שיש לכם פרטי כניסה ל-OAuth 2.0 וספריית לקוח מותקנת, אתם מוכנים להשתמש ב-Bid Manager API. כך מאשרים ומגדירים את הלקוח:
Java
מייבאים את הספריות הנדרשות.
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 java.io.Reader; import java.nio.file.Files; import java.nio.file.Paths;
טוענים את קובץ הסודות של הלקוח ויוצרים פרטי הרשאה.
בפעם הראשונה שמבצעים את השלב הזה, מוצגת בקשה לאישור הרשאה בדפדפן. לפני שמאשרים, חשוב לוודא שאתם מחוברים לחשבון 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");
יוצרים לקוח API מורשה.
// Create authorized API client. DoubleClickBidManager service = new DoubleClickBidManager.Builder(credential.getTransport(), credential.getJsonFactory(), credential) .setApplicationName("bidmanager-java-installed-app-sample") .build();
Python
מייבאים את הספריות הנדרשות.
from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient import discovery
טוענים את קובץ הסודות של הלקוח ויוצרים פרטי הרשאה.
בפעם הראשונה שמבצעים את השלב הזה, מוצגת בקשה לאישור הרשאה בדפדפן. לפני שמאשרים, חשוב לוודא שאתם מחוברים לחשבון 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()
יוצרים לקוח 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)
PHP
בדוגמה הזו מניחים שאתם מריצים את ה-PHP עם שרת אינטרנט מובנה והגדרתם את פרטי הכניסה להפניה אוטומטית לדף האינטרנט הרלוונטי. לדוגמה, אפשר להריץ את הקוד הזה בקובץ index.php באמצעות הפקודה הבאה ופרטי הכניסה שהוגדרו להפניה אוטומטית אל http://localhost:8000 אחרי האימות:
php -S localhost:8000 -t ./מורידים ומתקינים את Google API PHP Client.
השיטה המועדפת היא באמצעות Composer:
composer require google/apiclient:^2.12.1אחרי ההתקנה, חשוב לכלול את טוען האוטומטי
require_once '/path/to/your-project/vendor/autoload.php';יוצרים אובייקט Google_Client.
$client = new Google_Client();מגדירים את הלקוח, מפנים לכתובת 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);
בונים לקוח לשירות Display & Video 360 API.
$service = new Google_Service_DoubleClickBidManager($client);