AdsApp.​TopicBuilder

Page Summary

• TopicBuilder is used to create Topic objects.

• You can set the topic ID, CPC bid, and CPM bid when building a topic.

• The build() method creates a TopicOperation, while the exclude() method creates an ExcludedTopicOperation.

• The topic ID is a required field when building a topic and identifies the topic category.

Builder for Topic objects.

Example usage:

var topicBuilder = adGroup.display().newTopicBuilder();
var topic = topicBuilder
  .withTopicId(3)                 // required
  .withCpc(0.50)                  // optional
  .build()                        // create the topic

Methods:

Member	Type	Description
build()	AdsApp.TopicOperation	Builds the topic.
exclude()	AdsApp.ExcludedTopicOperation	Builds the excluded topic.
withCpc(cpc)	AdsApp.TopicBuilder	Sets the max CPC bid of the new topic to the specified value.
withCpm(cpm)	AdsApp.TopicBuilder	Sets the CPM bid of the new topic to the specified value.
withTopicId(topicId)	AdsApp.TopicBuilder	Sets the topic ID of the topic.

build()

Builds the topic. Returns a TopicOperation that corresponds to the creation of the Topic.

Return values:

Type	Description
AdsApp.TopicOperation	The TopicOperation.

exclude()

Builds the excluded topic. Returns an ExcludedTopicOperation that corresponds to the creation of the ExcludedTopic.

Return values:

Type	Description
AdsApp.ExcludedTopicOperation	The ExcludedTopicOperation.

withCpc(cpc)

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

Arguments:

Name	Type	Description
cpc	double	The max CPC bid of the topic.

Return values:

Type	Description
AdsApp.TopicBuilder	The topic builder with the specified max CPC.

withCpm(cpm)

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

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

Arguments:

Name	Type	Description
cpm	double	The CPM bid of the topic.

Return values:

Type	Description
AdsApp.TopicBuilder	The topic builder with the specified CPM.

withTopicId(topicId)

Sets the topic ID of the topic. This field is required. The topic ID identifies the topic category. A list of valid topic IDs is available on our Verticals page.

Arguments:

Name	Type	Description
topicId	String	The topic ID of the topic.

Return values:

Type	Description
AdsApp.TopicBuilder	A TopicBuilder with the specified topic ID.