Class Report.ScheduleData
The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
Inheritance
Inherited Members
Namespace: Google.Apis.Dfareporting.v3_2.Data
Assembly: Google.Apis.Dfareporting.v3_2.dll
Syntax
public class ScheduleData
Properties
Active
Whether the schedule is active or not. Must be set to either true or false.
Declaration
[JsonProperty("active")]
public virtual bool? Active { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
Every
Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
Declaration
[JsonProperty("every")]
public virtual int? Every { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
ExpirationDate
The expiration date when the scheduled report stops running.
Declaration
[JsonProperty("expirationDate")]
public virtual string ExpirationDate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Repeats
The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
Declaration
[JsonProperty("repeats")]
public virtual string Repeats { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
RepeatsOnWeekDays
List of week days "WEEKLY" on which scheduled reports should run.
Declaration
[JsonProperty("repeatsOnWeekDays")]
public virtual IList<string> RepeatsOnWeekDays { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
RunsOnDayOfMonth
Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
Declaration
[JsonProperty("runsOnDayOfMonth")]
public virtual string RunsOnDayOfMonth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
StartDate
Start date of date range for which scheduled reports should be run.
Declaration
[JsonProperty("startDate")]
public virtual string StartDate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |