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

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

Response object for RunTrafficData method.

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

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ historical_time_series TimeSeries

Time series of historical traffic ad opportunity counts. This may be null if the requested date range did not contain any historical dates, or if no historical data are available for the requested traffic segment.

↳ forecasted_time_series TimeSeries

Time series of forecasted traffic ad opportunity counts. This may be null if the requested date range did not contain any future dates, or if no forecasted data are available for the requested traffic segment.

↳ forecasted_assigned_time_series TimeSeries

Time series of future traffic volumes forecasted to be sold. This may be null if the requested date range did not contain any future dates, or if no sell-through data are available for the requested traffic segment.

↳ overall_date_range DateRange

The overall date range spanned by the union of all time series in the response. This is a summary field for convenience. The value will be set such that the start date is equal to the earliest start date of all time series included, and the end date is equal to the latest end date of all time series included. If all time series fields are null, this field will also be null.

getHistoricalTimeSeries

Time series of historical traffic ad opportunity counts.

This may be null if the requested date range did not contain any historical dates, or if no historical data are available for the requested traffic segment.

Returns
Type Description
TimeSeries|null

hasHistoricalTimeSeries

clearHistoricalTimeSeries

setHistoricalTimeSeries

Time series of historical traffic ad opportunity counts.

This may be null if the requested date range did not contain any historical dates, or if no historical data are available for the requested traffic segment.

Parameter
Name Description
var TimeSeries
Returns
Type Description
$this

getForecastedTimeSeries

Time series of forecasted traffic ad opportunity counts.

This may be null if the requested date range did not contain any future dates, or if no forecasted data are available for the requested traffic segment.

Returns
Type Description
TimeSeries|null

hasForecastedTimeSeries

clearForecastedTimeSeries

setForecastedTimeSeries

Time series of forecasted traffic ad opportunity counts.

This may be null if the requested date range did not contain any future dates, or if no forecasted data are available for the requested traffic segment.

Parameter
Name Description
var TimeSeries
Returns
Type Description
$this

getForecastedAssignedTimeSeries

Time series of future traffic volumes forecasted to be sold.

This may be null if the requested date range did not contain any future dates, or if no sell-through data are available for the requested traffic segment.

Returns
Type Description
TimeSeries|null

hasForecastedAssignedTimeSeries

clearForecastedAssignedTimeSeries

setForecastedAssignedTimeSeries

Time series of future traffic volumes forecasted to be sold.

This may be null if the requested date range did not contain any future dates, or if no sell-through data are available for the requested traffic segment.

Parameter
Name Description
var TimeSeries
Returns
Type Description
$this

getOverallDateRange

The overall date range spanned by the union of all time series in the response.

This is a summary field for convenience. The value will be set such that the start date is equal to the earliest start date of all time series included, and the end date is equal to the latest end date of all time series included. If all time series fields are null, this field will also be null.

Returns
Type Description
DateRange|null

hasOverallDateRange

clearOverallDateRange

setOverallDateRange

The overall date range spanned by the union of all time series in the response.

This is a summary field for convenience. The value will be set such that the start date is equal to the earliest start date of all time series included, and the end date is equal to the latest end date of all time series included. If all time series fields are null, this field will also be null.

Parameter
Name Description
var DateRange
Returns
Type Description
$this