AdsApp.​ShoppingAdGroupAudienceBuilder

Builder for ShoppingAdGroupAudience objects.

Example usage:

 var shoppingAudienceBuilder = adGroup.targeting().newUserListBuilder();
 var shoppingAudience = shoppingAudienceBuilder
   .withAudienceId(3)              // required
   .withBidModifier(1)             // optional
   .build();                       // add the audience

Methods:

MemberTypeDescription
build AdsApp.ShoppingAdGroupAudienceOperation Builds the audience.
withAudienceId AdsApp.ShoppingAdGroupAudienceBuilder Sets the audience ID of the audience.
withBidModifier AdsApp.ShoppingAdGroupAudienceBuilder Sets the bid modifier value for this audience to the specified value.

build()

Builds the audience. Returns a ShoppingAdGroupAudienceOperation that corresponds to the addition of the ShoppingAdGroupAudience.

Return values:

TypeDescription
AdsApp.ShoppingAdGroupAudienceOperation The ShoppingAdGroupAudienceOperation.

withAudienceId(audienceId)

Sets the audience ID of the audience. This field is required. User List IDs (List IDs) are available on the details page of a User List (found under the Audiences section of the Shared Library).

Arguments:

NameTypeDescription
audienceId Long The audience ID of the audience.

Return values:

TypeDescription
AdsApp.ShoppingAdGroupAudienceBuilder An audience builder for the specified audience ID.

withBidModifier(modifier)

Sets the bid modifier value for this audience to the specified value.

The bid modifier is a multiplier applied to the audience's bids, with an acceptable range from 0.1 (a 90% decrease) to 10.0 (a 900% increase).

For more information about bid modifiers please see the Google Ads Help Center article.

Arguments:

NameTypeDescription
modifier double The bid modifier value.

Return values:

TypeDescription
AdsApp.ShoppingAdGroupAudienceBuilder An audience builder configured to use the specified bid modifier.

Send feedback about...

Google Ads scripts
Google Ads scripts
Need help? Visit our support page.