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:
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:
withCpa(cpa)
Sets the Target CPA bid of the new ad group to the specified
value.
If the bid is not set, the ad group will assume a default Target CPA bid
of $0.01.
Arguments:
| Name | Type | Description |
|---|
| cpa |
double |
The Target CPA bid of the ad group. |
Return values:
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:
| Name | Type | Description |
|---|
| cpc |
double |
The max CPC bid of the ad group. |
Return values:
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:
| Name | Type | Description |
|---|
| cpm |
double |
The CPM bid of the ad group. |
Return values:
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 8 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
custom parameters specified at the ad level override the setting at the ad
group level.
See Using
Upgraded URLs for more information.
Arguments:
| Name | Type | Description |
|---|
| customParameters |
Object |
The custom parameters of the ad group as
a map of the following form: {key1: 'value1', key2: 'value2',
key3: 'value3'}. |
Return values:
withFinalUrlSuffix(suffix)
Sets the final URL suffix of the new ad group to the specified
value.
When parallel
tracking is enabled, the final URL suffix gets appended to the final
URL.
Arguments:
| Name | Type | Description |
|---|
| suffix |
String |
The final URL suffix to set on the ad group. |
Return values:
withName(name)
Sets the name of the new ad group to the specified value. Creation will
fail if a name is not specified.
Arguments:
| Name | Type | Description |
|---|
| name |
String |
Ad group name. |
Return values:
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:
| Name | Type | Description |
|---|
| status |
String |
Ad group status. |
Return values:
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. Google Ads 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:
| Name | Type | Description |
|---|
| trackingTemplate |
String |
The tracking template for the ad group. |
Return values:
