Google Ads Ad Manager V1 Client - Class Goal (0.6.0)

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

Defines the criteria a LineItem needs to satisfy to meet its delivery goal.

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

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ goal_type
int

The type of the goal for the LineItem. It defines the period over which the goal should be reached.

↳ unit_type
int

The type of the goal unit for the LineItem.

↳ units
int|string

If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved. If the line item is of type LineItemTypeEnum.LineItemType.SPONSORSHIP , it represents the percentage of available impressions reserved. If the line item is of type LineItemTypeEnum.LineItemType.BULK or LineItemTypeEnum.LineItemType.PRICE_PRIORITY , it represents the number of remaining impressions reserved. If the line item is of type LineItemTypeEnum.LineItemType.NETWORK or LineItemTypeEnum.LineItemType.HOUSE , it represents the percentage of remaining impressions reserved.

If this is an impression cap goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see LineItem.impressions_cap .

getGoalType

The type of the goal for the LineItem. It defines the period over which the goal should be reached.

Returns
Type
Description
int

hasGoalType

clearGoalType

setGoalType

The type of the goal for the LineItem. It defines the period over which the goal should be reached.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getUnitType

The type of the goal unit for the LineItem.

Returns
Type
Description
int

hasUnitType

clearUnitType

setUnitType

The type of the goal unit for the LineItem.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getUnits

If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved. If the line item is of type LineItemTypeEnum.LineItemType.SPONSORSHIP , it represents the percentage of available impressions reserved. If the line item is of type LineItemTypeEnum.LineItemType.BULK or LineItemTypeEnum.LineItemType.PRICE_PRIORITY , it represents the number of remaining impressions reserved. If the line item is of type LineItemTypeEnum.LineItemType.NETWORK or LineItemTypeEnum.LineItemType.HOUSE , it represents the percentage of remaining impressions reserved.

If this is an impression cap goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see LineItem.impressions_cap .

Returns
Type
Description
int|string

hasUnits

clearUnits

setUnits

If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved. If the line item is of type LineItemTypeEnum.LineItemType.SPONSORSHIP , it represents the percentage of available impressions reserved. If the line item is of type LineItemTypeEnum.LineItemType.BULK or LineItemTypeEnum.LineItemType.PRICE_PRIORITY , it represents the number of remaining impressions reserved. If the line item is of type LineItemTypeEnum.LineItemType.NETWORK or LineItemTypeEnum.LineItemType.HOUSE , it represents the percentage of remaining impressions reserved.

If this is an impression cap goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see LineItem.impressions_cap .

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: