Pierwsze kroki z interfejsem API

Ten dokument wyjaśnia, jak zacząć pisać aplikacje korzystające z Interfejs API Google Bid Manager. Interfejs API umożliwia zarządzanie Zapytania i pobieranie Metadane raportu.

Interfejs Bid Manager API w wersji 2 to najnowsza dostępna i zalecana wersja wersji.

1. Zanim rozpoczniesz

Jeśli nie znasz jeszcze sieci reklamowej Google i Pojęcia związane z Video 360, przeczytaj Wyświetlacz & Centrum pomocy Video 360 eksperymentumy za pomocą interfejsu.

2. Przygotowanie do uwierzytelniania

Aby zacząć korzystać z interfejsu Bid Manager API, musisz: użyj w narzędziu konfiguracji, które przeprowadzi Cię przez proces tworzenia projektu w Konsola interfejsów API Google, włączenie interfejsu API i tworzenie danych logowania.

Utwórz dane uwierzytelniające OAuth 2.0, klikając Utwórz dane logowania > Identyfikator klienta OAuth. Po utworzeniu pliku dane logowania, identyfikator klienta znajdziesz na stronie Dane logowania. Kliknij identyfikator klienta w celu uzyskania szczegółowych informacji, takich jak tajny klucz klienta, identyfikatory URI przekierowania, kod JavaScript adresu źródłowego i adresu e-mail.

Więcej informacji: Autoryzacja żądań.

3. Wywoływanie interfejsu Bid Manager API

Karty poniżej zawierają krótkie wprowadzenia do kodowania w różnych językach. Podobna przykładowy kod można też znaleźć Interfejs API usługi Bid Manager – przykłady repozytorium.

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.doubleclickbidmanager.DoubleClickBidManager;
    import com.google.api.services.doubleclickbidmanager.model.ListQueriesResponse;
    import com.google.api.services.doubleclickbidmanager.model.Query;
    import java.io.Reader;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
  2. Wczytaj plik z tajnymi kluczami klienta i wygeneruj dane uwierzytelniające.

    Gdy pierwszy raz wykonasz ten krok, pojawi się prośba o zaakceptowanie autoryzacji w przeglądarce. Zanim zaakceptujesz zaproszenie, upewnij się, że korzystasz z konto Google z dostępem do Display &Video 360 Film 360. Twoja aplikacja zostanie autoryzowana uzyskać dostęp do danych w imieniu tego, z którego aktualnie korzystasz.

    // 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.
    DoubleClickBidManager service =
        new DoubleClickBidManager.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
            .setApplicationName("bidmanager-java-installed-app-sample")
            .build();
    
  4. Wykonaj operację.

    // Perform an operation.
    // Call the API, getting a list of 10 queries.
    ListQueriesResponse queriesResponse = service.queries().list().setPageSize(10).execute();
    
    // Print them out.
    System.out.println("Id\t\tName");
    if (queriesResponse.getQueries().size() > 0) {
      for (int i = 0; i < queriesResponse.getQueries().size(); i++) {
        Query currentQuery = queriesResponse.getQueries().get(i);
        System.out.printf(
            "%s\t%s%n",
            currentQuery.getQueryId(),
            currentQuery.getMetadata().getTitle());
      }
    } else {
      System.out.println("No queries exist.");
    }
    

Szczegółowe informacje o korzystaniu z interfejsu Bid Manager API w języku Java znajdziesz zapoznaj się z README (w języku angielskim) w Przykłady interfejsu API usługi Bid Manager.

Python

  1. Zaimportuj niezbędne biblioteki.

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient import discovery
    
  2. Wczytaj plik z tajnymi kluczami klienta i wygeneruj dane uwierzytelniające.

    Gdy pierwszy raz wykonasz ten krok, pojawi się prośba o zaakceptowanie autoryzacji w przeglądarce. Zanim zaakceptujesz zaproszenie, upewnij się, że korzystasz z konto Google z dostępem do Display &Video 360 Film 360. Twoja aplikacja zostanie autoryzowana uzyskać dostęp do danych w imieniu tego, z którego aktualnie korzystasz.

    # 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://doubleclickbidmanager.googleapis.com/$discovery/rest?version=v2'
    
    # Build the API service.
    service = discovery.build(
        'doubleclickbidmanager',
        'v2',
        discoveryServiceUrl=discovery_url,
        credentials=credentials)
    
  4. Wykonaj operację.

    # Build and execute queries.listqueries request.
    response = service.queries().list(pageSize='10').execute()
    
    # Print queries out.
    if 'queries' in response:
      print('Id\t\tName')
      for query in response['queries']:
        print('%s\t%s' % (query['queryId'], query['metadata']['title']))
    else:
      print('No queries exist.')
    

Szczegółowe informacje o korzystaniu z interfejsu Bid Manager API w Pythonie znajdziesz zapoznaj się z README (w języku angielskim) w Przykłady interfejsu API usługi Bid Manager.

PHP

W tym przykładzie zakładamy, że używasz języka PHP z wbudowanym serwerem WWW skonfigurowały Twoje dane logowania tak, aby przekierowywały na odpowiednią stronę internetową. Dla: ten kod w pliku index.php można uruchomić przy użyciu polecenie i dane logowania skonfigurowane pod kątem przekierowania do http://localhost:8000 po uwierzytelnianie:

php -S localhost:8000 -t ./

  1. Pobierz i zainstaluj klienta PHP interfejsu Google API.

    Preferowana metoda to Composer:

    composer require google/apiclient:^2.12.1
    

    Pamiętaj, aby po zainstalowaniu dodać moduł automatycznego wczytywania.

    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 pierwszy raz wykonasz ten krok, pojawi się prośba o zaakceptowanie autoryzacji w przeglądarce. Zanim zaakceptujesz zaproszenie, upewnij się, że korzystasz z konto Google z dostępem do Display &Video 360 Film 360. Twoja aplikacja zostanie autoryzowana uzyskać dostęp do danych w imieniu tego, z którego aktualnie korzystasz.

    // 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. Tworzenie klienta dla sieci reklamowej Usługa interfejsu Video 360 API.

    $service = new Google_Service_DoubleClickBidManager($client);
    
  5. Wykonaj operację.

    // Configure params for the Queries.listqueries request.
    $optParams = array('pageSize' => 10);
    
    // Execute the request.
    $result = $service->queries->listQueries($optParams);
    
    // Print the retrieved queries.
    if (!empty($result->getQueries())) {
      print('<pre><p>Id Name</p>');
      foreach ($result->getQueries() as $query) {
        printf('<p>%s %s</p>', $query->queryId, $query->metadata->title);
      }
      print('</pre>');
    } else {
      print '<p>No queries exist.</p>';
    }
    

Więcej informacji o korzystaniu z interfejsu Bid Manager API z językiem PHP znajdziesz zapoznaj się z README (w języku angielskim) w Przykłady interfejsu API usługi Bid Manager.

4. Dalsze kroki

Po utworzeniu i uruchomieniu biblioteki klienta zapoznaj się z dokumentacją dokumentacji i zacznij tworzyć implementację.

Dostępne są również dodatkowe przewodniki: korzystanie z zaplanowanych raportów. oraz zgodnie ze sprawdzonymi metodami raportowania.