AdWordsApp.​AudienceBuilder

Builder for Audience objects.

Example usage:

 var audienceBuilder = adGroup.display().newAudienceBuilder();
 var audience = audienceBuilder
   .withAudienceType('USER_LIST')  // required
   .withAudienceId(3)              // required
   .withCpc(0.50)                  // optional
   .build()                        // create the audience

Methods:

MemberTypeDescription
build AdWordsApp.AudienceOperation Builds the audience.
exclude AdWordsApp.ExcludedAudienceOperation Builds the excluded audience.
withAudience AdWordsApp.AudienceBuilder Sets the user list of the audience.
withAudienceId AdWordsApp.AudienceBuilder Sets the audience ID of the audience.
withAudienceType AdWordsApp.AudienceBuilder Sets the type of the audience, either USER_INTEREST or USER_LIST.
withCpc AdWordsApp.AudienceBuilder Sets the max CPC bid of the new audience to the specified value.
withCpm AdWordsApp.AudienceBuilder Sets the CPM bid of the new audience to the specified value.

build()

Builds the audience. Returns a AudienceOperation that corresponds to the creation of the Audience.

Return values:

TypeDescription
AdWordsApp.AudienceOperation The AudienceOperation.

exclude()

Builds the excluded audience. Returns an ExcludedAudienceOperation that corresponds to the creation of the ExcludedAudience.

Return values:

TypeDescription
AdWordsApp.ExcludedAudienceOperation The ExcludedAudienceOperation.

withAudience(userList)

Sets the user list of the audience.

Arguments:

NameTypeDescription
userList AdWordsApp.UserList The user list of the audience.

Return values:

TypeDescription
AdWordsApp.AudienceBuilder 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:

NameTypeDescription
audienceId Long The audience ID of the audience.

Return values:

TypeDescription
AdWordsApp.AudienceBuilder An audience builder with the specified audience ID.

withAudienceType(audienceType)

Sets the type of the audience, either USER_INTEREST or USER_LIST. This field is required.

Arguments:

NameTypeDescription
audienceType String The type of the audience.

Return values:

TypeDescription
AdWordsApp.AudienceBuilder An AudienceBuilder with the specified audience type.

withCpc(cpc)

Sets the max CPC bid of the new audience to the specified value.

Arguments:

NameTypeDescription
cpc double The max CPC bid of the audience.

Return values:

TypeDescription
AdWordsApp.AudienceBuilder The audience builder with the specified max CPC.

withCpm(cpm)

Sets the CPM bid of the new audience to the specified value.

See Cost-per-thousand impressions (CPM) for more information.

Arguments:

NameTypeDescription
cpm double The CPM bid of the audience.

Return values:

TypeDescription
AdWordsApp.AudienceBuilder The audience builder with the specified CPM.

Send feedback about...

AdWords Scripts
AdWords Scripts
Need help? Visit our support page.