Google Ads Ad Manager V1 Client - Class GrpSettings (0.14.1)

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

GrpSettings contains information for a line item that will have a target demographic when serving. This information will be used to set up tracking and enable reporting on the demographic information.

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

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ min_target_age int|string

Optional. Specifies the minimum target age (in years) of the LineItem. This field is only applicable if provider is not null.
↳ max_target_age int|string

Optional. Specifies the maximum target age (in years) of the LineItem. This field is only applicable if provider is not null.
↳ target_gender int

Optional. Specifies the target gender of the LineItem. This field is only applicable if provider is not null.
↳ provider int

Optional. Specifies the GRP provider of the LineItem.
↳ in_target_ratio_estimate_milli_percent int|string

Optional. Estimate for the in-target ratio given the line item's audience targeting. This field is only applicable if provider is Nielsen, LineItem.primary_goal.unit_type is in-target impressions, and [LineItemCostType] is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.
↳ nielsen_ctv_pacing_type int

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.
↳ pacing_device_categorization_type int

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.
↳ apply_true_coview bool

Optional. Specifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if nielsen_ctv_pacing_type is not NONE.

getMinTargetAge

Optional. Specifies the minimum target age (in years) of the LineItem. This field is only applicable if provider is not null.

Returns
Type Description
int|string

hasMinTargetAge

clearMinTargetAge

setMinTargetAge

Optional. Specifies the minimum target age (in years) of the LineItem. This field is only applicable if provider is not null.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getMaxTargetAge

Optional. Specifies the maximum target age (in years) of the LineItem. This field is only applicable if provider is not null.

Returns
Type Description
int|string

hasMaxTargetAge

clearMaxTargetAge

setMaxTargetAge

Optional. Specifies the maximum target age (in years) of the LineItem. This field is only applicable if provider is not null.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTargetGender

Optional. Specifies the target gender of the LineItem. This field is only applicable if provider is not null.

Returns
Type Description
int

hasTargetGender

clearTargetGender

setTargetGender

Optional. Specifies the target gender of the LineItem. This field is only applicable if provider is not null.

Parameter
Name Description
var int
Returns
Type Description
$this

getProvider

Optional. Specifies the GRP provider of the LineItem.

Returns
Type Description
int

hasProvider

clearProvider

setProvider

Optional. Specifies the GRP provider of the LineItem.

Parameter
Name Description
var int
Returns
Type Description
$this

getInTargetRatioEstimateMilliPercent

Optional. Estimate for the in-target ratio given the line item's audience targeting. This field is only applicable if provider is Nielsen, LineItem.primary_goal.unit_type is in-target impressions, and [LineItemCostType] is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.

Returns
Type Description
int|string

hasInTargetRatioEstimateMilliPercent

clearInTargetRatioEstimateMilliPercent

setInTargetRatioEstimateMilliPercent

Optional. Estimate for the in-target ratio given the line item's audience targeting. This field is only applicable if provider is Nielsen, LineItem.primary_goal.unit_type is in-target impressions, and [LineItemCostType] is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getNielsenCtvPacingType

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.

Returns
Type Description
int

hasNielsenCtvPacingType

clearNielsenCtvPacingType

setNielsenCtvPacingType

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.

Parameter
Name Description
var int
Returns
Type Description
$this

getPacingDeviceCategorizationType

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.

Returns
Type Description
int

hasPacingDeviceCategorizationType

clearPacingDeviceCategorizationType

setPacingDeviceCategorizationType

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.

Parameter
Name Description
var int
Returns
Type Description
$this

getApplyTrueCoview

Optional. Specifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if nielsen_ctv_pacing_type is not NONE.

Returns
Type Description
bool

hasApplyTrueCoview

clearApplyTrueCoview

setApplyTrueCoview

Optional. Specifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if nielsen_ctv_pacing_type is not NONE.

Parameter
Name Description
var bool
Returns
Type Description
$this