بدء استخدام واجهة برمجة التطبيقات

يشرح هذا المستند كيفية البدء في كتابة التطبيقات التي تستخدم واجهة برمجة تطبيقات Google Bid Manager. تتيح لك واجهة برمجة التطبيقات إدارة طلبات البحث واسترداد البيانات الوصفية في التقارير.

الإصدار 2 من Bid Manager API هو أحدث واجهة برمجة تطبيقات متاحة ومقترَحة. .

1. قبل البدء

إذا لم تكن على دراية بمفاهيم "مساحة العرض والفيديو 360" من Google، يمكنك قراءة مقالات مركز مساعدة "مساحة العرض والفيديو 360" ومحاولة استخدام واجهة المستخدِم.

2. الاستعداد للمصادقة

لبدء استخدام Bid Manager API، عليك أولاً استخدام أداة الإعداد التي تقدّم لك إرشادات خلال عملية إنشاء المشروع في وحدة تحكّم Google API وتفعيل واجهة برمجة التطبيقات وإنشاء بيانات الاعتماد.

إذا لم يسبق لك إجراء ذلك، يمكنك إنشاء بيانات اعتماد OAuth 2.0 من خلال النقر على إنشاء بيانات الاعتماد > معرِّف عميل OAuth. بعد إنشاء بيانات الاعتماد، يمكنك الاطّلاع على معرّف العميل في صفحة بيانات الاعتماد. انقر على رقم تعريف العميل للاطّلاع على التفاصيل، مثل مفتاح سر العميل وعناوين URL لإعادة التوجيه وعنوان ملف 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 الذي يمكنه الوصول إلى ميزات "الشبكة الإعلانية" فيديو 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();

  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.");
}

لمزيد من المعلومات التفصيلية عن استخدام واجهة برمجة تطبيقات إدارة عرض السعر مع Java، يُرجى الرجوع إلى قراءة ملف في أمثلة على واجهة برمجة تطبيقات "إدارة عرض السعر"

  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)

  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. عليك تنزيل برنامج Google API PHP وتثبيته.

    الطريقة المفضّلة هي عبر 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. إنشاء برنامج للشبكة الإعلانية خدمة 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. الخطوات التالية

الآن بعد أن أصبحت لديك مكتبة عملاء جاهزة وقيد التشغيل، استكشف المرجع التوثيق والبدء في إنشاء التنفيذ.

تتوفر أيضًا أدلة إضافية على واستخدام التقارير المُجدوَلة أو اتّباع أفضل الممارسات المتعلّقة بإعداد التقارير