AdsApp.​SnippetOperation

  • A SnippetOperation represents the creation of a new snippet and executes when you call getErrors, getResult, or isSuccessful.

  • For efficiency, it is recommended to store multiple operations in an array and execute them together by calling one of the execution methods.

  • The getErrors method returns a list of errors if the operation failed or an empty array if successful.

  • The getResult method returns the newly created snippet if successful, or null if unsuccessful.

  • The isSuccessful method returns true if the operation completed without errors.

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

Operation interface to structured snippet extension.

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 Snippet.
getResult() AdsApp.Snippet Returns the newly created Snippet, 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 Snippet.

Return values:

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

getResult()

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

Return values:

TypeDescription
AdsApp.Snippet The Snippet created by the SnippetOperation.

isSuccessful()

Returns true if the operation was successful.

Return values:

TypeDescription
boolean true if the operation was successful.