AdsApp.KeywordOperation
Stay organized with collections
Save and categorize content based on your preferences.
An operation representing creation of a new keyword. Calling any
method
(
getErrors,
getResult, or
isSuccessful)
will cause the operation to execute and create the keyword. To
make the script more efficient, it's recommended that you store the
operations in an array and only call these methods once you've constructed
all the operations you want.
For instance, this is how you would assign a label to newly created
keywords in an efficient manner:
// For the purpose of this example, suppose that the fetchKeywords()
// function fetches keyword data from your data source of choice, so that
// keywordsToCreate is an array of strings, where each string is the text
// for a keyword.
var adGroup = AdsApp.adGroups().get().next();
var keywordsToCreate = fetchKeywords();
var keywordOps = [];
for (var i = 0; i < keywordsToCreate.length; i++) {
keywordOps.push(
adGroup.newKeywordBuilder().withText(keywordsToCreate[i]).build());
}
for (var i = 0; i < keywordOps.length; i++) {
if (keywordOps[i].isSuccessful()) {
keywordOps[i].getResult().applyLabel('myLabel');
} else {
Logger.log('Errors from Keyword [' + keywordsToCreate[i] + ']: '
+ keywordOps[i].getErrors());
}
}
Methods:
Member | Type | Description |
getErrors() |
String[] |
Returns an empty array if the operation was successful, otherwise returns
the list of errors encountered when trying to create the Keyword. |
getResult() |
AdsApp.Keyword |
Returns the newly created Keyword, or null if
the operation was unsuccessful. |
isSuccessful() |
boolean |
Returns true if the operation was successful. |
getErrors()
Returns an empty array if the operation was successful, otherwise returns
the list of errors encountered when trying to create the Keyword.
Return values:
getResult()
Returns the newly created Keyword, or
null
if
the operation was unsuccessful.
Return values:
isSuccessful()
Returns
true
if the operation was successful.
Return values:
Type | Description |
boolean |
true if the operation was successful. |
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-08-25 UTC.
[null,null,["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eKeywordOperation represents the creation of a new keyword and executes upon calling \u003ccode\u003egetErrors\u003c/code\u003e, \u003ccode\u003egetResult\u003c/code\u003e, or \u003ccode\u003eisSuccessful\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eFor efficiency, store KeywordOperations in an array and execute methods after constructing all desired operations.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eisSuccessful\u003c/code\u003e indicates operation success, \u003ccode\u003egetResult\u003c/code\u003e returns the new Keyword or null, and \u003ccode\u003egetErrors\u003c/code\u003e provides error details if unsuccessful.\u003c/p\u003e\n"]]],[],null,["# AdsApp.KeywordOperation\n\nAn operation representing creation of a new keyword. Calling any method ([getErrors](/google-ads/scripts/docs/reference/adsapp/adsapp_keywordoperation#getErrors), [getResult](/google-ads/scripts/docs/reference/adsapp/adsapp_keywordoperation#getResult), or [isSuccessful](/google-ads/scripts/docs/reference/adsapp/adsapp_keywordoperation#isSuccessful)) will cause the operation to execute and create the keyword. To make the script more efficient, it's recommended that you store the operations in an array and only call these methods once you've constructed all the operations you want.\n\nFor instance, this is how you would assign a label to newly created\nkeywords in an efficient manner:\n\n```transact-sql\n// For the purpose of this example, suppose that the fetchKeywords()\n// function fetches keyword data from your data source of choice, so that\n// keywordsToCreate is an array of strings, where each string is the text\n// for a keyword.\nvar adGroup = AdsApp.adGroups().get().next();\nvar keywordsToCreate = fetchKeywords();\nvar keywordOps = [];\nfor (var i = 0; i \u003c keywordsToCreate.length; i++) {\n keywordOps.push(\n adGroup.newKeywordBuilder().withText(keywordsToCreate[i]).build());\n}\nfor (var i = 0; i \u003c keywordOps.length; i++) {\n if (keywordOps[i].isSuccessful()) {\n keywordOps[i].getResult().applyLabel('myLabel');\n } else {\n Logger.log('Errors from Keyword [' + keywordsToCreate[i] + ']: '\n + keywordOps[i].getErrors());\n }\n}\n```\n\n### Methods:\n\n| Member | Type | Description |\n|---------------------------------|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| [getErrors()](#getErrors) | `String[]` | Returns an empty array if the operation was successful, otherwise returns the list of errors encountered when trying to create the Keyword. |\n| [getResult()](#getResult) | [AdsApp.Keyword](/google-ads/scripts/docs/reference/adsapp/adsapp_keyword) | Returns the newly created Keyword, or `null` if the operation was unsuccessful. |\n| [isSuccessful()](#isSuccessful) | `boolean` | Returns `true` if the operation was successful. |\n\n`getErrors()`\n-------------\n\nReturns an empty array if the operation was successful, otherwise returns the list of errors encountered when trying to create the Keyword.\n\n### Return values:\n\n| Type | Description |\n|------------|----------------------------------------------------------------------------------------------------------------------------|\n| `String[]` | The errors that occurred during the [KeywordOperation](/google-ads/scripts/docs/reference/adsapp/adsapp_keywordoperation). |\n\n`getResult()`\n-------------\n\nReturns the newly created Keyword, or `null` if the operation was unsuccessful.\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) created by the KeywordOperation. |\n\n`isSuccessful()`\n----------------\n\nReturns `true` if the operation was successful.\n\n### Return values:\n\n| Type | Description |\n|-----------|-----------------------------------------|\n| `boolean` | `true` if the operation was successful. |"]]