リリースノート

このページには、Google Bid Manager API のリリースノートを掲載しています。

バージョン 2

サービス エンドポイントの更新や、サービスやメソッドの名前の変更など、API の構造を変更しました。

不要なフィールドの削除、既存のフィールドの再編成、フィールド タイプの変更により、クエリリソースと Report リソースを大幅に更新しました。これには、一般的な「ネストされたオブジェクト」の定義ではなく名前付きオブジェクトを使用するようにフィールド タイプを変更することも含まれます。

アドホック クエリを作成後に自動的に実行するのではなく、queries.run メソッドを使用して実行します。

queries.run クエリ パラメータ asynchronous を synchronous に置き換えました。

以下の変更により、レポートの取得を簡素化しました。

API から返されるエラー メッセージを更新し、より具体的で規範的な解決策を提供するようにしました。

v2 移行ガイドの手順に沿って、v1.1 から v2 に移行します。

新しい機能と特長

既知の問題

なし。

バージョン 1.1

レポート列と 1 対 1 のフィルタ間のマッピング

複数のレポート列にマッピングされていたフィルタが単一の列にマッピングされるようになりました。

たとえば、v1 ではフィルタ FILTER_ADVERTISER を含めると、「Advertiser ID」列に加えて「Advertiser」列を含むレポートが生成されます。v1.1 では、すべてのレポート列に独自のフィルタがあります。たとえば、新しいフィルタ FILTER_ADVERTISER_NAME は「広告主」にマッピングされます。レポートで [広告主 ID] 列と [広告主 ID] 列の両方を取得するには、Queries.createquery リクエストに FILTER_ADVERTISER と FILTER_ADVERTISER_NAME の両方のフィルタを含める必要があります。

より具体的には、createquery リクエストは次のようになります。

{
...
"params": {
  ...
  "groupBys": ["FILTER_ADVERTISER"],
  "metrics": ["METRIC_IMPRESSIONS"],
  ...
}
...
}

v1 では、以下のヘッダーを含むレポート ファイルが生成されます。

Advertiser,Advertiser ID,Advertiser Status,Advertiser Integration Code,Impressions

v1.1 では次のヘッダーを使っています。

Advertiser,Impressions

上記の例では、次の v1 コードを使用してレポート列を取得しています。

List<String> groupBys = new ArrayList<>();
groupBys.add("FILTER_ADVERTISER");
List<String> metrics = new ArrayList<>();
metrics.add("METRIC_IMPRESSIONS");
com.google.api.services.doubleclickbidmanager.model.Parameters createQueryParameters =
    new com.google.api.services.doubleclickbidmanager.model.Parameters()
        .setGroupBys(groupBys)
        .setMetrics(metrics);

次のように v1.1 で次のように変更する必要があります（フィルタの順序に注意してください）。

List<String> groupBys = new ArrayList<>();
groupBys.add("FILTER_ADVERTISER_NAME");
groupBys.add("FILTER_ADVERTISER");
groupBys.add("FILTER_ADVERTISER_INTEGRATION_STATUS");
groupBys.add("FILTER_ADVERTISER_INTEGRATION_CODE");
List<String> metrics = new ArrayList<>();
metrics.add("METRIC_IMPRESSIONS");
com.google.api.services.doubleclickbidmanager.model.Parameters createQueryParameters =
    new com.google.api.services.doubleclickbidmanager.model.Parameters()
        .setGroupBys(groupBys)
        .setMetrics(metrics);
元のフィルタ 追加されたフィルタ
FILTER_ADVERTISER FILTER_ADVERTISER_NAME
FILTER_ADVERTISER_INTEGRATION_CODE
FILTER_ADVERTISER_INTEGRATION_STATUS
FILTER_AD_POSITION FILTER_AD_POSITION_NAME
FILTER_CARRIER FILTER_CARRIER_NAME
FILTER_CHANNEL_ID FILTER_CHANNEL_NAME
FILTER_CITY FILTER_CITY_NAME
FILTER_COMPANION_CREATIVE_ID FILTER_COMPANION_CREATIVE_NAME
FILTER_DMA FILTER_DMA_NAME
FILTER_INSERTION_ORDER FILTER_INSERTION_ORDER_NAME
FILTER_PARTNER FILTER_PARTNER_NAME
FILTER_PARTNER_STATUS
FILTER_REGION FILTER_REGION_NAME
FILTER_TRUEVIEW_DMA FILTER_TRUEVIEW_DMA_NAME
FILTER_TRUEVIEW_IAR_REGION FILTER_TRUEVIEW_IAR_REGION_NAME
FILTER_USER_LIST_FIRST_PARTY FILTER_USER_LIST_FIRST_PARTY_NAME
FILTER_USER_LIST_THIRD_PARTY FILTER_USER_LIST_THIRD_PARTY_NAME

ページネーション

v1.1 では、Queries.listqueries メソッドと Reports.listreports メソッドにページネーションが追加されています。

v1.1 では、これらのメソッドによって返される結果の数は、新しく追加されたパラメータ pageSize と同じです（指定しない場合のデフォルトは 100 です）。レスポンスには、新しく追加された nextPageToken フィールドが含まれ、これを使用して次の結果セットを取得できます。すべての結果がある場合、このフィールドは空白になります。

特定のクエリに属するすべてのレポートを取得するための v1 コードを次に示します。

public class GetReports {
  public List<Report> getReports(DoubleClickBidManager service, long queryId) throws IOException {
    ListReportsResponse reportListResponse = service.reports().listreports(queryId).execute();

    return reportListResponse.getReports();
  }
}

すべてのレポートを引き続き取得するには、v1.1 で次のように修正する必要があります。

public class GetReports {
  public List<Report> getReports(DoubleClickBidManager service, long queryId) throws IOException {
    ListReportsResponse reportListResponse = service.reports().listreports(queryId).execute();

    List<Report> reports = new ArrayList<>(reportListResponse.getReports());
    while (reportListResponse.getNextPageToken() != null
        && reportListResponse.getNextPageToken().length() > 0) {
      // Get next set of results, aka page.
      reportListResponse =
          service
              .reports()
              .listreports(queryId)
              .setPageToken(reportListResponse.getNextPageToken())
              .execute();
      reports.addAll(reportListResponse.getReports());
    }

    return reports;
  }
}

詳しくは、Queries.listqueries メソッドと Reports.listreports メソッドのドキュメントをご覧ください。

既知の問題

なし。

バージョン 1

これはこの API の最初のバージョンです。

既知の問題

なし。