Looking for a REST API? The Ad Manager API (Beta) is now available.

type Goal (v202308)

Service

ForecastService LineItemService ProposalLineItemService

Dependencies

LineItemSummary ProposalLineItem

▼

Goal

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

Namespace: https://www.google.com/apis/ads/publisher/v202308

Field
`goalType`	`GoalType` The type of the goal for the `LineItem`. It defines the period over which the goal for `LineItem` should be reached. Enumerations `NONE` No goal is specified for the number of ads delivered. The LineItem.lineItemType must be one of: LineItemType.PRICE_PRIORITY LineItemType.AD_EXCHANGE LineItemType.CLICK_TRACKING `LIFETIME` There is a goal on the number of ads delivered for this line item during its entire lifetime. The LineItem.lineItemType must be one of: LineItemType.STANDARD LineItemType.BULK LineItemType.PRICE_PRIORITY LineItemType.ADSENSE LineItemType.AD_EXCHANGE LineItemType.ADMOB LineItemType.CLICK_TRACKING `DAILY` There is a daily goal on the number of ads delivered for this line item. The LineItem.lineItemType must be one of: LineItemType.SPONSORSHIP LineItemType.NETWORK LineItemType.PRICE_PRIORITY LineItemType.HOUSE LineItemType.ADSENSE LineItemType.AD_EXCHANGE LineItemType.ADMOB LineItemType.BUMPER `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.
`unitType`	`UnitType` The type of the goal unit for the `LineItem`. Enumerations `IMPRESSIONS` The number of impressions served by creatives associated with the line item. Line items of all LineItemType support this `UnitType`. `CLICKS` The number of clicks reported by creatives associated with the line item. The LineItem.lineItemType must be LineItemType.STANDARD, LineItemType.BULK or LineItemType.PRICE_PRIORITY. `CLICK_THROUGH_CPA_CONVERSIONS` The number of click-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.costType must be CostType.CPA. `VIEW_THROUGH_CPA_CONVERSIONS` The number of view-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.costType must be CostType.CPA. `TOTAL_CPA_CONVERSIONS` The number of total Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.costType must be CostType.CPA. `VIEWABLE_IMPRESSIONS` The number of viewable impressions reported by creatives associated with the line item. The LineItem.lineItemType must be LineItemType.STANDARD. `IN_TARGET_IMPRESSIONS` The number of in-target impressions reported by third party measurements. The LineItem.lineItemType must be LineItemType.STANDARD. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.
`units`	`xsd:long` If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the `LineItem`. If the line item is of type LineItemType.SPONSORSHIP, it represents the percentage of available impressions reserved. If the line item is of type LineItemType.BULK or LineItemType.PRICE_PRIORITY, it represents the number of remaining impressions reserved. If the line item is of type LineItemType.NETWORK or LineItemType.HOUSE, it represents the percentage of remaining impressions reserved. If this is a secondary 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.secondaryGoals.

Field

`goalType`

GoalType

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

Enumerations

NONE

No goal is specified for the number of ads delivered. The LineItem.lineItemType must be one of:

LIFETIME

There is a goal on the number of ads delivered for this line item during its entire lifetime. The LineItem.lineItemType must be one of:

DAILY

There is a daily goal on the number of ads delivered for this line item. The LineItem.lineItemType must be one of:

UNKNOWN

The value returned if the actual value is not exposed by the requested API version.

`unitType`

UnitType

The type of the goal unit for the LineItem.

Enumerations

IMPRESSIONS: The number of impressions served by creatives associated with the line item. Line items of all LineItemType support this UnitType.
CLICKS: The number of clicks reported by creatives associated with the line item. The LineItem.lineItemType must be LineItemType.STANDARD, LineItemType.BULK or LineItemType.PRICE_PRIORITY.
CLICK_THROUGH_CPA_CONVERSIONS: The number of click-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.costType must be CostType.CPA.
VIEW_THROUGH_CPA_CONVERSIONS: The number of view-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.costType must be CostType.CPA.
TOTAL_CPA_CONVERSIONS: The number of total Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.costType must be CostType.CPA.
VIEWABLE_IMPRESSIONS: The number of viewable impressions reported by creatives associated with the line item. The LineItem.lineItemType must be LineItemType.STANDARD.
IN_TARGET_IMPRESSIONS: The number of in-target impressions reported by third party measurements. The LineItem.lineItemType must be LineItemType.STANDARD.
UNKNOWN: The value returned if the actual value is not exposed by the requested API version.

`units`

xsd:long

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

If this is a secondary 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.secondaryGoals.