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

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

تم إنشاء Display &Video 360 API استنادًا إلى HTTP وJSON. إذا كنت تفضّل ذلك، يمكنك استخدام أي برنامج HTTP عادي لإرسال الطلبات وتحليل الاستجابات.

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

نقدّم مكتبات برامج تتوافق مع Display &Video 360 API بمجموعة متنوّعة من لغات البرمجة. للاطّلاع على قائمة كاملة بمكتبات البرامج، يُرجى الانتقال إلى صفحة النماذج و المكتبات.

توفّر أدلة المطوّرين في Display &Video 360 API مقتطفات برمجية للغات التالية:

بالإضافة إلى المقتطفات البرمجية في أدلتنا، نقدّم أمثلة متكاملة في هذه اللغات. يمكنك الاطّلاع على هذه النماذج في مستودع أمثلة Display & Video 360 API على GitHub.

إعداد البرنامج

باستخدام بيانات اعتماد OAuth 2.0 ومكتبة برامج مثبَّتة، يمكنك استخدام Display & Video 360 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.displayvideo.v4.DisplayVideo;
    import com.google.api.services.displayvideo.v4.DisplayVideo.Advertisers;
    import com.google.api.services.displayvideo.v4.model.Advertiser;
    import com.google.api.services.displayvideo.v4.model.ListAdvertisersResponse;
    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.
    DisplayVideo service =
        new DisplayVideo.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
            .setApplicationName("displayvideo-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://displayvideo.googleapis.com/$discovery/rest?version=v4'
    
    # Build the API service.
    service = discovery.build(
        'displayvideo',
        'v4',
        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.18.2 google/apiclient-services:=0.396.0

    بعد التثبيت، احرص على تضمين أداة التحميل التلقائي:

    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('DV360 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. إنشاء برنامج لخدمة مساحة العرض والفيديو 360 API

    $service = new Google_Service_DisplayVideo($client);