AdsApp.​ImageBuilder

Builder for an image under construction.

Typical usage:

var imageUrl = "http://www.example.com/example.png";
var imageBlob = UrlFetchApp.fetch(imageUrl).getBlob();
// Set the content type to be supported by Ads Scripts
imageBlob.setContentType("IMAGE_PNG");
var mediaOperation = AdsApp.adMedia().newImageBuilder()
   .withName("name")
   .withData(imageBlob)
   .build();
var image = mediaOperation.getResult();

Note that it is only necessary to call MediaOperation.getResult() if you need to access the new media item for further processing (for instance, to reate an ad). Otherwise, calling ImageBuilder.build() is sufficient to ensure that the ad is created.

Methods:

MemberTypeDescription
buildAdsApp.MediaOperationCreates an image.
withDataAdsApp.ImageBuilderSets new image's data to the specified value.
withNameAdsApp.ImageBuilderSets new image's name to the specified value.

build()

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

Return values:

TypeDescription
AdsApp.MediaOperationThe media operation.

withData(data)

Sets new image's data to the specified value. This field is required.

Arguments:

NameTypeDescription
dataBlob.BlobThe data for the image.

Return values:

TypeDescription
AdsApp.ImageBuilderThe image builder with the specified data.

withName(name)

Sets new image's name to the specified value. This field is required.

Arguments:

NameTypeDescription
nameStringThe name for the image.

Return values:

TypeDescription
AdsApp.ImageBuilderThe image builder with the specified name.