Google Ads Ad Manager V1 Client - Class ForecastBreakdownOptions (0.15.0)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class ForecastBreakdownOptions.

Configuration of forecast breakdown.

Generated from protobuf message google.ads.admanager.v1.ForecastBreakdownOptions

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ time_windows array<Google\Protobuf\Timestamp>

Optional. The boundaries of time windows to configure time breakdown. By default, the time window of the forecasted LineItem is assumed if none are explicitly specified in this field. But if set, at least two DateTimes are needed to define the boundaries of minimally one time window. Also, the time boundaries are required to be in the same time zone, in strictly ascending order.

↳ targets array<ForecastBreakdownTarget>

Optional. For each time window, these are the breakdown targets. If none specified, the targeting of the forecasted LineItem is assumed.

getTimeWindows

Optional. The boundaries of time windows to configure time breakdown.

By default, the time window of the forecasted LineItem is assumed if none are explicitly specified in this field. But if set, at least two DateTimes are needed to define the boundaries of minimally one time window. Also, the time boundaries are required to be in the same time zone, in strictly ascending order.

Returns
Type Description
Google\Protobuf\RepeatedField<Google\Protobuf\Timestamp>

setTimeWindows

Optional. The boundaries of time windows to configure time breakdown.

By default, the time window of the forecasted LineItem is assumed if none are explicitly specified in this field. But if set, at least two DateTimes are needed to define the boundaries of minimally one time window. Also, the time boundaries are required to be in the same time zone, in strictly ascending order.

Parameter
Name Description
var array<Google\Protobuf\Timestamp>
Returns
Type Description
$this

getTargets

Optional. For each time window, these are the breakdown targets. If none specified, the targeting of the forecasted LineItem is assumed.

Returns
Type Description
Google\Protobuf\RepeatedField<ForecastBreakdownTarget>

setTargets

Optional. For each time window, these are the breakdown targets. If none specified, the targeting of the forecasted LineItem is assumed.

Parameter
Name Description
var array<ForecastBreakdownTarget>
Returns
Type Description
$this