AdsApp.​Callout

Stay organized with collections Save and categorize content based on your preferences.

Methods:

clearEndDate()

Returns nothing.

clearStartDate()

Returns nothing.

getEndDate()

For instance, if the end date of the callout is May 3, 2013, this would return the following object: {year: 2013, month: 5, day: 3}.

Return values:

getEntityType()

Return values:

getId()

Return values:

getResourceName()

Return values:

getSchedules()

Return values:

getStartDate()

For instance, if the start date of the callout is May 3, 2013, this would return the following object: {year: 2013, month: 5, day: 3}.

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 = callout.getStatsFor("THIS_MONTH");

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

getText()

Return values:

isLegacy()

Return values:

isMobilePreferred()

Return values:

setEndDate(date)

For instance, callout.setEndDate("20130503"); is equivalent to callout.setEndDate({year: 2013, month: 5, day: 3});.

The change will fail and report an error if:

• the given date is invalid (e.g., {year: 2013, month: 5, day: 55}),
• the start date now comes after the end date, or
• it's a date in the past.

Returns nothing.

Arguments:

setMobilePreferred(isMobilePreferred)

Returns nothing.

Arguments:

setSchedules(schedules)

Passing in an empty array clears the scheduling field, causing the callout to run at all times.

The following example sets the callout to run on Mondays and Tuesday from 8:00 to 11:00.

var mondayMorning = {
  dayOfWeek: "MONDAY",
  startHour: 8,
  startMinute: 0,
  endHour: 11,
  endMinute: 0
};
var tuesdayMorning = {
  dayOfWeek: "TUESDAY",
  startHour: 8,
  startMinute: 0,
  endHour: 11,
  endMinute: 0
};

callout.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

setStartDate(date)

For instance, callout.setStartDate("20130503"); is equivalent to callout.setStartDate({year: 2013, month: 5, day: 3});.

The change will fail and report an error if:

• the given date is invalid (e.g., {year: 2013, month: 5, day: 55}),
• the given date is after the callout's end date.

Returns nothing.

Arguments:

setText(text)

Returns nothing.

Arguments: