Method: customers.generateIvtReport

クエリの実行を開始して、特定のプラットフォームの無効なトラフィック数の日次サマリーを取得します。結果は、指定した BigQuery 宛先テーブルに書き込まれます。返されたオペレーション名を使用して、クエリ完了ステータスをポーリングできます。

出力テーブルには、期間内の日付ごとに 5 行が含まれます。4 種類のデバイスごとに 1 行、すべてのデバイスタイプごとに 1 行。[すべて] 行は、その日の 4 つのデバイスタイプの合計です。そのため、各列には合計インプレッション数の 2 倍が含まれます。プライバシーの制約により ADH によって行が秘匿化される場合、フィルタリングされた行の概要(曜日のない行)には、削除された行の合計が含まれます。

HTTP リクエスト

POST https://adsdatahub.googleapis.com/v1/{name=customers/*}:generateIvtReport

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

Ads Data Hub のお客様がリクエストを行います。これは、'customers/[customerId]' の形式です(例: 'customers/123')。

リクエスト本文

リクエストの本文には次の構造のデータが含まれます。

JSON 表現
{
  "adsDataCustomerId": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "timeZone": string,
  "destTable": string,

  // Union field platform_dimensions can be only one of the following:
  "googleAdsDimensions": {
    object (GoogleAdsDimensions)
  },
  "dv360YoutubeDimensions": {
    object (Dv360Dimensions)
  },
  "ytReserveDimensions": {
    object (YouTubeReserveDimensions)
  }
  // End of list of possible types for union field platform_dimensions.
}
フィールド
adsDataCustomerId

string (int64 format)

広告データを所有するリンクされた Data Data Hub お客様 ID。

startDate

object (Date)

生成されたレポートの開始日。

endDate

object (Date)

生成されたレポートの最終日。

timeZone

string

(省略可)レポートの開始日と終了日のタイムゾーン。指定しない場合、デフォルトは 'UTC' です。

destTable

string

'project.dataset.table_name' 形式のクエリ結果の宛先 BigQuery テーブル。指定するには、お客様の ADH アカウントのプロジェクトを明示的に許可リストに登録する必要があります。プロジェクトが指定されていない場合は、指定したお客様のデフォルトのプロジェクトが使用されます。プロジェクトもデータセットも指定しない場合、デフォルトのプロジェクトとデータセットが使用されます。

共用体フィールド platform_dimensions。プラットフォーム(オプション)のスライスでレポートするプラットフォーム。プラットフォームを選択しないと、エラーが発生します。platform_dimensions は次のいずれかになります。
googleAdsDimensions

object (GoogleAdsDimensions)

Google 広告プラットフォームのレポートを作成する

dv360YoutubeDimensions

object (Dv360Dimensions)

ディスプレイ&ビデオ 360 プラットフォームに関するレポートを作成する。

ytReserveDimensions

object (YouTubeReserveDimensions)

プラットフォーム YTR に関するレポート

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/adsdatahub

Google 広告のサイズ

Google 広告プラットフォームのフィルタ ディメンション。

JSON 表現
{
  "campaignIds": [
    string
  ],
  "metricType": enum (MetricType)
}
フィールド
campaignIds[]

string (int64 format)

Google 広告の広告キャンペーン ID(省略可)。空白のままにすると、指定した期間内のすべてのキャンペーンがレポート対象になります。

metricType

enum (MetricType)

測定とレポート作成を行うプラットフォームを指定します。

MetricType

測定とレポート作成を行うプラットフォームを指定します。

列挙型
METRIC_TYPE_UNSPECIFIED 指標タイプが指定されていません。
METRIC_TYPE_IMPRESSION Google 広告のインプレッション データ。
METRIC_TYPE_YOUTUBE_VIEW YouTube の視聴回数は TrueView の視聴回数とも呼ばれます。

Dv360 のサイズ

ディスプレイ&ビデオ 360 プラットフォームのフィルタ ディメンション。

JSON 表現
{
  "lineItemIds": [
    string
  ],
  "metricType": enum (MetricType)
}
フィールド
lineItemIds[]

string (int64 format)

ディスプレイ&ビデオ 360 広告申込情報 ID(省略可)。空白の場合は、指定した期間内のすべての広告申込情報のレポートが作成されます。

metricType

enum (MetricType)

測定とレポート作成を行うプラットフォームを指定します。

YouTubeReserve のサイズ

YouTube Reserve プラットフォームのディメンションをフィルタします。

JSON 表現
{
  "orderIds": [
    string
  ],
  "metricType": enum (MetricType)
}
フィールド
orderIds[]

string (int64 format)

YouTube Reserve の注文 ID(省略可)。空白のままにすると、指定した期間内のすべての注文がレポートされます。

metricType

enum (MetricType)

測定とレポート作成を行うプラットフォームを指定します。