AdsApp.​SearchCampaignAudienceBuilder

Builder for SearchCampaignAudience and SearchCampaignExcludedAudience objects.

Example usage:

var audienceBuilder = campaign.targeting().newUserListBuilder();
var audienceOperation = audienceBuilder
    .withAudienceId(3)       // required
    .build();                // add the audience, or .exclude() to exclude
                             // the audience.
var audience = audienceOperation.getResult();

Methods:

Member	Type	Description
build	AdsApp.SearchCampaignAudienceOperation	Builds the audience.
exclude	AdsApp.SearchCampaignExcludedAudienceOperation	Builds the excluded audience.
withAudience	AdsApp.SearchCampaignAudienceBuilder	Sets the user list of the audience.
withAudienceId	AdsApp.SearchCampaignAudienceBuilder	Sets the audience ID of the audience.
withBidModifier	AdsApp.SearchCampaignAudienceBuilder	Sets the bid modifier value for this audience to the specified value.

build()

Builds the audience. Returns a SearchCampaignAudienceOperation that corresponds to the addition of the SearchCampaignAudience.

Return values:

Type	Description
AdsApp.SearchCampaignAudienceOperation	The SearchCampaignAudienceOperation.

exclude()

Builds the excluded audience. Returns a SearchCampaignExcludedAudienceOperation that corresponds to the addition of the SearchCampaignExcludedAudience.

Return values:

Type	Description
AdsApp.SearchCampaignExcludedAudienceOperation	The SearchCampaignExcludedAudienceOperation.

withAudience(userList)

Sets the user list of the audience.

Arguments:

Name	Type	Description
userList	AdsApp.UserList	The user list of the audience.

Return values:

Type	Description
AdsApp.SearchCampaignAudienceBuilder	An audience builder with the specified user list.

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.SearchCampaignAudienceBuilder	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. Use of this method when adding an excluded audience is not supported.

Arguments:

Name	Type	Description
modifier	double	The bid modifier value.

Return values:

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