AI-generated Key Takeaways
-
Represents a callout ad extension added to an account for enhanced ad display.
-
Provides methods to manage the callout's text, scheduling, start and end dates, and device preference.
-
Allows retrieval of callout performance statistics for specific date ranges.
-
More information on callouts and other ad extensions can be found on the Ad Extensions page.
Methods:
| Member | Type | Description |
|---|---|---|
| clearEndDate() | void |
Clears the account-level callout's end date. |
| clearStartDate() | void |
Clears the account-level callout's start date. |
| getEndDate() | AdsApp.GoogleAdsDate |
Returns the end date of the account-level callout, or null if no
end date is set. |
| getEntityType() | String |
Returns the type of this entity as a String, in this case,
"AccountCallout". |
| getId() | String |
Returns the ID of the account-level callout. |
| getResourceName() | String |
Returns the resource name of the account-level callout. |
| getSchedules() | AdsApp.ExtensionSchedule[] |
Returns the scheduling of the account-level callout. |
| getStartDate() | AdsApp.GoogleAdsDate |
Returns the start date of the account-level callout, or null if
no start date is set. |
| getStatsFor(dateRange) | AdsApp.Stats |
Returns stats for the specified date range. |
| getStatsFor(dateFrom, dateTo) | AdsApp.Stats |
Returns stats for the specified custom date range. |
| getText() | String |
Returns the text of the account-level callout. |
boolean |
Returns true if the account-level callout specifies mobile
device preference. |
|
| setEndDate(date) | void |
Sets the account-level callout's end date from either an object containing
year, month, and day fields, or an 8-digit string in YYYYMMDD
format. |
void |
Sets the account-level callout's device preference. | |
| setSchedules(schedules) | void |
Sets the account-level callout scheduling. |
| setStartDate(date) | void |
Sets the account-level callout's start date from either an object containing
year, month, and day fields, or an 8-digit string in YYYYMMDD
format. |
| setText(text) | void |
Sets the text of the account-level callout. |
clearEndDate()
Clears the account-level callout's end date. Returns nothing.
clearStartDate()
Clears the account-level callout's start date. Returns nothing.
getEndDate()
Returns the end date of the account-level callout, or null if no
end date is set.
For instance, if the end date of the account-level callout is May 3, 2013,
this would return the following object: {year: 2013, month: 5, day:
3}.
Return values:
| Type | Description |
|---|---|
AdsApp.GoogleAdsDate |
The account-level callout's end date, or null if there's
no end date. |
getEntityType()
Returns the type of this entity as a String, in this case,
"AccountCallout". Return values:
| Type | Description |
|---|---|
String |
Type of this entity: "AccountCallout". |
getId()
Returns the ID of the account-level callout. Return values:
| Type | Description |
|---|---|
String |
The ID of the account-level callout. |
getResourceName()
Returns the resource name of the account-level callout. Return values:
| Type | Description |
|---|---|
String |
The resource name of the account-level callout. |
getSchedules()
Returns the scheduling of the account-level callout. Return values:
| Type | Description |
|---|---|
AdsApp.ExtensionSchedule[] |
The scheduling of the account-level callout. |
getStartDate()
Returns the start date of the account-level callout, or null if
no start date is set.
For instance, if the start date of the account-level callout is May 3,
2013, this would return the following object: {year: 2013, month: 5,
day: 3}.
Return values:
| Type | Description |
|---|---|
AdsApp.GoogleAdsDate |
The account-level callout's start date, or null if
there's no start date. |
getStatsFor(dateRange)
Returns stats for the specified date range. Supported values:
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 = accountCallout.getStatsFor("THIS_MONTH");
Arguments:
| Name | Type | Description |
|---|---|---|
| dateRange | String |
Date range for which the stats are requested. |
Return values:
| Type | Description |
|---|---|
AdsApp.Stats |
The stats for the specified date range. |
getStatsFor(dateFrom, dateTo)
Returns stats for the specified custom date range. Both parameters can be
either an object containing year, month, and day fields, or an 8-digit
string in YYYYMMDD form. For instance, March 24th,
2013 is represented as either {year: 2013, month: 3, day:
24} or "20130324". The date range is inclusive on both
ends, so forDateRange("20130324", "20130324") defines a range
of a single day. Arguments:
| Name | Type | Description |
|---|---|---|
| dateFrom | Object |
Start date of the date range. Must be either a string in
YYYYMMDD form, or an object with year,
month and day properties. |
| dateTo | Object |
End date of the date range. Must be either a string in
YYYYMMDD form, or an object with year,
month and day properties. |
Return values:
| Type | Description |
|---|---|
AdsApp.Stats |
The stats for the specified date range. |
getText()
Returns the text of the account-level callout. Return values:
| Type | Description |
|---|---|
String |
Text of the account-level callout. |
isMobilePreferred()
Returns true if the account-level callout specifies mobile
device preference.
Return values:
| Type | Description |
|---|---|
boolean |
true if the account-level callout specifies mobile
device preference. |
setEndDate(date)
Sets the account-level callout's end date from either an object containing
year, month, and day fields, or an 8-digit string in YYYYMMDD
format.
For instance, accountCallout.setEndDate("20130503"); is equivalent to accountCallout.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:
| Name | Type | Description |
|---|---|---|
| date | Object |
The new account-level callout end date. |
setMobilePreferred(isMobilePreferred)
Sets the account-level callout's device preference.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|---|---|
| isMobilePreferred | boolean |
true sets the device preference to
mobile. false clears the device preference. |
setSchedules(schedules)
Sets the account-level callout scheduling. Scheduling of a account-level callout allows you to control the days of week and times of day during which
the account-level callout will show alongside your ads.
Passing in an empty array clears the scheduling field, causing the account-level callout to run at all times.
The following example sets the account-level 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 }; accountCallout.setSchedules([mondayMorning, tuesdayMorning]);
Returns nothing.
Arguments:
| Name | Type | Description |
|---|---|---|
| schedules | AdsApp.ExtensionSchedule[] |
The new account-level callout schedules. |
setStartDate(date)
Sets the account-level callout's start date from either an object containing
year, month, and day fields, or an 8-digit string in YYYYMMDD
format.
For instance, accountCallout.setStartDate("20130503"); is equivalent to accountCallout.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 account-level callout's end date.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|---|---|
| date | Object |
The new account-level callout start date. |
setText(text)
Sets the text of the account-level callout. Returns nothing.
Arguments:
| Name | Type | Description |
|---|---|---|
| text | String |
The text. |