Methods:
| Member | Type | Description |
|---|---|---|
| getCustomParameters | Object |
Returns the custom parameters of the ad. |
| getFinalUrl | String |
Returns the final URL of the ad or null if
there is no final URL. |
| getFinalUrlSuffix | String |
Returns the final URL suffix of the ad. |
| getMobileFinalUrl | String |
Returns the mobile final URL of the ad or
null if there is no mobile final URL. |
| getTrackingTemplate | String |
Returns the tracking template of the ad. |
getCustomParameters()
Returns the custom parameters of the ad.
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.
See Using Upgraded URLs for more information.
Return values:
| Type | Description |
|---|---|
Object |
The custom parameters of the ad as a map of the
following form: {key1: 'value1', key2: 'value2', key3:
'value3'}. |
getFinalUrl()
Returns the final URL of the ad or null if
there is no final URL.
The final URL represents the actual landing page for your ad. The final URL must be the URL of the page that the user ends up on after clicking on your ad, once all the redirects have taken place.
Final URLs follow the same override rules as destination URLs. For example, a final URL at the keyword level overrides a final URL at an ad level.
See Using Upgraded URLs for more information.
Return values:
| Type | Description |
|---|---|
String |
The final URL of the ad. |
getFinalUrlSuffix()
Returns the final URL suffix of the ad.
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 ad. |
getMobileFinalUrl()
Returns the mobile final URL of the ad or
null if there is no mobile final URL.
The mobile final URL represents the actual landing page for your ad on a mobile device. The final mobile URL must be the URL of the page that the user ends up on after clicking on your ad on a mobile device, once all the redirects have taken place.
Mobile final URLs follow the same override rules as destination URLs. For example, a mobile final URL at the keyword level overrides a mobile final URL at an ad level.
See Using Upgraded URLs for more information.
Return values:
| Type | Description |
|---|---|
String |
The mobile final URL of the ad. |
getTrackingTemplate()
Returns the tracking template of the ad.
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.
See Using Upgraded URLs for more information.
Return values:
| Type | Description |
|---|---|
String |
The tracking template of the ad. |