AdsApp.AdParam
Stay organized with collections
Save and categorize content based on your preferences.
Represents a Google Ads ad param. Methods:
getAdGroup()
Returns the ad group to which this ad param belongs. Return values:
getBaseAdGroup()
Returns the base ad group to which this ad param belongs. Return values:
getEntityType()
Returns the type of this entity as a String
, in this case, "AdParam"
. Return values:
getIndex()
Returns the index of the ad param. Return values:
getInsertionText()
Returns the insertion text of the ad param. Return values:
getKeyword()
Returns the Keyword
the ad param belongs
to. Return values:
remove()
Removes the ad param. Returns nothing.
setInsertionText(insertionText)
Sets the insertion text of the ad param to the specified value. Returns nothing.
Arguments:
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eRepresents a Google Ads ad parameter and provides methods for managing it.\u003c/p\u003e\n"],["\u003cp\u003eAllows retrieval of information like the ad group, base ad group, index, and insertion text associated with the ad parameter.\u003c/p\u003e\n"],["\u003cp\u003eEnables modification of the ad parameter's insertion text and removal of the parameter itself.\u003c/p\u003e\n"],["\u003cp\u003ePrimarily interacts with AdsApp.AdGroup and AdsApp.Keyword objects for context and management.\u003c/p\u003e\n"]]],[],null,["# AdsApp.AdParam\n\nRepresents a Google Ads ad param.\n\n### Methods:\n\n| Member | Type | Description |\n|--------------------------------------------------------------------|----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|\n| [getAdGroup()](#getAdGroup) | [AdsApp.AdGroup](/google-ads/scripts/docs/reference/adsapp/adsapp_adgroup) | Returns the ad group to which this ad param belongs. |\n| [getBaseAdGroup()](#getBaseAdGroup) | [AdsApp.AdGroup](/google-ads/scripts/docs/reference/adsapp/adsapp_adgroup) | Returns the base ad group to which this ad param belongs. |\n| [getEntityType()](#getEntityType) | `String` | Returns the type of this entity as a `String`, in this case, `\"AdParam\"`. |\n| [getIndex()](#getIndex) | `int` | Returns the index of the ad param. |\n| [getInsertionText()](#getInsertionText) | `String` | Returns the insertion text of the ad param. |\n| [getKeyword()](#getKeyword) | [AdsApp.Keyword](/google-ads/scripts/docs/reference/adsapp/adsapp_keyword) | Returns the [Keyword](/google-ads/scripts/docs/reference/adsapp/adsapp_keyword) the ad param belongs to. |\n| [remove()](#remove) | `void` | Removes the ad param. |\n| [setInsertionText(insertionText)](#setInsertionText_insertionText) | `void` | Sets the insertion text of the ad param to the specified value. |\n\n`getAdGroup()`\n--------------\n\nReturns the ad group to which this ad param belongs.\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------|----------------------------------------------|\n| [AdsApp.AdGroup](/google-ads/scripts/docs/reference/adsapp/adsapp_adgroup) | The ad group to which this ad param belongs. |\n\n`getBaseAdGroup()`\n------------------\n\nReturns the base ad group to which this ad param belongs.\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------|---------------------------------------------------|\n| [AdsApp.AdGroup](/google-ads/scripts/docs/reference/adsapp/adsapp_adgroup) | The base ad group to which this ad param belongs. |\n\n`getEntityType()`\n-----------------\n\nReturns the type of this entity as a `String`, in this case, `\"AdParam\"`.\n\n### Return values:\n\n| Type | Description |\n|----------|-----------------------------------|\n| `String` | Type of this entity: `\"AdParam\"`. |\n\n`getIndex()`\n------------\n\nReturns the index of the ad param.\n\n### Return values:\n\n| Type | Description |\n|-------|----------------------------|\n| `int` | The index of the ad param. |\n\n`getInsertionText()`\n--------------------\n\nReturns the insertion text of the ad param.\n\n### Return values:\n\n| Type | Description |\n|----------|-------------------------------------|\n| `String` | The insertion text of the ad param. |\n\n`getKeyword()`\n--------------\n\nReturns the [Keyword](/google-ads/scripts/docs/reference/adsapp/adsapp_keyword) the ad param belongs to.\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|\n| [AdsApp.Keyword](/google-ads/scripts/docs/reference/adsapp/adsapp_keyword) | The [Keyword](/google-ads/scripts/docs/reference/adsapp/adsapp_keyword) the ad param belongs to. |\n\n`remove()`\n----------\n\nRemoves the ad param.\n\nReturns nothing.\n\n`setInsertionText(insertionText)`\n---------------------------------\n\nSets the insertion text of the ad param to the specified value.\n\nReturns nothing.\n\n### Arguments:\n\n| Name | Type | Description |\n|---------------|----------|-----------------|\n| insertionText | `String` | Insertion text. |"]]
