تهيئة برنامجك

من خلال إنشاء بيانات اعتماد OAuth 2.0 وتثبيت مكتبة برامج، يمكنك بدء استخدام "مساحة العرض والفيديو 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.v3.DisplayVideo;
    import com.google.api.services.displayvideo.v3.DisplayVideo.Advertisers;
    import com.google.api.services.displayvideo.v3.model.Advertiser;
    import com.google.api.services.displayvideo.v3.model.ListAdvertisersResponse;
    import java.io.Reader;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
  2. حمِّل ملف أسرار العميل وأنشئ بيانات اعتماد التفويض.

    في المرة الأولى لتنفيذ هذه الخطوة، سيُطلب منك قبول طلب التفويض في متصفحك. قبل القبول، تأكد من تسجيل الدخول باستخدام حساب Google لديه إذن الوصول إلى "مساحة العرض والفيديو 360 ". سيتم السماح لتطبيقك بالوصول إلى البيانات نيابةً عن الحساب الذي تم تسجيل الدخول إليه حاليًا. يمكنك الاطّلاع على دليل الطلبات التفويض للحصول على مزيد من التفاصيل حول أذونات المستخدمين في "مساحة العرض والفيديو 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();
    
  4. نفِّذ عملية محدّدة.

    // Perform an operation.
    // Retrieve and print the first ten advertisers under a partner.
    ListAdvertisersResponse response =
        service
            .advertisers()
            .list()
            .setPartnerId(partner-id)
            .setPageSize(10)
            .execute();
    if (response.getAdvertisers().size() > 0) {
      for (int i = 0; i < response.getAdvertisers().size(); i++) {
        System.out.printf(
            "ID: %s Display Name: %s%n",
            response.getAdvertisers().get(i).getAdvertiserId(),
            response.getAdvertisers().get(i).getDisplayName());
      }
    } else {
      System.out.print("No advertisers found.");
    }
    

Python

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

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient import discovery
    
  2. حمِّل ملف أسرار العميل وأنشئ بيانات اعتماد التفويض.

    في المرة الأولى لتنفيذ هذه الخطوة، سيُطلب منك قبول طلب التفويض في متصفحك. قبل القبول، تأكد من تسجيل الدخول باستخدام حساب Google لديه إذن الوصول إلى "مساحة العرض والفيديو 360 ". سيتم السماح لتطبيقك بالوصول إلى البيانات نيابةً عن الحساب الذي تم تسجيل الدخول إليه حاليًا. يمكنك الاطّلاع على دليل الطلبات التفويض للحصول على مزيد من التفاصيل حول أذونات المستخدمين في "مساحة العرض والفيديو 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=v3'
    
    # Build the API service.
    service = discovery.build(
        'displayvideo',
        'v3',
        discoveryServiceUrl=discovery_url,
        credentials=credentials)
    
  4. نفِّذ عملية محدّدة.

    # Build advertisers.list request.
    request = service.advertisers().list(
        partnerId=partner-id, pageSize='10')
    
    # Execute request.
    response = request.execute()
    
    # Print response.
    if len(response['advertisers']) > 0:
      for advertiser in response['advertisers']:
        print(f'ID: {advertiser["advertiserId"]} Display Name: {advertiser["displayName"]}')
    else:
      print('No advertisers found.')
    

PHP

يفترض هذا النموذج أنك تقوم بتشغيل لغة PHP مع خادم ويب مدمج وقمت بتكوين بيانات الاعتماد الخاصة بك لإعادة التوجيه إلى صفحة الويب ذات الصلة. على سبيل المثال، يمكن تشغيل هذا الرمز في ملف index.php باستخدام الأمر وبيانات الاعتماد التالية التي تم ضبطها لإعادة التوجيه إلى http://localhost:8000 بعد المصادقة:

php -S localhost:8000 -t ./

  1. نزِّل تطبيق عميل PHP في Google API وثبِّته.

    الطريقة المفضلة هي استخدام Composer:

    composer require google/apiclient:^2.15.1 google/apiclient-services:=0.332.0
    

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

    require_once '/path/to/your-project/vendor/autoload.php';
    
  2. أنشِئ عنصر Google_Client.

    $client = new Google_Client();
    
  3. إعداد العميل وإعادة التوجيه إلى عنوان URL للمصادقة إذا لزم الأمر واسترداد رمز الدخول

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

    // Configure params for the advertisers.list request.
    $optParams = array('pageSize' => 10, 'partnerId' => partner-id);
    
    // Execute the request.
    $result = $service->advertisers->listAdvertisers($optParams);
    
    // Print the retrieved advertisers.
    if (!empty($result->getAdvertisers())) {
      print('<pre>');
      foreach ($result->getAdvertisers() as $advertiser) {
        printf('<p>ID: %s, Display Name: %s</p>', $advertiser->advertiserId, $advertiser->displayName);
      }
      print('</pre>');
    } else {
      print '<p>No advertisers found.</p>';
    }