CampaignAudienceBuilder

Contains the methods for defining and creating a campaign audience association. For information about builders, see Builders.

Example usage:

    // Gets the iterator that iterates all campaigns
    // in the account.
    var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get();

    // Loops through all campaigns in the account.
    while (iterator.hasNext()) {
        var campaign = iterator.next();

        // Get the campaign audience's builder.
        var operation = campaign.targeting().newUserListBuilder()
            .withAudienceId("AUDIENCE ID GOES HERE")
            .build();
    
        // See the Builders topic for performance considerations
        // when using the operation object's methods.
        if (!operation.isSuccessful()) {
            for (var error of operation.getErrors()) {
                Logger.log(`${error}\n`);
            }
        }
    }

Methods

build

Creates the campaign audience and returns an operation object used to check whether the campaign audience was successfully added.

Returns

exclude

Excludes the specified audience from this campaign and returns an operation object used to check whether the excluded campaign audience was successfully added.

Returns

withAudience(Object userList)

Sets the associated user list.

Arguments

withAudienceId(string audienceId)

Sets the associated audience's ID.

Arguments

withAudienceType(string audienceType)

Sets the associated audience's type.

Arguments

withBidModifier(double modifier)

Sets the association's bid modifier.

Arguments

Returns

Returns