AdsApp.​Audience

Represents a Google Ads audience.

Methods:

MemberTypeDescription
bidding AdsApp.DisplayCriterionBidding Provides access to this audience's bidding fields.
getAdGroup AdsApp.AdGroup Returns the ad group to which this audience belongs.
getAudienceId String Returns the audience ID of the audience.
getAudienceType String Returns the type of the audience, either USER_INTEREST or USER_LIST.
getBaseAdGroup AdsApp.AdGroup Returns the base ad group to which this audience belongs.
getBaseCampaign AdsApp.Campaign Returns the base campaign to which this audience belongs.
getCampaign AdsApp.Campaign Returns the campaign to which this audience belongs or null if it does not belong to a search or display campaign.
getId String Returns the ID of the audience.
getResourceName String Returns the resource name of the audience.
getStatsFor AdsApp.Stats Returns stats for the specified date range.
getStatsFor AdsApp.Stats Returns stats for the specified custom date range.
isEnabled boolean Returns true if the audience is enabled.
isPaused boolean Returns true if the audience is paused.
remove void Removes the audience.

bidding()

Provides access to this audience's bidding fields.

Return values:

TypeDescription
AdsApp.DisplayCriterionBidding Access to this audience's bidding fields.

getAdGroup()

Returns the ad group to which this audience belongs.

Return values:

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

TypeDescription
String The audience ID of the audience.

getAudienceType()

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

Return values:

TypeDescription
String The type of the audience.

getBaseAdGroup()

Returns the base ad group to which this audience belongs.

Return values:

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

getBaseCampaign()

Returns the base campaign to which this audience belongs.

Return values:

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

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

TypeDescription
String The ID of the audience.

getResourceName()

Returns the resource name of the audience.

Return values:

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

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

Return values:

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

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
AdsApp.Stats The stats for the specified date range.

isEnabled()

Returns true if the audience is enabled.

Return values:

TypeDescription
boolean true if the audience is enabled.

isPaused()

Returns true if the audience is paused.

Return values:

TypeDescription
boolean true if the audience is paused.

remove()

Removes the audience.

Returns nothing.