AdsApp.​Audience

Represents a Google Ads audience.

Methods:

Member Type Description
AdsApp.DisplayCriterionBidding Provides access to this audience's bidding fields.
AdsApp.AdGroup Returns the ad group to which this audience belongs.
String Returns the audience ID of the audience.
String Returns the type of the audience, either USER_INTEREST or USER_LIST .
AdsApp.AdGroup Returns the base ad group to which this audience belongs.
AdsApp.Campaign Returns the base campaign to which this audience belongs.
AdsApp.Campaign Returns the campaign to which this audience belongs or null if it does not belong to a search or display campaign.
String Returns the ID of the audience.
String Returns the resource name of the audience.
AdsApp.Stats Returns stats for the specified date range.
AdsApp.Stats Returns stats for the specified custom date range.
boolean Returns true if the audience is enabled.
boolean Returns true if the audience is paused.
void Removes the audience.

bidding()

Provides access to this audience's bidding fields.

Return values:

Type Description
AdsApp.DisplayCriterionBidding Access to this audience's bidding fields.

getAdGroup()

Returns the ad group to which this audience belongs.

Return values:

Type Description
AdsApp.AdGroup The ad group to which this audience belongs.

getAudienceId()

Returns the audience ID of the audience. User List IDs (List IDs) are available on the details page of a User List (found under the Audiences section of the Shared Library).

Return values:

Type Description
String The audience ID of the audience.

getAudienceType()

Returns the type of the audience, either USER_INTEREST or USER_LIST .

Return values:

Type Description
String The type of the audience.

getBaseAdGroup()

Returns the base ad group to which this audience belongs.

Return values:

Type Description
AdsApp.AdGroup The base ad group to which this audience belongs.

getBaseCampaign()

Returns the base campaign to which this audience belongs.

Return values:

Type Description
AdsApp.Campaign The base campaign to which this audience belongs.

getCampaign()

Returns the campaign to which this audience belongs or null if it does not belong to a search or display campaign.

Return values:

Type Description
AdsApp.Campaign The campaign to which this audience belongs or null if it does not belong to a search or display campaign.

getId()

Returns the ID of the audience.

Return values:

Type Description
String The ID of the audience.

getResourceName()

Returns the resource name of the audience.

Return values:

Type Description
String The resource name of the audience.

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 
  
 = 
  
 audience 
 . 
 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.

isEnabled()

Returns true if the audience is enabled.

Return values:

Type Description
boolean true if the audience is enabled.

isPaused()

Returns true if the audience is paused.

Return values:

Type Description
boolean true if the audience is paused.

remove()

Removes the audience.

Returns nothing.

Create a Mobile Website
View Site in Mobile | Classic
Share by: