AdsApp.​ShoppingCampaignAudienceBuilder

  • The ShoppingCampaignAudienceBuilder is used to create ShoppingCampaignAudience objects.

  • You can set the required audience ID using withAudienceId().

  • You can optionally set a bid modifier for the audience using withBidModifier().

  • The build() method finalizes the audience creation and returns a ShoppingCampaignAudienceOperation.

 Builder for ShoppingCampaignAudience objects.

Example usage: 

var audienceBuilder = shoppingCampaign.targeting().newUserListBuilder();
var audienceOperation = audienceBuilder
    .withAudienceId(3)              // required
    .build();                       // add the audience
var audience = audienceOperation.getResult();

Methods:

MemberTypeDescription
build() AdsApp.ShoppingCampaignAudienceOperation Builds the audience.
withAudienceId(audienceId) AdsApp.ShoppingCampaignAudienceBuilder Sets the audience ID of the audience.
withBidModifier(modifier) AdsApp.ShoppingCampaignAudienceBuilder Sets the bid modifier value for this audience to the specified value.

build()

Builds the audience. Returns a ShoppingCampaignAudienceOperation that corresponds to the addition of the ShoppingCampaignAudience.

Return values:

TypeDescription
AdsApp.ShoppingCampaignAudienceOperation The ShoppingCampaignAudienceOperation.

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 String The audience ID of the audience.

Return values:

TypeDescription
AdsApp.ShoppingCampaignAudienceBuilder 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.ShoppingCampaignAudienceBuilder An audience builder configured to use the specified bid modifier.