AdWordsApp.​AccountReview

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

Methods:

MemberTypeDescription
getEndDate AdWordsApp.AdWordsDate Returns the end date of the account-level review.
getEntityType String Returns the type of this entity as a String, in this case, "AccountReview".
getId long Returns the ID of the account-level review.
getSchedules AdWordsApp.ExtensionSchedule[] Returns the scheduling of the account-level review.
getSourceName String Returns the name of the source of the account-level review.
getSourceUrl String Returns the source URL of the account-level review.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the account-level review.
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 account-level review.
isExactlyQuoted boolean Returns true if the text of the account-level review is exactly quoted, or false if the text is paraphrased.
isMobilePreferred boolean Returns true if the account-level review specifies mobile device preference.
setEndDate void Sets the account-level review's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
setExactlyQuoted void Sets the exactly quoted value of the account-level review.
setMobilePreferred void Sets the account-level review's device preference.
setSchedules void Sets the account-level review scheduling.
setSourceName void Sets the name of the source of the account-level review.
setSourceUrl void Sets the source URL of the account-level review.
setStartDate void Sets the account-level review'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 account-level review.

getEndDate()

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

Return values:

TypeDescription
AdWordsApp.AdWordsDate The account-level review's end date, or null if there's no end date.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "AccountReview".

getId()

Returns the ID of the account-level review.

Return values:

TypeDescription
long The ID of the account-level review.

getSchedules()

Returns the scheduling of the account-level review.

Return values:

TypeDescription
AdWordsApp.ExtensionSchedule[] The scheduling of the account-level review.

getSourceName()

Returns the name of the source of the account-level review.

Return values:

TypeDescription
String Source name of the account-level review.

getSourceUrl()

Returns the source URL of the account-level review.

Return values:

TypeDescription
String Source URL of the account-level review.

getStartDate()

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

Return values:

TypeDescription
AdWordsApp.AdWordsDate The account-level review'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 = accountReview.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 account-level review.

Return values:

TypeDescription
String Text of the account-level review.

isExactlyQuoted()

Returns true if the text of the account-level review is exactly quoted, or false if the text is paraphrased.

Return values:

TypeDescription
boolean true if the text of the account-level review is exactly quoted, or false if the text is paraphrased.

isMobilePreferred()

Returns true if the account-level review specifies mobile device preference.

Return values:

TypeDescription
boolean true if the account-level review specifies mobile device preference.

setEndDate(date)

Sets the account-level review's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format. For instance, accountReview.setEndDate("20130503"); is equivalent to accountReview.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 account-level review end date.

setExactlyQuoted(isExactlyQuoted)

Sets the exactly quoted value of the account-level review. Specify true if the text of the review is exactly quoted, which will result in the text being rendered with quotation marks. Specify false if the text of the review is paraphrased, which will result in the text being rendered without quotation marks.

Returns nothing.

Arguments:

NameTypeDescription
isExactlyQuoted boolean The exactly quoted value of the account-level review.

setMobilePreferred(isMobilePreferred)

Sets the account-level review'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 account-level review scheduling. Scheduling of a account-level review allows you to control the days of week and times of day during which the account-level review will show alongside your ads.

Passing in an empty array clears the scheduling field, causing the account-level review to run at all times.

The following example sets the account-level review 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
 };

 accountReview.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

NameTypeDescription
schedules AdWordsApp.ExtensionSchedule[] The new account-level review schedules.

setSourceName(sourceName)

Sets the name of the source of the account-level review. The combined length of sourceName and text is limited to 67 characters.

Returns nothing.

Arguments:

NameTypeDescription
sourceName String The source name of the account-level review.

setSourceUrl(sourceUrl)

Sets the source URL of the account-level review.

Returns nothing.

Arguments:

NameTypeDescription
sourceUrl String The source URL.

setStartDate(date)

Sets the account-level review's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format. For instance, accountReview.setStartDate("20130503"); is equivalent to accountReview.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 review's end date.

Returns nothing.

Arguments:

NameTypeDescription
date Object The new account-level review start date.

setText(text)

Sets the text of the account-level review. The combined length of sourceName and text is limited to 67 characters.

Returns nothing.

Arguments:

NameTypeDescription
text String The text of the account-level review.

Feedback geben zu...

AdWords Scripts
AdWords Scripts