com.google.api.ads.admanager.axis.v202008

Interface CmsMetadataServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

CmsMetadataServiceSoapBindingStub

public interface CmsMetadataServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
CmsMetadataKeyPage	getCmsMetadataKeysByStatement(Statement statement) Returns a page of CmsMetadataKeys matching the specified Statement.
CmsMetadataValuePage	getCmsMetadataValuesByStatement(Statement statement) Returns a page of CmsMetadataValues matching the specified Statement.
UpdateResult	performCmsMetadataKeyAction(CmsMetadataKeyAction keyAction, Statement filterStatement) Performs actions on CmsMetadataKey objects that match the given Statement.query.
UpdateResult	performCmsMetadataValueAction(CmsMetadataValueAction valueAction, Statement filterStatement) Performs actions on CmsMetadataValue objects that match the given Statement.query.

Method Detail

getCmsMetadataKeysByStatement

CmsMetadataKeyPage getCmsMetadataKeysByStatement(Statement statement)
                                          throws RemoteException,
                                                 ApiException

Returns a page of CmsMetadataKeys matching the specified Statement. The following fields are supported for filtering:

PQL Property	Object Property
id	CmsMetadataKey#cmsMetadataKeyId
cmsKey	CmsMetadataKey#keyName
status	CmsMetadataKey.status

Throws:

RemoteException

ApiException

getCmsMetadataValuesByStatement

CmsMetadataValuePage getCmsMetadataValuesByStatement(Statement statement)
                                              throws RemoteException,
                                                     ApiException

Returns a page of CmsMetadataValues matching the specified Statement. The following fields are supported for filtering:

PQL Property	Object Property
id	CmsMetadataValue.cmsMetadataValueId
cmsValue	CmsMetadataValue.valueName
cmsKey	CmsMetadataValue#key#name
cmsKeyId	CmsMetadataValue#key#id
keyValueMemberContent	Content IDs tagged with a CMS metadata key-value
status	CmsMetadataValue.status

Throws:

RemoteException

ApiException

performCmsMetadataKeyAction

UpdateResult performCmsMetadataKeyAction(CmsMetadataKeyAction keyAction,
                                         Statement filterStatement)
                                  throws RemoteException,
                                         ApiException

Performs actions on CmsMetadataKey objects that match the given Statement.query.

Parameters:

keyAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of cms metadata keys.

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

performCmsMetadataValueAction

UpdateResult performCmsMetadataValueAction(CmsMetadataValueAction valueAction,
                                           Statement filterStatement)
                                    throws RemoteException,
                                           ApiException

Performs actions on CmsMetadataValue objects that match the given Statement.query.

Parameters:

valueAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of cms metadata values.

Returns:

the result of the action performed

Throws:

RemoteException

ApiException