AdsApp.ShoppingAdGroupAudienceBuilder
Stay organized with collections
Save and categorize content based on your preferences.
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:
build()
Builds the audience. Returns a
ShoppingAdGroupAudienceOperation
that corresponds to the addition of the
ShoppingAdGroupAudience.
Return values:
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:
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:
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-25 UTC.
[null,null,["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThis page documents the \u003ccode\u003eShoppingAdGroupAudienceBuilder\u003c/code\u003e used for creating ShoppingAdGroupAudience objects in Google Ads scripts.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to set the audience ID (\u003ccode\u003ewithAudienceId\u003c/code\u003e) and bid modifier (\u003ccode\u003ewithBidModifier\u003c/code\u003e) for the audience.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ebuild()\u003c/code\u003e method finalizes the audience creation and returns a \u003ccode\u003eShoppingAdGroupAudienceOperation\u003c/code\u003e for adding the audience.\u003c/p\u003e\n"],["\u003cp\u003eAudience ID is a required field and bid modifier is optional, with a range of 0.1 to 10.0.\u003c/p\u003e\n"]]],[],null,["# AdsApp.ShoppingAdGroupAudienceBuilder\n\nBuilder for [ShoppingAdGroupAudience](/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingadgroupaudience) objects.\n\nExample usage:\n\n```gdscript\nvar shoppingAudienceBuilder = adGroup.targeting().newUserListBuilder();\nvar shoppingAudience = shoppingAudienceBuilder\n .withAudienceId(3) // required\n .withBidModifier(1) // optional\n .build(); // add the audience\n```\n\n### Methods:\n\n| Member | Type | Description |\n|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|\n| [build()](#build) | [AdsApp.ShoppingAdGroupAudienceOperation](/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingadgroupaudienceoperation) | Builds the audience. |\n| [withAudienceId(audienceId)](#withAudienceId_audienceId) | [AdsApp.ShoppingAdGroupAudienceBuilder](/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingadgroupaudiencebuilder) | Sets the audience ID of the audience. |\n| [withBidModifier(modifier)](#withBidModifier_modifier) | [AdsApp.ShoppingAdGroupAudienceBuilder](/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingadgroupaudiencebuilder) | Sets the bid modifier value for this audience to the specified value. |\n\n`build()`\n---------\n\nBuilds the audience. Returns a [ShoppingAdGroupAudienceOperation](/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingadgroupaudienceoperation) that corresponds to the addition of the [ShoppingAdGroupAudience](/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingadgroupaudience).\n\n### Return values:\n\n| Type | Description |\n|------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|\n| [AdsApp.ShoppingAdGroupAudienceOperation](/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingadgroupaudienceoperation) | The ShoppingAdGroupAudienceOperation. |\n\n`withAudienceId(audienceId)`\n----------------------------\n\nSets 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).\n\n### Arguments:\n\n| Name | Type | Description |\n|------------|----------|----------------------------------|\n| audienceId | `String` | The audience ID of the audience. |\n\n### Return values:\n\n| Type | Description |\n|--------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|\n| [AdsApp.ShoppingAdGroupAudienceBuilder](/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingadgroupaudiencebuilder) | An audience builder for the specified audience ID. |\n\n`withBidModifier(modifier)`\n---------------------------\n\nSets the bid modifier value for this audience to the specified value.\n\nThe bid modifier is a multiplier applied to the audience's bids, with an\nacceptable range from `0.1` (a `90%` decrease) to\n`10.0` (a `900%` increase).\n\nFor more information about bid modifiers please see the [Google Ads Help\nCenter article](//support.google.com/google-ads/answer/2732132).\n\n### Arguments:\n\n| Name | Type | Description |\n|----------|----------|-------------------------|\n| modifier | `double` | The bid modifier value. |\n\n### Return values:\n\n| Type | Description |\n|--------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|\n| [AdsApp.ShoppingAdGroupAudienceBuilder](/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingadgroupaudiencebuilder) | An audience builder configured to use the specified bid modifier. |"]]
