AdsApp.​AdSchedule

AI-generated Key Takeaways

outlined_flag

• AdSchedule represents a single period within a Google Ads ad schedule, defining specific days and times for ad display.

• Each AdSchedule object corresponds to a unique combination of day and time range for a campaign's ad scheduling.

• You can retrieve information about the ad schedule, such as the campaign it belongs to, its bid modifier, day of the week, and start/end times using various methods.

• The getStatsFor() method allows you to fetch performance statistics for a specific ad schedule within a defined date range.

• Ad schedules can be modified by setting a new bid modifier or removed entirely using the setBidModifier() and remove() methods.

For instance, if a campaign were set up to show ads only on weekdays from 9AM to 6PM, it would have five AdSchedule s: one for Monday 9AM-6PM, one for Tuesday 9AM-6PM, and so on.

Methods:

getBaseCampaign()

Return values:

getBidModifier()

The bid modifier is a multiplier applied to bids which match this ad schedule. So, for instance, a bid modifier of 1.1 increases the bid to 110% of its original value, and changes a bid of $5.00 to a bid of $5.50.

The bid modifiers for all matching criteria are multiplied together to calculate the actual bid modification. A campaign with the following bid modifiers:

For more information about bid modifiers, please see the Google Ads Help Center article .

Return values:

getCampaign()

Return values:

getCampaignType()

SEARCH_OR_DISPLAY, VIDEO, SHOPPING

Return values:

getDayOfWeek()

This will be one of "MONDAY" , "TUESDAY" , "WEDNESDAY" , "THURSDAY" , "FRIDAY" , "SATURDAY" , or "SUNDAY" .

Return values:

getEndHour()

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

Return values:

getEndMinute()

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

Return values:

getEntityType()

Return values:

getId()

Ad schedule IDs may be shared across campaigns. In order to uniquely identify an ad schedule target, one must specify both its campaign ID and the ad schedule ID.

Return values:

getResourceName()

Return values:

getShoppingCampaign()

Return values:

getStartHour()

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

Return values:

getStartMinute()

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

Return values:

getStatsFor(dateRange)

TODAY, YESTERDAY, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT, THIS_MONTH, LAST_MONTH, ALL_TIME .

Example:

 var 
  
 stats 
  
 = 
  
 adSchedule 
 . 
 getStatsFor 
 ( 
 "THIS_MONTH" 
 ); 

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

getVideoCampaign()

Return values:

remove()

Returns nothing.

setBidModifier(modifier)

The bid modifier is a multiplier applied to bids which match this ad schedule. So, for instance, a bid modifier of 1.1 increases the bid to 110% of its original value, and changes a bid of $5.00 to a bid of $5.50 .

The bid modifiers for all matching criteria are multiplied together to calculate the actual bid modification. A campaign with the following bid modifiers:

For more information about bid modifiers, please see the Google Ads Help Center article . For ad schedules, acceptable bid modifiers are in the range 0.1 to 10 .

Returns nothing.

Arguments: