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

نوصي باستخدام مكتبات عملاء واجهة Google API مع واجهة برمجة تطبيقات إدارة عرض السعر، بحيث إلى معالجة طلبات واستجابات HTTP يدويًا. واجهة برمجة تطبيقات Google يمكن لمكتبات العملاء توفير تكامل أفضل للّغة وأمان مُحسن دعم إجراء المكالمات التي تتطلب تفويض المستخدم.

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

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

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

توفِّر أدلة مطوّري برامج واجهة برمجة تطبيقات إدارة عرض السعر مقتطفات من الرموز للميزات الثلاثة التالية اللغات:

للاطّلاع على أمثلة الدمج الكاملة بهذه اللغات، يُرجى الرجوع إلى أمثلة على واجهة برمجة تطبيقات "إدارة عرض السعر". مستودع GitHub.

ضبط البرنامج

باستخدام بيانات اعتماد OAuth 2.0 وبرنامج مثبت المكتبة، أصبحت جاهزًا لاستخدام Bid Manager 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 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 وتثبيته.

    الطريقة المفضّلة هي عبر 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);