AdsApp.​ExtensionSchedule

  • ExtensionSchedule represents a single time period within a Google Ads ad extension's overall schedule.

  • Ad extensions can have multiple ExtensionSchedule objects to define their active timeframes across different days and hours.

  • You can specify the start and end times for each ExtensionSchedule using properties like dayOfWeek, startHour, startMinute, endHour, and endMinute.

  • The provided code snippet demonstrates setting a sitelink extension's schedule to be active on Mondays and Tuesdays from 9:00 to 18:00.

  • Methods like getDayOfWeek(), getEndHour(), and getStartMinute() allow you to retrieve the specific details of an ExtensionSchedule.

Represents one period of a Google Ads ad extension schedule. For instance, if an ad extension were set up to only show on ads on weekdays from 09:00 to 18:00, it would have five ExtensionSchedules: one for Monday 09:00 - 18:00, one for Tuesday 09:00 - 18:00, and so on.

 var monday = {
   dayOfWeek: "MONDAY",
   startHour: 9,
   startMinute: 0,
   endHour: 18,
   endMinute: 0
 };
 var tuesday = {
   dayOfWeek: "TUESDAY",
   startHour: 9,
   startMinute: 0,
   endHour: 18,
   endMinute: 0
 };

 sitelink.setSchedules([monday, tuesday]);

Methods:

MemberTypeDescription
getDayOfWeek() String Returns the day of week this schedule applies to.
getEndHour() int Returns the ending hour of this schedule.
getEndMinute() int Returns the ending minute of this schedule.
getEntityType() String Returns the type of this entity as a String, in this case, "ExtensionSchedule".
getStartHour() int Returns the starting hour of this schedule.
getStartMinute() int Returns the starting minute of this schedule.

getDayOfWeek()

Returns the day of week this schedule applies to.

Possible values: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", or "SUNDAY".

Return values:

TypeDescription
String The day of week this schedule applies to.

getEndHour()

Returns the ending hour of this schedule.

The time is based on a 24-hour clock. Valid ending times range from 00:15 to 24:00. So, for instance, a schedule which ends at 15:30 would return 15 as the value of getEndHour().

Return values:

TypeDescription
int The ending hour of this schedule.

getEndMinute()

Returns the ending minute of this schedule.

For instance, a schedule which ends at 15:30 would return 30 as the value of getEndMinute(). The only possible return values are 0, 15, 30, and 45.

Return values:

TypeDescription
int The ending minute of this schedule.

getEntityType()

Returns the type of this entity as a String, in this case, "ExtensionSchedule".

Return values:

TypeDescription
String Type of this entity: "ExtensionSchedule".

getStartHour()

Returns the starting hour of this schedule.

The time is based on a 24-hour clock. Valid starting times range from 00:00 to 23:45. So, for instance, a schedule which starts at 15:30 would return 15 as the value of getStartHour().

Return values:

TypeDescription
int The starting hour of this schedule.

getStartMinute()

Returns the starting minute of this schedule.

For instance, a schedule which starts at 15:30 would return 30 as the value of getStartMinute(). The only possible return values are 0, 15, 30, and 45.

Return values:

TypeDescription
int The starting minute of this schedule.