Instalowanie i konfigurowanie klienta

Zalecamy używanie bibliotek klienta interfejsów API Google z interfejsem Display & Video 360 API. Dzięki bibliotekom klienta nie musisz ręcznie wysyłać żądań HTTP ani analizować odpowiedzi. Biblioteki klienta mogą zapewniać lepszą integrację językową, wyższy poziom bezpieczeństwa i obsługę wywołań, które wymagają autoryzacji użytkownika.

Interfejs Display & Video 360 API został zaprojektowany na podstawie protokołu HTTP i JSON. Jeśli wolisz, możesz użyć dowolnego standardowego klienta HTTP do tworzenia żądań i analizowania odpowiedzi.

Instalowanie biblioteki klienta

Oferujemy biblioteki klienta, które obsługują interfejs Display & Video 360 API w różnych językach programowania. Pełną listę bibliotek klienta znajdziesz na naszej stronie z przykładami i bibliotekami.

Przewodniki dla deweloperów dotyczące interfejsu Display & Video 360 API zawierają fragmenty kodu w tych językach:

Oprócz fragmentów kodu w naszych przewodnikach udostępniamy pełne przykłady integracji w tych językach. Przykłady znajdziesz w naszym repozytorium GitHub z przykładami dotyczącymi Display & Video 360 API.

Konfigurowanie klienta

Gdy masz już dane uwierzytelniające OAuth 2.0 i zainstalowaną bibliotekę klienta, możesz zacząć korzystać z interfejsu Display & Video 360 API. Oto jak autoryzować i skonfigurować klienta:

Java

  1. Zaimportuj niezbędne biblioteki.

    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. Wczytaj plik z hasłami i wygeneruj dane uwierzytelniające.

    Gdy wykonasz ten krok po raz pierwszy, w przeglądarce pojawi się prośba o zaakceptowanie autoryzacji. Przed zaakceptowaniem upewnij się, że logujesz się za pomocą konta Google, które ma dostęp do Display & Video 360. Aplikacja będzie autoryzowana do uzyskiwania dostępu do danych w imieniu konta, na którym obecnie jesteś zalogowany(-a). Więcej informacji znajdziesz w naszym przewodniku Uprawnienia użytkownika. 

    // 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. Utwórz autoryzowanego klienta interfejsu API.

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

Python

  1. Zaimportuj niezbędne biblioteki.

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient import discovery

  2. Wczytaj plik z hasłami i wygeneruj dane uwierzytelniające.

    Gdy wykonasz ten krok po raz pierwszy, w przeglądarce pojawi się prośba o zaakceptowanie autoryzacji. Przed zaakceptowaniem upewnij się, że logujesz się za pomocą konta Google, które ma dostęp do Display & Video 360. Aplikacja będzie autoryzowana do uzyskiwania dostępu do danych w imieniu konta, na którym obecnie jesteś zalogowany(-a). Więcej informacji znajdziesz w naszym przewodniku Uprawnienia użytkownika. 

    # 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. Utwórz autoryzowanego klienta interfejsu API.

    # 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

W tym przykładzie zakładamy, że używasz PHP z wbudowanym serwerem WWW i masz skonfigurowane dane logowania, aby przekierowywać użytkowników na odpowiednią stronę internetową. Na przykład ten kod w pliku index.php można uruchomić za pomocą tego polecenia i danych logowania skonfigurowanych tak, aby po uwierzytelnieniu przekierowywać do http://localhost:8000:

php -S localhost:8000 -t ./

  1. Pobierz i zainstaluj klienta PHP interfejsu Google API.

    Preferowaną metodą jest użycie kompozytora:

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

    Po zainstalowaniu pamiętaj, aby dodać autoloader:

    require_once '/path/to/your-project/vendor/autoload.php';

  2. Utwórz obiekt Google_Client.

    $client = new Google_Client();

  3. Skonfiguruj klienta, w razie potrzeby przekieruj na adres URL uwierzytelniania i pobierz token dostępu.

    Gdy wykonasz ten krok po raz pierwszy, w przeglądarce pojawi się prośba o zaakceptowanie autoryzacji. Przed zaakceptowaniem upewnij się, że logujesz się za pomocą konta Google, które ma dostęp do Display & Video 360. Aplikacja będzie autoryzowana do uzyskiwania dostępu do danych w imieniu konta, na którym obecnie jesteś zalogowany(-a). Więcej informacji znajdziesz w naszym przewodniku Uprawnienia użytkownika. 

    // 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. Utwórz klienta usługi Display & Video 360 API.

    $service = new Google_Service_DisplayVideo($client);