AdWordsApp.​AdGroupCallout

Represents a callout that has been added to an ad group as an ad callout extension. Visit our Ad Extensions page for more information on callouts and other types of ad extensions.

Methods:

MemberTypeDescription
getAdGroup AdWordsApp.AdGroup Returns the ad group to which this ad group-level callout belongs.
getCampaign AdWordsApp.Campaign Returns the campaign to which this ad group-level callout belongs.
getEndDate AdWordsApp.AdWordsDate Returns the end date of the ad group-level callout.
getEntityType String Returns the type of this entity as a String, in this case, "AdGroupCallout".
getId long Returns the ID of the ad group-level callout.
getSchedules AdWordsApp.ExtensionSchedule[] Returns the scheduling of the ad group-level callout.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the ad group-level callout.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
getText String Returns the text of the ad group-level callout.
isMobilePreferred boolean Returns true if the ad group-level callout specifies mobile device preference.
setEndDate void Sets the ad group-level callout's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
setMobilePreferred void Sets the ad group-level callout's device preference.
setSchedules void Sets the ad group-level callout scheduling.
setStartDate void Sets the ad group-level callout's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
setText void Sets the text of the ad group-level callout.

getAdGroup()

Returns the ad group to which this ad group-level callout belongs.

Return values:

TypeDescription
AdWordsApp.AdGroup The ad group to which this ad group-level callout belongs.

getCampaign()

Returns the campaign to which this ad group-level callout belongs.

Return values:

TypeDescription
AdWordsApp.Campaign The campaign to which this ad group-level callout belongs.

getEndDate()

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

Return values:

TypeDescription
AdWordsApp.AdWordsDate The ad group-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, "AdGroupCallout".

Return values:

TypeDescription
String Type of this entity: "AdGroupCallout".

getId()

Returns the ID of the ad group-level callout.

Return values:

TypeDescription
long The ID of the ad group-level callout.

getSchedules()

Returns the scheduling of the ad group-level callout.

Return values:

TypeDescription
AdWordsApp.ExtensionSchedule[] The scheduling of the ad group-level callout.

getStartDate()

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

Return values:

TypeDescription
AdWordsApp.AdWordsDate The ad group-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 = adGroupCallout.getStatsFor("THIS_MONTH");

Arguments:

NameTypeDescription
dateRange String Date range for which the stats are requested.

Return values:

TypeDescription
AdWordsApp.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:

NameTypeDescription
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:

TypeDescription
AdWordsApp.Stats The stats for the specified date range.

getText()

Returns the text of the ad group-level callout.

Return values:

TypeDescription
String Text of the ad group-level callout.

isMobilePreferred()

Returns true if the ad group-level callout specifies mobile device preference.

Return values:

TypeDescription
boolean true if the ad group-level callout specifies mobile device preference.

setEndDate(date)

Sets the ad group-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, adGroupCallout.setEndDate("20130503"); is equivalent to adGroupCallout.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:

NameTypeDescription
date Object The new ad group-level callout end date.

setMobilePreferred(isMobilePreferred)

Sets the ad group-level callout's device preference.

Returns nothing.

Arguments:

NameTypeDescription
isMobilePreferred boolean true sets the device preference to mobile. false clears the device preference.

setSchedules(schedules)

Sets the ad group-level callout scheduling. Scheduling of a ad group-level callout allows you to control the days of week and times of day during which the ad group-level callout will show alongside your ads.

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

The following example sets the ad group-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
 };

 adGroupCallout.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

NameTypeDescription
schedules AdWordsApp.ExtensionSchedule[] The new ad group-level callout schedules.

setStartDate(date)

Sets the ad group-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, adGroupCallout.setStartDate("20130503"); is equivalent to adGroupCallout.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 ad group-level callout's end date.

Returns nothing.

Arguments:

NameTypeDescription
date Object The new ad group-level callout start date.

setText(text)

Sets the text of the ad group-level callout.

Returns nothing.

Arguments:

NameTypeDescription
text String The text.

Feedback geben zu...

AdWords Scripts
AdWords Scripts