Show / Hide Table of Contents

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
object
Report.ScheduleData
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dfareporting.v3_5.Data
Assembly: Google.Apis.Dfareporting.v3_5.dll
Syntax
public class Report.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
bool?

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
int?

ExpirationDate

Declaration
[JsonProperty("expirationDate")]
public virtual string ExpirationDate { get; set; }
Property Value
Type Description
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
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<T><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
string

StartDate

Declaration
[JsonProperty("startDate")]
public virtual string StartDate { get; set; }
Property Value
Type Description
string

Timezone

The timezone when the report will run.

Declaration
[JsonProperty("timezone")]
public virtual string Timezone { get; set; }
Property Value
Type Description
string
In This Article
Back to top Generated by DocFX