Method: customers.generateReachForecast

string

Required. The ID of the customer.

{
  "dateRange": {
    object (DateRange)
  },
  "durationInDays": integer
}

object (DateRange)

Date range of the campaign. Dates are in the yyyy-mm-dd format and inclusive. The end date must be < 1 year in the future and the date range must be <= 92 days long.

This field cannot be combined with the durationInDays field.

integer

The duration value in days.

This field cannot be combined with the dateRange field.

{
  "impressions": integer,
  "timeUnit": enum (FrequencyCapTimeUnit)
}

integer

Required. The number of impressions, inclusive.

enum (FrequencyCapTimeUnit)

Required. The type of time unit.

{
  "effectiveFrequencyBreakdownLimit": integer
}

integer

The highest effective frequency value to include in Forecast.effective_frequency_breakdowns. This field supports frequencies 1-10, inclusive.

{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (ReachPlanAgeRange),
  "genders": [
    {
      object (GenderInfo)
    }
  ],
  "devices": [
    {
      object (DeviceInfo)
    }
  ],
  "network": enum (ReachPlanNetwork),
  "audienceTargeting": {
    object (AudienceTargeting)
  },
  "plannableLocationId": string
}

string

The list of plannable location IDs to target with this forecast.

If more than one ID is provided, all IDs must have the same parentCountryId. Planning for more than parent_county is not supported. Plannable location IDs and their parentCountryId can be obtained from ReachPlanService.ListPlannableLocations.

Requests must set either this field or plannableLocationId.

enum (ReachPlanAgeRange)

Targeted age range. An unset value is equivalent to targeting all ages.

object (GenderInfo)

Targeted genders. An unset value is equivalent to targeting MALE and FEMALE.

object (DeviceInfo)

Targeted devices. If not specified, targets all applicable devices. Applicable devices vary by product and region and can be obtained from ReachPlanService.ListPlannableProducts.

enum (ReachPlanNetwork)

Targetable network for the ad product. If not specified, targets all applicable networks. Applicable networks vary by product and region and can be obtained from ReachPlanService.ListPlannableProducts.

object (AudienceTargeting)

Targeted audiences. If not specified, does not target any specific audience.

string

The ID of the selected location. Plannable location IDs can be obtained from ReachPlanService.ListPlannableLocations.

Requests must set either this field or plannableLocationIds.

This field is deprecated as of V12 and will be removed in a future release. Use plannableLocationIds instead.

{
  "userInterest": [
    {
      object (UserInterestInfo)
    }
  ]
}

object (UserInterestInfo)

List of audiences based on user interests to be targeted.

{
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  },
  "plannableProductCode": string,
  "budgetMicros": string
}

object (AdvancedProductTargeting)

Targeting settings for the selected product. To list the available targeting for each product use ReachPlanService.ListPlannableProducts.

string

Required. Selected product for planning. The code associated with the ad product (for example: Trueview, Bumper). To list the available plannable product codes use ReachPlanService.ListPlannableProducts.

string (int64 format)

Required. Maximum budget allocation in micros for the selected product. The value is specified in the selected planning currencyCode. For example: 1 000 000$ = 1 000 000 000 000 micros.

{

  // 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.
}

object (YouTubeSelectSettings)

Settings for YouTube Select targeting.

{
  "lineupId": string
}

string (int64 format)

Lineup for YouTube Select Targeting.

{
  "includeCoview": boolean
}

boolean

Indicates whether to include co-view metrics in the response forecast.

{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}

string (int64 format)

Reference audience size matching the considered targeting for YouTube.

string (int64 format)

Reference audience size matching the considered targeting for Census.

{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}

object (ReachForecast)

All points on the reach curve.

{
  "costMicros": string,
  "forecast": {
    object (Forecast)
  },
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ]
}

string (int64 format)

The cost in micros.

object (Forecast)

Forecasted traffic metrics for this point.

object (PlannedProductReachForecast)

The forecasted allocation and traffic metrics for each planned product at this point on the reach curve.

{
  "effectiveFrequencyBreakdowns": [
    {
      object (EffectiveFrequencyBreakdown)
    }
  ],
  "onTargetReach": string,
  "totalReach": string,
  "onTargetImpressions": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}

object (EffectiveFrequencyBreakdown)

A list of effective frequency forecasts. The list is ordered starting with 1+ and ending with the value set in GenerateReachForecastRequest.effective_frequency_limit. If no effectiveFrequencyLimit was set, this list will be empty.

string (int64 format)

Number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency or GenerateReachForecastRequest.effective_frequency_limit times that exactly matches the Targeting.

Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the onTargetReach value will be rounded to 0.

string (int64 format)

Total number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency or GenerateReachForecastRequest.effective_frequency_limit times. This includes people that may fall outside the specified Targeting.

Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the totalReach value will be rounded to 0.

string (int64 format)

Number of ad impressions that exactly matches the Targeting.

string (int64 format)

Total number of ad impressions. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users.

string (int64 format)

Number of times the ad's impressions were considered viewable. See https://support.google.com/google-ads/answer/7029393 for more information about what makes an ad viewable and how viewability is measured.

string (int64 format)

Number of unique people reached that exactly matches the Targeting including co-viewers.

string (int64 format)

Number of unique people reached including co-viewers. This includes people that may fall outside the specified Targeting.

string (int64 format)

Number of ad impressions that exactly matches the Targeting including co-viewers.

string (int64 format)

Total number of ad impressions including co-viewers. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users.

{
  "effectiveFrequency": integer,
  "onTargetReach": string,
  "totalReach": string,
  "effectiveCoviewReach": string,
  "onTargetEffectiveCoviewReach": string
}

integer

The effective frequency [1-10].

string (int64 format)

The number of unique people reached at least effectiveFrequency times that exactly matches the Targeting.

Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the onTargetReach value will be rounded to 0.

string (int64 format)

Total number of unique people reached at least effectiveFrequency times. This includes people that may fall outside the specified Targeting.

Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the totalReach value will be rounded to 0.

string (int64 format)

The number of users (including co-viewing users) reached for the associated effectiveFrequency value.

string (int64 format)

The number of users (including co-viewing users) reached for the associated effectiveFrequency value within the specified plan demographic.

{
  "plannableProductCode": string,
  "costMicros": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}

string

Selected product for planning. The product codes returned are within the set of the ones returned by ListPlannableProducts when using the same location ID.

string (int64 format)

The cost in micros. This may differ from the product's input allocation if one or more planned products cannot fulfill the budget because of limited inventory.

object (PlannedProductForecast)

Forecasted traffic metrics for this product.

{
  "onTargetReach": string,
  "totalReach": string,
  "onTargetImpressions": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}

string (int64 format)

Number of unique people reached that exactly matches the Targeting.

Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the onTargetReach value will be rounded to 0.

string (int64 format)

Number of unique people reached. This includes people that may fall outside the specified Targeting.

Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the totalReach value will be rounded to 0.

string (int64 format)

Number of ad impressions that exactly matches the Targeting.

string (int64 format)

Total number of ad impressions. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users.

string (int64 format)

Number of times the ad's impressions were considered viewable. See https://support.google.com/google-ads/answer/7029393 for more information about what makes an ad viewable and how viewability is measured.

string (int64 format)

Number of unique people reached that exactly matches the Targeting including co-viewers.

string (int64 format)

Number of unique people reached including co-viewers. This includes people that may fall outside the specified Targeting.

string (int64 format)

Number of ad impressions that exactly matches the Targeting including co-viewers.

string (int64 format)

Total number of ad impressions including co-viewers. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users.