Class GoogleAdsSearchads360V23ServicesGenerateReachForecastRequest

Request message for ReachPlanService.GenerateReachForecast.

Inheritance
object
GoogleAdsSearchads360V23ServicesGenerateReachForecastRequest
Implements
Inherited Members
Namespace: Google.Apis.SA360.v23.Data
Assembly: Google.Apis.SA360.v23.dll
Syntax
public class GoogleAdsSearchads360V23ServicesGenerateReachForecastRequest : IDirectResponseSchema

Properties

CampaignDuration

Required. Campaign duration.

Declaration
[JsonProperty("campaignDuration")]
public virtual GoogleAdsSearchads360V23ServicesCampaignDuration CampaignDuration { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ServicesCampaignDuration

CookieFrequencyCap

Chosen cookie frequency cap to be applied to each planned product. This is equivalent to the frequency cap exposed in Google Ads when creating a campaign, it represents the maximum number of times an ad can be shown to the same user. If not specified, no cap is applied. This field is deprecated in v4 and will eventually be removed. Use cookie_frequency_cap_setting instead.

Declaration
[JsonProperty("cookieFrequencyCap")]
public virtual int? CookieFrequencyCap { get; set; }
Property Value
Type Description
int?

CookieFrequencyCapSetting

Chosen cookie frequency cap to be applied to each planned product. This is equivalent to the frequency cap exposed in Google Ads when creating a campaign, it represents the maximum number of times an ad can be shown to the same user during a specified time interval. If not specified, a default of 0 (no cap) is applied. This field replaces the deprecated cookie_frequency_cap field.

Declaration
[JsonProperty("cookieFrequencyCapSetting")]
public virtual GoogleAdsSearchads360V23ServicesFrequencyCap CookieFrequencyCapSetting { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ServicesFrequencyCap

CurrencyCode

The currency code. Three-character ISO 4217 currency code.

Declaration
[JsonProperty("currencyCode")]
public virtual string CurrencyCode { get; set; }
Property Value
Type Description
string

CustomerReachGroup

The name of the customer being planned for. This is a user-defined value.

Declaration
[JsonProperty("customerReachGroup")]
public virtual string CustomerReachGroup { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EffectiveFrequencyLimit

The highest minimum effective frequency (the number of times a person was exposed to the ad) value [1-10] to include in Forecast.effective_frequency_breakdowns. If not specified, Forecast.effective_frequency_breakdowns will not be provided. The effective frequency value provided here will also be used as the minimum effective frequency for the reported reach metrics. This field cannot be combined with the min_effective_frequency field.

Declaration
[JsonProperty("effectiveFrequencyLimit")]
public virtual GoogleAdsSearchads360V23ServicesEffectiveFrequencyLimit EffectiveFrequencyLimit { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ServicesEffectiveFrequencyLimit

ForecastMetricOptions

Controls the forecast metrics returned in the response.

Declaration
[JsonProperty("forecastMetricOptions")]
public virtual GoogleAdsSearchads360V23ServicesForecastMetricOptions ForecastMetricOptions { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ServicesForecastMetricOptions

MinEffectiveFrequency

Chosen minimum effective frequency (the number of times a person was exposed to the ad) for the reported reach metrics [1-10]. This won't affect the targeting, but just the reporting. If not specified, a default of 1 is applied. This field cannot be combined with the effective_frequency_limit field.

Declaration
[JsonProperty("minEffectiveFrequency")]
public virtual int? MinEffectiveFrequency { get; set; }
Property Value
Type Description
int?

PlannedProducts

Required. The products to be forecast. The max number of allowed planned products is 15.

Declaration
[JsonProperty("plannedProducts")]
public virtual IList<GoogleAdsSearchads360V23ServicesPlannedProduct> PlannedProducts { get; set; }
Property Value
Type Description
IList<GoogleAdsSearchads360V23ServicesPlannedProduct>

ReachApplicationInfo

Optional. Additional information on the application issuing the request.

Declaration
[JsonProperty("reachApplicationInfo")]
public virtual GoogleAdsSearchads360V23CommonAdditionalApplicationInfo ReachApplicationInfo { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23CommonAdditionalApplicationInfo

Targeting

The targeting to be applied to all products selected in the product mix. This is planned targeting: execution details might vary based on the advertising product, consult an implementation specialist. See specific metrics for details on how targeting affects them.

Declaration
[JsonProperty("targeting")]
public virtual GoogleAdsSearchads360V23ServicesTargeting Targeting { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ServicesTargeting

Implements