تثبيت البرنامج وإعداده

ننصحك باستخدام مكتبات برامج Google API مع Bid Manager API، ما يغنيك عن معالجة طلبات HTTP واستجاباتها يدويًا. يمكن أن توفّر مكتبات عملاء واجهة Google API نتائج أفضل على مستوى التكامل اللغوي والأمان المعزَّز، كما تتيح إمكانية إجراء الطلبات التي تحتاج إلى إذن من المستخدم.

تم إنشاء Bid Manager API استنادًا إلى HTTP وJSON. إذا كنت تفضّل معالجة الطلبات والاستجابات يدويًا، يمكنك استخدام أي برنامج عادي للتعامل مع HTTP.

تثبيت مكتبة برامج

نوفّر مكتبات برامج للعملاء تتوافق مع واجهة برمجة التطبيقات Bid Manager API بلغات برمجة متعدّدة. للحصول على قائمة كاملة بمكتبات البرامج، يمكنك الاطّلاع على علامة التبويب "نماذج ومكتبات".

توفّر أدلة المطوّرين لواجهة برمجة التطبيقات Bid Manager مقتطفات من الرموز البرمجية للغات الثلاث التالية:

• Java
• Python
• PHP

للاطّلاع على أمثلة على عمليات الدمج الكاملة بهذه اللغات، راجِع مستودع GitHub الخاص بأمثلة Bid Manager API.

إعداد العميل

باستخدام بيانات اعتماد OAuth 2.0 ومكتبة برامج عميل مثبَّتة، يمكنك البدء في استخدام Bid Manager API. في ما يلي كيفية تفويض العميل وإعداده:

جافا

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 java.io.Reader;
   import java.nio.file.Files;
   import java.nio.file.Paths;

2. حمِّل ملف أسرار العميل وأنشئ بيانات اعتماد التفويض.

   عند تنفيذ هذه الخطوة لأول مرة، سيُطلب منك قبول طلب تفويض في المتصفح. قبل قبول الدعوة، تأكَّد من تسجيل الدخول باستخدام حساب Google لديه إذن الوصول إلى "مساحة العرض والفيديو 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. إنشاء عميل معتمَد لواجهة برمجة التطبيقات

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

Python

1. استيراد المكتبات الضرورية

   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient import discovery

2. حمِّل ملف أسرار العميل وأنشئ بيانات اعتماد التفويض.

   عند تنفيذ هذه الخطوة لأول مرة، سيُطلب منك قبول طلب تفويض في المتصفح. قبل قبول الدعوة، تأكَّد من تسجيل الدخول باستخدام حساب Google لديه إذن الوصول إلى "مساحة العرض والفيديو 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. إنشاء عميل معتمَد لواجهة برمجة التطبيقات

   # 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 ./

1. نزِّل برنامج Google API PHP Client وثبِّته.

   الطريقة المفضّلة هي من خلال Composer:

   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 لديه إذن الوصول إلى "مساحة العرض والفيديو 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);