LibraryImageAdService provides operations for managing standard graphical ads created from image files.
addLibraryImageAd
Add an image ad.
Capability required: CreativeWrite
License command group: Creatives
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| libraryImageAd | LibraryImageAd | The image ad to add. | Req |
Response
LibraryImageAdResponse - The response, which indicates if the operation succeeded or failed, and the image ad.
addLibraryImageAds
Add a list of image ads.
Quota is charged for each object in the request.
Capability required: CreativeWrite
License command group: Creatives
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| libraryImageAds | LibraryImageAd[] | The list of image ads to add. | Req |
Response
LibraryImageAdResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of image ads.
deleteLibraryImageAd
Delete an image ad.
Capability required: CreativeWrite
License command group: Creatives
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| libraryImageAdID | long | The ID of the image ad to delete. | Req |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deleteLibraryImageAds
Delete a list of image ads.
Quota is charged for each object in the request.
Capability required: CreativeWrite
License command group: Creatives
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| libraryImageAdIDs | long[] | The IDs of the image ads to delete. | Req |
Response
BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.
getLibraryImageAd
Get an image Ad.
Capability required: CreativeRead
License command group: Creatives
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| libraryImageAdID | long | The ID of the image ad to retrieve. | Req |
Response
LibraryImageAd - The image ad.
getLibraryImageAdCountByAccountID
Get a count of the image ads for an account.
Capability required: CreativeRead
License command group: Creatives
Parameters
none
Response
long - A count of the image ads for the specified account.
getLibraryImageAds
Get a list of image ads.
Quota is charged for each object in the request.
Capability required: CreativeRead
License command group: Creatives
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| libraryImageAdIDs | long[] | The IDs of the image ads to retrieve. | Req |
Response
LibraryImageAd[] - The list of image ads.
getLibraryImageAdsByAccountID
Get all the image ads for an account.
Capability required: CreativeRead
License command group: Creatives
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| startElement | int | The first element to retrieve (0-based; if a value <= 0 is entered, it will default to 0). | Req |
| numElements | int | The number of elements to retrieve (1000 maximum; if a value <=0 is entered, it will default to 1000). | Req |
Response
LibraryImageAd[] - The list of image ads for the specified account.
getLibraryImageAdsByFolderID
Get the image ads in a folder.
Capability required: CreativeRead
License command group: Creatives
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| folderID | long | The ID of the ad folder. | Req |
Response
LibraryImageAd[] - The list of image ads in the specified ad folder.
updateLibraryImageAd
Update an image ad.
Capability required: CreativeWrite
License command group: Creatives
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| libraryImageAd | LibraryImageAd | The image ad to update. | Req |
Response
LibraryImageAdResponse - The response, which indicates if the operation succeeded or failed, and the image ad.
updateLibraryImageAds
Update a list of image ads.
Quota is charged for each object in the request.
Capability required: CreativeWrite
License command group: Creatives
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| libraryImageAds | LibraryImageAd[] | The list of image ads to update. | Req |
Response
LibraryImageAdResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of image ads.