AdsApp.​ShoppingCampaignAudience

Represents a Google Ads audience, either USER_INTEREST or USER_LIST, configured for shopping campaigns.

Methods:

MemberTypeDescription
bidding AdsApp.ShoppingAudienceBidding Provides access to this audience's bidding fields.
getAudienceId String Returns the audience ID of the audience.
getAudienceType String Returns the type of the audience, either USER_INTEREST or USER_LIST.
getCampaign AdsApp.ShoppingCampaign Returns the campaign to which this audience belongs.
getId String Returns the ID of the shopping audience.
getName String Returns the name of the audience.
getResourceName String Returns the resource name of the shopping 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 shopping audience is enabled.
isPaused boolean Returns true if the shopping audience is paused.
remove void Removes the shopping audience.

bidding()

Provides access to this audience's bidding fields.

Return values:

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

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.

getCampaign()

Returns the campaign to which this audience belongs.

Return values:

TypeDescription
AdsApp.ShoppingCampaign The campaign to which this audience belongs.

getId()

Returns the ID of the shopping audience.

Return values:

TypeDescription
String The ID of the shopping audience.

getName()

Returns the name of the audience.

Return values:

TypeDescription
String The name of the audience.

getResourceName()

Returns the resource name of the shopping audience.

Return values:

TypeDescription
String The resource name of the shopping 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 = shoppingAudience.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 shopping audience is enabled.

Return values:

TypeDescription
boolean true if the shopping audience is enabled.

isPaused()

Returns true if the shopping audience is paused.

Return values:

TypeDescription
boolean true if the shopping audience is paused.

remove()

Removes the shopping audience.

Returns nothing.