Method: customers.generateReachForecast

指定したターゲティング / プロダクト構成のリーチ予測を生成します。

スローされるエラーのリスト: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError ReachPlanError RequestError

HTTP リクエスト

POST https://googleads.googleapis.com/v15/customers/{customerId}:generateReachForecast

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

パスパラメータ

パラメータ
customerId

string

必須。顧客の ID。

リクエスト本文

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

JSON 表現
{
  "campaignDuration": {
    object (CampaignDuration)
  },
  "cookieFrequencyCapSetting": {
    object (FrequencyCap)
  },
  "targeting": {
    object (Targeting)
  },
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "forecastMetricOptions": {
    object (ForecastMetricOptions)
  },
  "currencyCode": string,
  "cookieFrequencyCap": integer,
  "minEffectiveFrequency": integer,
  "effectiveFrequencyLimit": {
    object (EffectiveFrequencyLimit)
  },
  "customerReachGroup": string
}
フィールド
campaignDuration

object (CampaignDuration)

必須。キャンペーンの運用期間

cookieFrequencyCapSetting

object (FrequencyCap)

掲載予定の各商品に適用する、選択した Cookie のフリークエンシー キャップ。これは、キャンペーンの作成時に Google 広告で公開されるフリークエンシー キャップに相当します。指定した期間内に同じユーザーに広告を表示できる最大回数を表します。指定しない場合は、デフォルトの 0(上限なし)が適用されます。

このフィールドは、廃止された cookieFrequencyCap フィールドに代わるものです。

targeting

object (Targeting)

プロダクト構成で選択されたすべての商品に適用されるターゲティング。

これは計画されたターゲティングです。実行の詳細は広告サービスによって異なる可能性があるため、実装スペシャリストにご相談ください。

ターゲティングがどのように影響するかの詳細については、各指標をご覧ください。

plannedProducts[]

object (PlannedProduct)

必須。予測する商品。プランニング商品の最大数は 15 個です。

forecastMetricOptions

object (ForecastMetricOptions)

レスポンスで返される予測指標を制御します。

currencyCode

string

通貨コード。3 文字の ISO 4217 通貨コードを指定します。

cookieFrequencyCap

integer

掲載予定の各商品に適用する、選択した Cookie のフリークエンシー キャップ。これは、キャンペーンの作成時に Google 広告で公開されるフリークエンシー キャップに相当し、同じユーザーに広告を表示できる最大回数を表します。指定しない場合、上限は適用されません。

このフィールドは v4 で非推奨となり、最終的には削除される予定です。代わりに cookieFrequencyCapSetting を使用してください。

minEffectiveFrequency

integer

レポートされるリーチ指標(1 ~ 10)で選択された、最小有効フリークエンシー(1 人のユーザーに広告が表示された回数)。これはターゲティングには影響せず、レポートにのみ影響します。指定しない場合は、デフォルトの 1 が適用されます。

このフィールドは、effectiveFrequencyLimit フィールドと組み合わせることはできません。

effectiveFrequencyLimit

object (EffectiveFrequencyLimit)

Forecast.effective_frequency_breakdowns に含める最大有効フリークエンシー(ユーザーに広告が表示された回数)の値(1 ~ 10)。指定しない場合、Forecast.effective_frequency_breakdowns は提供されません。

ここで指定した有効フリークエンシーの値は、レポートされるリーチ指標の最小有効フリークエンシーとしても使用されます。

このフィールドは、minEffectiveFrequency フィールドと組み合わせることはできません。

customerReachGroup

string

計画しているお客様の名前。これはユーザー定義の値です。

レスポンスの本文

生成されたリーチ曲線を含むレスポンス メッセージ。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
フィールド
onTargetAudienceMetrics

object (OnTargetAudienceMetrics)

この曲線のターゲット オーディエンスの参照。

reachCurve

object (ReachCurve)

計画したプロダクト構成で生成されたリーチ曲線。

承認スコープ

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

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

詳細については、OAuth 2.0 の概要をご覧ください。

CampaignDuration

予定しているキャンペーンの期間。

JSON 表現
{
  "dateRange": {
    object (DateRange)
  },
  "durationInDays": integer
}
フィールド
dateRange

object (DateRange)

キャンペーンの期間。日付は yyyy-mm-dd 形式で指定します。終了日には今後 1 年以内、期間は 92 日以内の日付を指定してください。

このフィールドは、durationInDays フィールドと組み合わせることはできません。

durationInDays

integer

期間の値(日数)。

このフィールドは、dateRange フィールドと組み合わせることはできません。

FrequencyCap

特定の期間内に 1 人のユーザーに広告を表示する最大回数を指定するルールです。

JSON 表現
{
  "impressions": integer,
  "timeUnit": enum (FrequencyCapTimeUnit)
}
フィールド
impressions

integer

必須。インプレッション数(その値を含む)。

timeUnit

enum (FrequencyCapTimeUnit)

必須。時間単位のタイプ。

EffectiveFrequencyLimit

有効フリークエンシーの上限。

JSON 表現
{
  "effectiveFrequencyBreakdownLimit": integer
}
フィールド
effectiveFrequencyBreakdownLimit

integer

Forecast.effective_frequency_breakdowns に含める最大有効フリークエンシー値。このフィールドでは 1 ~ 10 の頻度がサポートされます。

ターゲティング

トラフィック指標を報告するターゲティング。

JSON 表現
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (ReachPlanAgeRange),
  "genders": [
    {
      object (GenderInfo)
    }
  ],
  "devices": [
    {
      object (DeviceInfo)
    }
  ],
  "network": enum (ReachPlanNetwork),
  "audienceTargeting": {
    object (AudienceTargeting)
  },
  "plannableLocationId": string
}
フィールド
plannableLocationIds[]

string

この予測でターゲットに設定できるプランニング可能な地域 ID のリスト。

複数の ID を指定する場合は、すべての ID に同じ parentCountryId を指定する必要があります。parent_county を超えるプランニングはサポートされていません。プランニング可能な地域 ID とその parentCountryIdReachPlanService.ListPlannableLocations から取得できます。

リクエストでは、このフィールドか plannableLocationId のいずれかを設定する必要があります。

ageRange

enum (ReachPlanAgeRange)

対象年齢層。値を設定しない場合、すべての年齢層がターゲットとなります。

genders[]

object (GenderInfo)

ターゲットとする性別。値を設定しない場合、MALE や FEMALE を指定した場合と同じ結果になります。

devices[]

object (DeviceInfo)

対象デバイス。指定しない場合、該当するすべてのデバイスが対象になります。該当するデバイスは製品と地域によって異なります。詳しくは ReachPlanService.ListPlannableProducts から入手できます。

network

enum (ReachPlanNetwork)

広告プロダクトのターゲティング可能なネットワーク。指定しない場合、該当するすべてのネットワークがターゲットになります。該当するネットワークはプロダクトと地域によって異なります。詳しくは ReachPlanService.ListPlannableProducts をご覧ください。

audienceTargeting

object (AudienceTargeting)

対象グループ指定しない場合、特定のオーディエンスはターゲットになりません。

plannableLocationId

string

選択したビジネスの ID。プランナブルな地域 ID は ReachPlanService.ListPlannableLocations から取得できます。

リクエストでは、このフィールドか plannableLocationIds のいずれかを設定する必要があります。

このフィールドは V12 で非推奨となり、今後のリリースで削除される予定です。plannableLocationIds を代わりに使用してください。

AudienceTargeting

リーチ予測のオーディエンス ターゲティング。

JSON 表現
{
  "userInterest": [
    {
      object (UserInterestInfo)
    }
  ]
}
フィールド
userInterest[]

object (UserInterestInfo)

ターゲットに設定するユーザーの興味 / 関心に基づくオーディエンスのリスト。

PlannedProduct

リーチを計画している商品。

JSON 表現
{
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  },
  "plannableProductCode": string,
  "budgetMicros": string
}
フィールド
advancedProductTargeting

object (AdvancedProductTargeting)

選択した商品のターゲティング設定。各商品で利用可能なターゲティングを一覧表示するには、ReachPlanService.ListPlannableProducts を使用します。

plannableProductCode

string

必須。プランニング用に選択したプロダクト。広告プロダクトに関連付けられたコード(TrueView、バンパーなど)。利用可能なプランナブル商品コードを一覧表示するには、ReachPlanService.ListPlannableProducts を使用します。

budgetMicros

string (int64 format)

必須。選択した商品の予算割り当ての上限(マイクロ秒単位)。この値は、選択したプランニングの currencyCode で指定されます。例: 1 000 000$ = 1 000 000 000 000 マイクロ。

AdvancedProductTargeting

商品の詳細なターゲット設定。

JSON 表現
{
  "surfaceTargetingSettings": {
    object (SurfaceTargeting)
  },
  "targetFrequencySettings": {
    object (TargetFrequencySettings)
  },

  // Union field advanced_targeting can be only one of the following:
  "youtubeSelectSettings": {
    object (YouTubeSelectSettings)
  }
  // End of list of possible types for union field advanced_targeting.
}
フィールド
surfaceTargetingSettings

object (SurfaceTargeting)

この商品のターゲット設定を表示します。

targetFrequencySettings

object (TargetFrequencySettings)

フリークエンシー目標キャンペーンの設定。TARGET_FREQUENCY 商品を選択する場合は設定する必要があります。

フリークエンシー目標キャンペーンについて詳しくは、https://support.google.com/google-ads/answer/12400225 をご覧ください。

共用体フィールド advanced_targeting。この商品のターゲティング オプション。advanced_targeting は次のいずれかになります。
youtubeSelectSettings

object (YouTubeSelectSettings)

YouTube Select ターゲティングの設定。

TargetFrequencySettings

サポートされているサービスのフリークエンシー目標設定。

JSON 表現
{
  "timeUnit": enum (TargetFrequencyTimeUnit),
  "targetFrequency": integer
}
フィールド
timeUnit

enum (TargetFrequencyTimeUnit)

必須。targetFrequency の時間枠を記述するために使用される時間単位。

targetFrequency

integer

必須。選択された時間単位あたりのフリークエンシー目標。

YouTubeSelectSettings

YouTube Select Lineups のリクエスト設定

JSON 表現
{
  "lineupId": string
}
フィールド
lineupId

string (int64 format)

YouTube Select ターゲティングの Lineups。

ForecastMetricOptions

返される予測指標を制御します。

JSON 表現
{
  "includeCoview": boolean
}
フィールド
includeCoview

boolean

回答予測に共視聴指標を含めるかどうかを示します。

OnTargetAudienceMetrics

計画されたプロダクトのオーディエンス指標。これらの指標では、次のターゲティング ディメンションが考慮されます。

  • ロケーション
  • PlannableAgeRange
  • ジェンダー
  • AudienceTarget(youtubeAudienceSize のみ)
JSON 表現
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
フィールド
youtubeAudienceSize

string (int64 format)

YouTube で検討されたターゲティングと一致する参照オーディエンスのサイズ。

censusAudienceSize

string (int64 format)

国勢調査で考慮されたターゲティングに一致する参照オーディエンスのサイズ。

ReachCurve

計画された商品のリーチ曲線。

JSON 表現
{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}
フィールド
reachForecasts[]

object (ReachForecast)

リーチ曲線上のすべてのポイントです。

ReachForecast

リーチ曲線上の点。

JSON 表現
{
  "costMicros": string,
  "forecast": {
    object (Forecast)
  },
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ]
}
フィールド
costMicros

string (int64 format)

マイクロ単位の費用。

forecast

object (Forecast)

このポイントの予測トラフィック指標。

plannedProductReachForecasts[]

object (PlannedProductReachForecast)

リーチ曲線上のこの時点における、予定された商品ごとの予測割り当てとトラフィックの指標。

予測

計画された商品とターゲティングの予測トラフィック指標。

JSON 表現
{
  "effectiveFrequencyBreakdowns": [
    {
      object (EffectiveFrequencyBreakdown)
    }
  ],
  "onTargetReach": string,
  "totalReach": string,
  "onTargetImpressions": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string,
  "views": string
}
フィールド
effectiveFrequencyBreakdowns[]

object (EffectiveFrequencyBreakdown)

有効なフリークエンシー予測のリスト。リストは、1+ から始まり、GenerateReachForecastRequest.effective_frequency_limit に設定された値で終わります。enabledFrequencyLimit が設定されていない場合、このリストは空になります。

onTargetReach

string (int64 format)

ターゲティングと完全に一致する GenerateReachForecastRequest.min_effective_frequency または GenerateReachForecastRequest.effective_frequency_limit 回以上リーチしたユニーク ユーザーの数。

なお、データがレポートされるには、ユニーク ユーザー数が一定数に達している必要があります。最小数に達していない場合、onTargetReach の値は 0 に丸められます。

totalReach

string (int64 format)

GenerateReachForecastRequest.min_effective_frequency または GenerateReachForecastRequest.effective_frequency_limit 以上に達したユニーク ユーザーの合計数。指定したターゲティングに含まれないユーザーも対象となります。

なお、データがレポートされるには、ユニーク ユーザー数が一定数に達している必要があります。最小数に達していない場合、totalReach の値は 0 に丸められます。

onTargetImpressions

string (int64 format)

ターゲティングに完全一致する広告インプレッションの数。

totalImpressions

string (int64 format)

広告インプレッションの合計数。これには、ログインしているユーザーに関する情報が不足していることが原因で、指定したターゲティングの範囲外であるインプレッションも含まれます。

viewableImpressions

string (int64 format)

広告のインプレッションが視認可能とみなされた回数。広告の視認性の測定基準と視認性の測定方法について詳しくは、https://support.google.com/google-ads/answer/7029393 をご覧ください。

onTargetCoviewReach

string (int64 format)

ターゲティングと完全に一致するリーチしたユニーク ユーザー(共視聴者を含む)の数。

totalCoviewReach

string (int64 format)

リーチしたユニーク ユーザーの数(共視聴者を含む)。指定したターゲティングに含まれないユーザーも対象となります。

onTargetCoviewImpressions

string (int64 format)

ターゲティングと完全に一致する広告インプレッションの数(共視聴者を含む)。

totalCoviewImpressions

string (int64 format)

共視聴者を含む広告インプレッションの合計数。これには、ログインしているユーザーに関する情報が不足していることが原因で、指定したターゲティングの範囲外であるインプレッションも含まれます。

views

string (int64 format)

指定した商品とターゲティングで予測される広告視聴回数です。インプレッションは、視聴者が広告の大部分または全部を視聴した場合にカウントされます。

ビューについて詳しくは、https://support.google.com/google-ads/answer/2375431 をご覧ください。

EffectiveFrequencyBreakdown

特定の有効フリークエンシーでリーチしたユニーク ユーザー数の内訳。

JSON 表現
{
  "effectiveFrequency": integer,
  "onTargetReach": string,
  "totalReach": string,
  "effectiveCoviewReach": string,
  "onTargetEffectiveCoviewReach": string
}
フィールド
effectiveFrequency

integer

有効頻度(1 ~ 10)。

onTargetReach

string (int64 format)

ターゲティングに完全一致する eCPM の回数以上リーチしたユニーク ユーザーの数。

なお、データがレポートされるには、ユニーク ユーザー数が一定数に達している必要があります。最小数に達していない場合、onTargetReach の値は 0 に丸められます。

totalReach

string (int64 format)

少なくとも EffectiveFrequency 回以上リーチしたユニーク ユーザーの合計数。指定したターゲティングに含まれないユーザーも対象となります。

なお、データがレポートされるには、ユニーク ユーザー数が一定数に達している必要があります。最小数に達していない場合、totalReach の値は 0 に丸められます。

effectiveCoviewReach

string (int64 format)

関連付けられた validFrequency の値でリーチしたユーザー数(共視聴ユーザーを含む)。

onTargetEffectiveCoviewReach

string (int64 format)

指定したプランのユーザー属性内で、関連する EffectiveFrequency の値でリーチしたユーザー数(共視聴ユーザーを含む)。

PlannedProductReachForecast

リーチ曲線上のポイントにおける、特定商品の予測割り当てとトラフィックの指標。

JSON 表現
{
  "plannableProductCode": string,
  "costMicros": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
フィールド
plannableProductCode

string

プランニング用に選択したプロダクト。同じ地域 ID を使用している場合、返される商品コードは ListPlannableProducts から返される商品コードのセット内にあります。

costMicros

string (int64 format)

マイクロ単位の費用。在庫が限られているために予算を充足できない予定商品がある場合、これは商品の入力割り当てとは異なることがあります。

plannedProductForecast

object (PlannedProductForecast)

この商品について予測されるトラフィック指標。

PlannedProductForecast

計画されたプロダクトの予測トラフィック指標。

JSON 表現
{
  "onTargetReach": string,
  "totalReach": string,
  "onTargetImpressions": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string,
  "averageFrequency": number,
  "views": string
}
フィールド
onTargetReach

string (int64 format)

ターゲティングと完全に一致するリーチしたユニーク ユーザーの数。

なお、データがレポートされるには、ユニーク ユーザー数が一定数に達している必要があります。最小数に達していない場合、onTargetReach の値は 0 に丸められます。

totalReach

string (int64 format)

リーチしたユニーク ユーザーの数。指定したターゲティングに含まれないユーザーも対象となります。

なお、データがレポートされるには、ユニーク ユーザー数が一定数に達している必要があります。最小数に達していない場合、totalReach の値は 0 に丸められます。

onTargetImpressions

string (int64 format)

ターゲティングに完全一致する広告インプレッションの数。

totalImpressions

string (int64 format)

広告インプレッションの合計数。これには、ログインしているユーザーに関する情報が不足していることが原因で、指定したターゲティングの範囲外であるインプレッションも含まれます。

viewableImpressions

string (int64 format)

広告のインプレッションが視認可能とみなされた回数。広告の視認性の測定基準と視認性の測定方法について詳しくは、https://support.google.com/google-ads/answer/7029393 をご覧ください。

onTargetCoviewReach

string (int64 format)

ターゲティングと完全に一致するリーチしたユニーク ユーザー(共視聴者を含む)の数。

totalCoviewReach

string (int64 format)

リーチしたユニーク ユーザーの数(共視聴者を含む)。指定したターゲティングに含まれないユーザーも対象となります。

onTargetCoviewImpressions

string (int64 format)

ターゲティングと完全に一致する広告インプレッションの数(共視聴者を含む)。

totalCoviewImpressions

string (int64 format)

共視聴者を含む広告インプレッションの合計数。これには、ログインしているユーザーに関する情報が不足していることが原因で、指定したターゲティングの範囲外であるインプレッションも含まれます。

averageFrequency

number

選択した時間単位ごとにユーザーに広告が表示される回数で、予測の長さの時間単位数で平均化されます。このフィールドの値は、フリークエンシー目標キャンペーンの場合のみ入力されます。

フリークエンシー目標キャンペーンについて詳しくは、https://support.google.com/google-ads/answer/12400225 をご覧ください。

views

string (int64 format)

指定した商品とターゲティングで予測される広告視聴回数です。インプレッションは、視聴者が広告の大部分または全部を視聴した場合にカウントされます。

ビューについて詳しくは、https://support.google.com/google-ads/answer/2375431 をご覧ください。