Reference documentation and code samples for the Google Ads Ad Manager V1 Client class Schedule.
The schedule for the report
Generated from protobuf message google.ads.admanager.v1.Schedule
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ weekly_schedule |
Schedule\WeeklySchedule
Days of week to schedule report run. |
↳ monthly_schedule |
Schedule\MonthlySchedule
Days of month to schedule report run. |
↳ start_date |
Google\Type\Date
Date for the first run of the report. |
↳ end_date |
Google\Type\Date
Date for the final run of the report. |
↳ frequency |
int
Frequency to run report. |
↳ start_time |
Google\Type\TimeOfDay
Indicates start time for schedule to run Will use the time_zone from |
getWeeklySchedule
Days of week to schedule report run.
| Returns | |
|---|---|
| Type | Description |
Schedule\WeeklySchedule|null |
|
hasWeeklySchedule
setWeeklySchedule
Days of week to schedule report run.
| Parameter | |
|---|---|
| Name | Description |
var |
Schedule\WeeklySchedule
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMonthlySchedule
Days of month to schedule report run.
| Returns | |
|---|---|
| Type | Description |
Schedule\MonthlySchedule|null |
|
hasMonthlySchedule
setMonthlySchedule
Days of month to schedule report run.
| Parameter | |
|---|---|
| Name | Description |
var |
Schedule\MonthlySchedule
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartDate
Date for the first run of the report.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Date|null |
|
hasStartDate
clearStartDate
setStartDate
Date for the first run of the report.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Date
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndDate
Date for the final run of the report.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Date|null |
|
hasEndDate
clearEndDate
setEndDate
Date for the final run of the report.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Date
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFrequency
Frequency to run report.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Frequency. |
setFrequency
Frequency to run report.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Frequency. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Indicates start time for schedule to run
Will use the time_zone from ReportDefinition. Defaults
to the publisher's time zone if not specified.
For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.
| Returns | |
|---|---|
| Type | Description |
Google\Type\TimeOfDay|null |
|
hasStartTime
clearStartTime
setStartTime
Indicates start time for schedule to run
Will use the time_zone from ReportDefinition. Defaults
to the publisher's time zone if not specified.
For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\TimeOfDay
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFrequencySchedule
| Returns | |
|---|---|
| Type | Description |
string |
|