AdsApp.ShoppingAdGroupAudience

Page Summary

ShoppingAdGroupAudience represents a Google Ads audience, either USER_INTEREST or USER_LIST, configured for shopping ad groups.
It provides methods to access bidding fields, retrieve associated ad group and campaign, and get details like audience ID, type, name, and resource name.
You can get performance statistics for specific or custom date ranges using the getStatsFor method.
Methods are available to check if the audience is enabled or paused, and to remove the shopping audience.

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

Methods:

Member	Type	Description
bidding()	`AdsApp.ShoppingAudienceBidding`	Provides access to this audience's bidding fields.
getAdGroup()	`AdsApp.ShoppingAdGroup`	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` .
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(dateRange)	`AdsApp.Stats`	Returns stats for the specified date range.
getStatsFor(dateFrom, dateTo)	`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:

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

`getAdGroup()`

Returns the ad group to which this audience belongs.

Return values:

Type	Description
`AdsApp.ShoppingAdGroup`	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.

`getCampaign()`

Returns the campaign to which this audience belongs.

Return values:

Type	Description
`AdsApp.ShoppingCampaign`	The campaign to which this audience belongs.

`getId()`

Returns the ID of the shopping audience.

Return values:

Type	Description
`String`	The ID of the shopping audience.

`getName()`

Returns the name of the audience.

Return values:

Type	Description
`String`	The name of the audience.

`getResourceName()`

Returns the resource name of the shopping audience.

Return values:

Type	Description
`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:

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 shopping audience is enabled.

Return values:

Type	Description
`boolean`	`true` if the shopping audience is enabled.

`isPaused()`

Returns true if the shopping audience is paused.

Return values:

Type	Description
`boolean`	`true` if the shopping audience is paused.

`remove()`

Removes the shopping audience.

Returns nothing.

AdsApp.​ShoppingAdGroupAudience Stay organized with collections Save and categorize content based on your preferences.

Page Summary

Methods:

bidding()

Return values:

getAdGroup()

Return values:

getAudienceId()

Return values:

getAudienceType()

Return values:

getCampaign()

Return values:

getId()

Return values:

getName()

Return values:

getResourceName()

Return values:

getStatsFor(dateRange)

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

isEnabled()

Return values:

isPaused()

Return values:

remove()

AdsApp.ShoppingAdGroupAudience

`bidding()`

`getAdGroup()`

`getAudienceId()`

`getAudienceType()`

`getCampaign()`

`getId()`

`getName()`

`getResourceName()`

`getStatsFor(dateRange)`

`getStatsFor(dateFrom, dateTo)`

`isEnabled()`

`isPaused()`

`remove()`