AdsApp.​VideoAudienceBuilder

Page Summary

• The VideoAudienceBuilder is used to create VideoAudience objects for video campaigns.

• You can build a video audience using withAudienceType and withAudienceId, followed by build().

• The exclude() method allows you to build an audience to be excluded from targeting.

• Required fields for building a video audience include both the audience type and audience ID.

Builder for VideoAudience objects. For details about video audiences, please see About targeting for video campaigns.

Example usage:

var videoAudienceBuilder = videoAdGroup
  .videoTargeting()
  .newAudienceBuilder();
var videoAudienceOperation = videoAudienceBuilder
  .withAudienceType('USER_INTEREST')   // required
  .withAudienceId(80432)               // required
  .build();                            // create the audience

Methods:

Member	Type	Description
build()	AdsApp.VideoAudienceOperation	Builds the video audience.
exclude()	AdsApp.ExcludedVideoAudienceOperation	Builds the excluded video audience.
withAudienceId(audienceId)	AdsApp.VideoAudienceBuilder	Sets the ID of the excluded audience.
withAudienceType(audienceType)	AdsApp.VideoAudienceBuilder	Sets the type of the audience.

build()

Builds the video audience. Returns a VideoAudienceOperation that corresponds to the creation of the VideoAudience.

Return values:

Type	Description
AdsApp.VideoAudienceOperation	The VideoAudienceOperation.

exclude()

Builds the excluded video audience. Returns an ExcludedVideoAudienceOperation that corresponds to the creation of the ExcludedVideoAudience.

Custom affinities cannot be excluded.

Return values:

Type	Description
AdsApp.ExcludedVideoAudienceOperation	The ExcludedVideoAudienceOperation.

withAudienceId(audienceId)

Sets the ID of the excluded audience. This field is required. For user interests, affinity categories and corresponding IDs can be found on API documentation on affinity categories, and in-market categories and corresponding IDs can be found on API documentation on in-market categories. 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 ID of the excluded audience.

Return values:

Type	Description
AdsApp.VideoAudienceBuilder	An audience builder with the specified audience ID.

withAudienceType(audienceType)

Sets the type of the audience. Possible values: USER_INTEREST, USER_LIST or CUSTOM_AFFINITY. This field is required.

Arguments:

Name	Type	Description
audienceType	String	The type of the excluded audience.

Return values:

Type	Description
AdsApp.VideoAudienceBuilder	An VideoAudienceBuilder with the specified audience type.