clearFinalUrlSuffix()

Clears the final URL suffix of the campaign.

Returns nothing.

clearTrackingTemplate()

Clears the tracking template of the campaign.

If you clear the tracking template specified at a lower level entity (e.g. a keyword), and
you have also specified tracking template on a higher level entity, (e.g. the parent ad group),
then Google Ads will use the tracking template specified at the higher level entity (i.e. the
ad group level tracking template will be used). To completely clear tracking template, it must
be cleared at all levels of the hierarchy at which it was set.

getCustomParameters()

Returns the custom parameters of the campaign.

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.

Return values:

The custom parameters of the campaign as a map of the following form:
{key1: 'value1', key2: 'value2', key3: 'value3'}.

getFinalUrlSuffix()

Returns the final URL suffix of the campaign.

When parallel tracking is
enabled, the final URL suffix gets appended to the final URL.

Return values:

Type

Description

String

The final URL suffix of the campaign.

getTrackingTemplate()

Returns the tracking template of the campaign.

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 at the ad group level overrides the setting at
the campaign level.

Return values:

setCustomParameters(customParameters)

Sets the custom parameters of the campaign.

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.

Note that this method will replace any existing custom parameters with the specified value.

You may pass an empty object, e.g. setCustomParameters({}) to clear the custom
parameters of the campaign. If you clear the custom parameters specified at a
lower level entity (e.g. a keyword), and you have also specified custom parameters on a higher
level entity, (e.g. the parent ad group), then Google Ads will use the custom parameters
specified at the higher level entity (i.e. the ad-group-level custom parameters will be used).
To completely clear custom parameters, it must be cleared at all levels of the hierarchy at
which it was set.

Arguments:

The custom parameters of the campaign as a map of the
form {key1: 'value1', key2: 'value2', key3: 'value3'}.

setFinalUrlSuffix(suffix)

Sets the final URL suffix of the campaign.

When parallel tracking is
enabled, the final URL suffix gets appended to the final URL.

Returns nothing.

Arguments:

Name

Type

Description

suffix

String

The new final URL suffix.

setTrackingTemplate(trackingTemplate)

Sets the tracking template of the campaign.

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 at the ad group level overrides the setting at
the campaign level.