Menginstal dan mengonfigurasi klien

Sebaiknya Anda menggunakan library klien Google API dengan Display & Video 360 API. Dengan menggunakan library klien, Anda tidak perlu membuat permintaan HTTP dan mengurai respons secara manual. Library klien dapat memberikan integrasi bahasa yang lebih baik, keamanan yang ditingkatkan, dan dukungan untuk melakukan panggilan yang memerlukan otorisasi pengguna.

Display & Video 360 API dibuat berdasarkan HTTP dan JSON. Jika mau, Anda dapat menggunakan klien HTTP standar apa pun untuk membuat permintaan dan mengurai respons.

Menginstal library klien

Kami menawarkan library klien yang mendukung Display & Video 360 API dalam berbagai bahasa pemrograman. Untuk mengetahui daftar lengkap library klien, lihat halaman Contoh dan Library kami.

Panduan developer API Display & Video 360 menyediakan cuplikan kode untuk bahasa berikut:

Selain cuplikan kode dalam panduan kami, kami menawarkan contoh integrasi lengkap dalam bahasa-bahasa ini. Lihat repositori GitHub contoh Display & Video 360 API kami untuk mengetahui contoh ini.

Mengonfigurasi klien Anda

Dengan kredensial OAuth 2.0 dan library klien yang diinstal, Anda siap menggunakan Display & Video 360 API. Berikut cara memberi otorisasi dan mengonfigurasi klien Anda:

Java

  1. Impor library yang diperlukan.

    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. Muat file rahasia klien dan buat kredensial otorisasi.

    Saat pertama kali melakukan langkah ini, Anda akan diminta untuk menyetujui perintah otorisasi di browser. Sebelum menyetujui, pastikan Anda login dengan Akun Google yang memiliki akses ke Display & Video 360. Aplikasi Anda akan diizinkan untuk mengakses data atas nama akun mana pun yang saat ini login. Lihat panduan konsep Izin Pengguna kami untuk mengetahui detail selengkapnya.

    // 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. Buat klien API yang diotorisasi.

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

Python

  1. Impor library yang diperlukan.

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient import discovery
    
  2. Muat file rahasia klien dan buat kredensial otorisasi.

    Saat pertama kali melakukan langkah ini, Anda akan diminta untuk menyetujui perintah otorisasi di browser. Sebelum menyetujui, pastikan Anda login dengan Akun Google yang memiliki akses ke Display & Video 360. Aplikasi Anda akan diizinkan untuk mengakses data atas nama akun mana pun yang saat ini login. Lihat panduan konsep Izin Pengguna kami untuk mengetahui detail selengkapnya.

    # 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. Buat klien API yang diotorisasi.

    # 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

Contoh ini mengasumsikan bahwa Anda menjalankan PHP dengan server web bawaan dan telah mengonfigurasi kredensial Anda untuk mengalihkan ke halaman web yang relevan. Misalnya, kode ini, dalam file index.php, dapat dijalankan menggunakan perintah dan kredensial berikut yang dikonfigurasi untuk mengalihkan ke http://localhost:8000 setelah autentikasi:

php -S localhost:8000 -t ./

  1. Download dan instal Klien PHP Google API.

    Metode yang lebih disukai adalah menggunakan Composer:

    composer require google/apiclient:^2.18.2 google/apiclient-services:=0.396.0

    Setelah diinstal, pastikan untuk menyertakan autoloader:

    require_once '/path/to/your-project/vendor/autoload.php';
    
  2. Buat objek Google_Client.

    $client = new Google_Client();
    
  3. Siapkan klien, alihkan ke URL autentikasi jika diperlukan, dan ambil token akses.

    Saat pertama kali melakukan langkah ini, Anda akan diminta untuk menyetujui perintah otorisasi di browser. Sebelum menyetujui, pastikan Anda login dengan Akun Google yang memiliki akses ke Display & Video 360. Aplikasi Anda akan diizinkan untuk mengakses data atas nama akun mana pun yang saat ini login. Lihat panduan konsep Izin Pengguna kami untuk mengetahui detail selengkapnya.

    // 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. Buat klien untuk layanan Display & Video 360 API.

    $service = new Google_Service_DisplayVideo($client);