AdWordsApp.​AdOperation

An operation representing creation of a new ad. Calling any method (getErrors, getResult, or isSuccessful) will cause the operation to execute and create the ad. 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 ads in an efficient manner:

 // For the purpose of this example, suppose that the fetchAdText() function
 // fetches text ad data from your data source of choice, so that
 // adsToCreate is an array where each element is an object describing an ad.
 var adgroup = AdWordsApp.adGroups().get().next();
 var adsToCreate = fetchAdText();
 var adOps = [];
 for (var i = 0; i < adsToCreate.length; i++) {
     adOps.push(
         adGroup.newAd().expandedTextAdBuilder()
             .withHeadlinePart1(adsToCreate[i].headlinePart1)
             .withHeadlinePart2(adsToCreate[i].headlinePart2)
             .withDescription(adsToCreate[i].description)
             .withPath1(adsToCreate[i].path1)
             .withPath2(adsToCreate[i].path2)
             .withFinalUrl(adsToCreate[i].finalUrl)
             .build());
 }
 for (var i = 0; i < adOps.length; i++) {
   if (adOps[i].isSuccessful()) {
     adOps[i].getResult().applyLabel('myLabel');
   } else {
     Logger.log('Errors from Ad [' + adsToCreate[i].headline + ']: '
         + adOps[i].getErrors());
   }
 }

Methods:

MemberTypeDescription
getErrors String[] Returns an empty array if the operation was successful, otherwise returns the list of errors encountered when trying to create the Ad.
getResult AdWordsApp.Ad Returns the newly created Ad, 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 Ad.

Return values:

TypeDescription
String[] The errors that occurred during the AdOperation.

getResult()

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

Return values:

TypeDescription
AdWordsApp.Ad The Ad created by the AdOperation.

isSuccessful()

Returns true if the operation was successful.

Return values:

TypeDescription
boolean true if the operation was successful.

Send feedback about...

AdWords Scripts
AdWords Scripts
Need help? Visit our support page.