API を使い始める

このドキュメントでは、 Google Bid Manager APIAPI を使用すると クエリと取得 レポートのメタデータ。

Bid Manager API v2 は利用可能な最新かつ推奨の できます。

1. 始める前に

Google ディスプレイ ネットワークや動画の概要については、 ディスプレイと動画 360 ヘルプセンター、 UI でテストします。

2. 認証の準備をする

Bid Manager API の使用を開始するには、まず 設定ツールを使用して、Google Cloud コンソールでプロジェクトを作成する手順が Google API Console、API の有効化、認証情報の作成

OAuth 2.0 の認証情報をまだ作成していない場合は、クリックして 認証情報を作成 >OAuth クライアント ID。新しい P-MAX キャンペーンを [認証情報] ページでクライアント ID を確認できます。[ クライアント シークレット、リダイレクト URI、JavaScript などの詳細のクライアント ID 送信元アドレス、メールアドレスなどがあります

詳細については、次をご覧ください: リクエストの承認。

3. Bid Manager API を呼び出す

以下のタブでは、さまざまな言語でのコーディングのクイックスタートを示します。同程度 サンプル コードは、 Bid Manager 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.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. クライアント シークレット ファイルを読み込み、認証情報を生成します。

    この手順を初めて行うときは、信用照会に同意するよう求められます。 プロンプトが表示されます。承認する前に、 ディスプレイ &ビデオ 360 へのアクセス権がある 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. 承認済みの API クライアントを作成します。

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

  4. オペレーションを実行する。

    // 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.");
}

Java で Bid Manager API を使用する方法について詳しくは、 詳しくは、 README で Bid Manager API の例

Python

  1. 必要なライブラリをインポートします。

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient import discovery

  2. クライアント シークレット ファイルを読み込み、認証情報を生成します。

    この手順を初めて行うときは、信用照会に同意するよう求められます。 プロンプトが表示されます。承認する前に、 ディスプレイ &ビデオ 360 へのアクセス権がある 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. 承認済みの 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. オペレーションを実行する。

    # 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.')

Python で Bid Manager API を使用する方法について詳しくは、 詳しくは、 README で Bid Manager API の例

PHP

このサンプルは、組み込みのウェブサーバーで PHP を実行していることを前提としています。 関連するウェブページにリダイレクトするように認証情報が構成されていること。対象 たとえば、index.php ファイル内のこのコードは、次のコマンドで実行できます。 コマンドと認証情報が、次の日付の後に http://localhost:8000 にリダイレクトするように構成されています。 認証：

php -S localhost:8000 -t ./

  1. Google API PHP クライアントをダウンロードしてインストールします。

    推奨される方法は、Composer を使用する方法です。 

    composer require google/apiclient:^2.12.1

    インストールが完了したら、必ずオートローダーを 

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

  2. Google_Client オブジェクトを作成します。

    $client = new Google_Client();

  3. クライアントを設定し、必要に応じて認証 URL にリダイレクトして、アクセス トークンを取得します。

    この手順を初めて行うときは、信用照会に同意するよう求められます。 プロンプトが表示されます。承認する前に、 ディスプレイ &ビデオ 360 へのアクセス権がある Google アカウント動画 360アプリは承認されます 現在ログインしているアカウントの代理でデータにアクセスできます。 

    // 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. ディスプレイ &ビデオ 360 のクライアントを作成し、Video 360 API サービス。

    $service = new Google_Service_DoubleClickBidManager($client);

  5. オペレーションを実行する。

    // 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>';
}

PHP で Bid Manager API を使用する方法について詳しくは、 詳しくは、 README で Bid Manager API の例

4. 次のステップ

これでクライアント ライブラリを起動できたので、次はリファレンス 実装の詳細をご覧ください。

その他のガイドは、 スケジュール設定されたレポートの活用 および レポートのベスト プラクティスを実践する。