AdsApp.​DraftBuilder

  • Enables the creation and management of drafts for Google Ads campaigns.

  • Requires setting a draft name using withName() before building.

  • Provides a build() method to create the draft and returns a DraftOperation for accessing the result or any errors.

  • DraftOperation can be examined using isSuccessful() to determine if the operation succeeded and to retrieve the draft or errors.

 Builder for Draft objects.

Example usage: 

// Create a draft builder.
var draftBuilder = AdsApp.campaigns().get().next().newDraftBuilder();

// Create a draft operation.
var draftOperation = draftBuilder
  .withName("Sample Draft")                // required
  .build();

// Optional: examine the outcome. The call to isSuccessful()
// will block until the operation completes.
if (draftOperation.isSuccessful()) {
  // Get the result.
  var draft = draftOperation.getResult();
} else {
  // Handle the errors.
  var errors = draftOperation.getErrors();
}

Methods:

MemberTypeDescription
build() AdsApp.DraftOperation Creates a Draft.
withName(name) AdsApp.DraftBuilder Sets the name of the new draft to the specified value.

build()

Creates a Draft. Returns a DraftOperation that can be used to get the new Draft (or access any associated errors if creation failed).

Return values:

TypeDescription
AdsApp.DraftOperation The associated Draft operation.

withName(name)

Sets the name of the new draft to the specified value. Required before building.

Arguments:

NameTypeDescription
name String Draft name.

Return values:

TypeDescription
AdsApp.DraftBuilder Draft builder with the specified name.