AdsApp.​KeywordOperation

AI-generated Key Takeaways

• KeywordOperation represents the creation of a new keyword and executes upon calling getErrors, getResult, or isSuccessful.

• For efficiency, store KeywordOperations in an array and execute methods after constructing all desired operations.

• isSuccessful indicates operation success, getResult returns the new Keyword or null, and getErrors provides error details if unsuccessful.

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:

Type	Description
String[]	The errors that occurred during the KeywordOperation .

getResult()

Returns the newly created Keyword, or null if the operation was unsuccessful.

Return values:

Type	Description
AdsApp.Keyword	The Keyword created by the KeywordOperation.

isSuccessful()

Returns true if the operation was successful.

Return values:

Type	Description
boolean	true if the operation was successful.