AdsApp.​ShoppingAdGroupAudienceBuilder

AI-generated Key Takeaways

• The ShoppingAdGroupAudienceBuilder is used to create ShoppingAdGroupAudience objects.

• The required method withAudienceId() sets the unique ID for the audience.

• The optional method withBidModifier() allows you to adjust bids for the audience.

• The build() method finalizes the audience and returns a ShoppingAdGroupAudienceOperation object.

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:

Member	Type	Description
build()	AdsApp.ShoppingAdGroupAudienceOperation	Builds the audience.
withAudienceId(audienceId)	AdsApp.ShoppingAdGroupAudienceBuilder	Sets the audience ID of the audience.
withBidModifier(modifier)	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:

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

Name	Type	Description
audienceId	String	The audience ID of the audience.

Return values:

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

Name	Type	Description
modifier	double	The bid modifier value.

Return values:

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