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:

Member	Type	Description
build	AdsApp.MediaOperation	Creates an image.
withData	AdsApp.ImageBuilder	Sets new image's data to the specified value.
withName	AdsApp.ImageBuilder	Sets 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:

Type	Description
AdsApp.MediaOperation	The media operation.

withData(data)

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

Note: The content type of image data should be one of the available content types in Google Ads API.

Arguments:

Name	Type	Description
data	Blob.Blob	The data for the image.

Return values:

Type	Description
AdsApp.ImageBuilder	The image builder with the specified data.

withName(name)

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

Arguments:

Name	Type	Description
name	String	The name for the image.

Return values:

Type	Description
AdsApp.ImageBuilder	The image builder with the specified name.