FolderService provides operations for managing folders.

addFolder

Add a folder.

Capability required: CreativeWrite
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folder	Folder	The folder to add.	Req

Response

FolderResponse - The response, which indicates if the operation succeeded or failed, and the folder.

addFolders

Add a list of folders.

Quota is charged for each object in the request.

Capability required: CreativeWrite
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folders	Folder[]	The list of folders to add.	Req

Response

FolderResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of folders.

addZippedCreatives

Add zipped creatives.

Quota is charged for each object in the request.

Capability required: CreativeWrite
License command group: CreativeUpload

Parameters

Parameter	Data Type	Description	Restriction
folderID	long	The ID of the folder for the zipped creatives.	Req
binaryData	base64Binary	The zip file.	Req

Response

ZippedCreativesResponse - The response, which indicates if the operation succeeded or failed, and the list of creatives.

copyFolder

Copy a folder.

Capability required: CreativeWrite
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folderID	long	The ID of the folder to copy.	Req
destinationParentFolderID	long	The ID of the destination folder.	Req

Response

FolderResponse - The response, which indicates if the operation succeeded or failed, and the folder.

copyFolderContents

Copy the contents of a folder.

Capability required: CreativeWrite
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folderID	long	The ID of the folder.	Req
destinationFolderID	long	The ID of the destination folder.	Req

Response

EnhancedBasicResponse - The response, which indicates if the operation succeeded or failed.

deleteFolder

Delete a folder.

Capability required: CreativeWrite
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folderID	long	The ID of the folder to delete.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deleteFolders

Delete a list of folders.

Quota is charged for each object in the request.

Capability required: CreativeWrite
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folderIDs	long[]	The IDs of the folders to delete.	Req

Response

BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.

getFolder

Get a folder.

Capability required: CreativeRead
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folderID	long	The ID of the folder to retrieve.	Req

Response

Folder - The folder.

getFolderItemsByFolderID

Get all the items in a folder.

Capability required: CreativeRead
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folderID	long	The ID of the folder.	Req

Response

FolderItem[] - The list of items in the specified folder.

getFolders

Get a list of folders.

Quota is charged for each object in the request.

Capability required: CreativeRead
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folderIDs	long[]	The IDs of the folders to retrieve.	Req

Response

Folder[] - The list of folders.

getFoldersByParentID

Get all the folders under a folder.

Capability required: CreativeRead
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
parentFolderID	long	The ID of the parent folder.	Req

Response

Folder[] - The list of folders under the specified parent folder.

getRootFolder

Get the root folder.

Capability required: CreativeRead
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folderType	FolderType	The type of folder to retrieve.	Req

Response

Folder - The folder.

moveFolder

Move a folder.

Capability required: CreativeWrite
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folderID	long	The ID of the folder to move.	Req
destinationParentFolderID	long	The ID of the destination folder.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed, and the folder.

moveFolderContents

Move the contents of a folder.

Capability required: CreativeWrite
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folderID	long	The ID of the folder.	Req
destinationFolderID	long	The ID of the destination folder.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

updateFolder

Update a folder.

Capability required: CreativeWrite
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folder	Folder	The folder to update.	Req

Response

FolderResponse - The response, which indicates if the operation succeeded or failed, and the folder.

updateFolders

Update a list of folders.

Quota is charged for each object in the request.

Capability required: CreativeWrite
License command group: Creatives

Parameters

Parameter	Data Type	Description	Restriction
folders	Folder[]	The list of folders to update.	Req

Response

FolderResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of folders.