AdWordsApp.​AdGroupBuilder

Builder for an ad group under construction.

Typical usage:

 var adGroupBuilder = campaign.newAdGroupBuilder();
 var adGroupOperation = adGroupBuilder
    .withName("ad group name")
    .withStatus("PAUSED")
    .build();
 var adGroup = adGroupOperation.getResult();

Methods:

MemberTypeDescription
build AdWordsApp.AdGroupOperation Creates an AdGroup.
withBiddingStrategy AdWordsApp.AdGroupBuilder Sets the bidding strategy of the new ad group to the specified standard bidding strategy.
withBiddingStrategy AdWordsApp.AdGroupBuilder Sets the bidding strategy of the new ad group to the specified value.
withCpa AdWordsApp.AdGroupBuilder Sets the max CPA bid of the new ad group to the specified value.
withCpc AdWordsApp.AdGroupBuilder Sets the max CPC bid of the new ad group to the specified value.
withCpm AdWordsApp.AdGroupBuilder Sets the CPM bid of the new ad group to the specified value.
withCustomParameters AdWordsApp.AdGroupBuilder Sets the custom parameters of the new ad group to the specified value.
withName AdWordsApp.AdGroupBuilder Sets the name of the new ad group to the specified value.
withStatus AdWordsApp.AdGroupBuilder Sets the status of the new ad group to the specified value.
withTrackingTemplate AdWordsApp.AdGroupBuilder Sets the tracking template of the new ad group to the specified value.

build()

Creates an AdGroup. Returns an AdGroupOperation that can be used to get the new ad group (or access any associated errors if creation failed).

Return values:

TypeDescription
AdWordsApp.AdGroupOperation The associated ad group operation.

withBiddingStrategy(biddingStrategy)

Sets the bidding strategy of the new ad group to the specified standard bidding strategy.

The AdWords API bidding guide contains a list of all valid standard bidding strategies. Note that specifying portfolio strategies will result in error.

Arguments:

NameTypeDescription
biddingStrategy String The standard bidding strategy of the ad group.

Return values:

TypeDescription
AdWordsApp.AdGroupBuilder The ad group builder with the specified bidding strategy.

withBiddingStrategy(biddingStrategy)

Sets the bidding strategy of the new ad group to the specified value.

Arguments:

NameTypeDescription
biddingStrategy AdWordsApp.BiddingStrategy The portfolio bidding strategy of the ad group.

Return values:

TypeDescription
AdWordsApp.AdGroupBuilder The ad group builder with the specified bidding strategy.

withCpa(cpa)

Sets the max CPA bid of the new ad group to the specified value.

If the bid is not set, the ad group will assume a default max CPA bid of $0.01.

Arguments:

NameTypeDescription
cpa double The max CPA bid of the ad group.

Return values:

TypeDescription
AdWordsApp.AdGroupBuilder The ad group builder with the specified max CPA.

withCpc(cpc)

Sets the max CPC bid of the new ad group to the specified value.

If the bid is not set, the ad group will assume a default max CPC bid of $0.01.

Arguments:

NameTypeDescription
cpc double The max CPC bid of the ad group.

Return values:

TypeDescription
AdWordsApp.AdGroupBuilder The ad group builder with the specified max CPC.

withCpm(cpm)

Sets the CPM bid of the new ad group to the specified value.

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

If the bid is not set, the ad group will assume a default CPM bid of $0.25.

Arguments:

NameTypeDescription
cpm double The CPM bid of the ad group.

Return values:

TypeDescription
AdWordsApp.AdGroupBuilder The ad group builder with the specified CPM.

withCustomParameters(customParameters)

Sets the custom parameters of the new ad group to the specified value.

Custom parameters enable you to create your own ValueTrack parameters that you can assign your own IDs to.

The name of a custom parameter can contain only alphanumeric characters, and custom parameter values may not contain white space. When referring to the custom parameter in final URLs and tracking template, you should surround the custom parameter in braces, and prefix an underscore to its name, e.g. {_param}.

You can have up to 3 custom parameters for an entity. The key and value must not exceed 16 and 200 bytes respectively.

Custom parameters specified at a lower level entity will override the setting specified at a higher level entity, e.g., setting custom parameters at the ad group level overrides the setting at the campaign level, and and custom parameters specified at the ad level override the setting at the ad group level.

See Using Upgraded URLs for more information.

Arguments:

NameTypeDescription
customParameters Object The custom parameters of the ad group as a map of the following form: {key1: 'value1', key2: 'value2', key3: 'value3'}.

Return values:

TypeDescription
AdWordsApp.AdGroupBuilder The ad group builder with the specified custom parameters.

withName(name)

Sets the name of the new ad group to the specified value. If ad group name is not set, the ad group will assume a default name ('Ad Group #5').

Arguments:

NameTypeDescription
name String Ad group name.

Return values:

TypeDescription
AdWordsApp.AdGroupBuilder Ad group builder with the specified name.

withStatus(status)

Sets the status of the new ad group to the specified value. If the status is not set, it will default to ENABLED.

Arguments:

NameTypeDescription
status String Ad group status.

Return values:

TypeDescription
AdWordsApp.AdGroupBuilder Ad group builder with the specified status.

withTrackingTemplate(trackingTemplate)

Sets the tracking template of the new ad group to the specified value.

You can optionally use the tracking template to specify additional tracking parameters or redirects. AdWords will use this template to assemble the actual destination URL to associate with the ad.

A tracking template specified at a lower level entity will override the setting specified at a higher level entity, e.g., a tracking template set at the ad group level overrides the setting at the campaign level, and a tracking template specified at the ad level overrides the setting at the ad group level.

See Using Upgraded URLs for more information.

Arguments:

NameTypeDescription
trackingTemplate String The tracking template for the ad group.

Return values:

TypeDescription
AdWordsApp.AdGroupBuilder The ad group builder with the specified tracking template.

Send feedback about...

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