Reference documentation and code samples for the Google Ads Ad Manager V1 Client class CustomPacingGoal.
An interval of a CustomPacingCurve. A custom pacing goal contains a start time and an amount. The goal will apply until either the next custom pacing goal's getStartTime or the line item's end time if it is the last goal.
Generated from protobuf message google.ads.admanager.v1.CustomPacingGoal
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ start_time |
Google\Protobuf\Timestamp
Optional. The start date and time of the goal. This field is required unless use_line_item_start_time is true. |
↳ use_line_item_start_time |
bool
Optional. Input only. Whether the [LineItem.start_time] should be used for the start date and time of this goal. This field is not persisted and if it is set to true, the [start_time] field will be populated by the line item's start time. |
↳ amount |
int|string
Optional. The amount associated with the goal. This field is required. |
getStartTime
Optional. The start date and time of the goal. This field is required unless use_line_item_start_time is true.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Optional. The start date and time of the goal. This field is required unless use_line_item_start_time is true.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUseLineItemStartTime
Optional. Input only. Whether the [LineItem.start_time] should be used for the start date and time of this goal. This field is not persisted and if it is set to true, the [start_time] field will be populated by the line item's start time.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasUseLineItemStartTime
clearUseLineItemStartTime
setUseLineItemStartTime
Optional. Input only. Whether the [LineItem.start_time] should be used for the start date and time of this goal. This field is not persisted and if it is set to true, the [start_time] field will be populated by the line item's start time.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAmount
Optional. The amount associated with the goal. This field is required.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasAmount
clearAmount
setAmount
Optional. The amount associated with the goal. This field is required.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|