Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202208.CmsMetadataService Class Reference

Provides methods for querying CMS metadata keys and values. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202208.CmsMetadataService:
Google.Api.Ads.AdManager.v202208.ICmsMetadataService Google.Api.Ads.AdManager.v202208.CmsMetadataServiceInterface

Public Member Functions

 CmsMetadataService ()
 Creates a new instance of the CmsMetadataService class. More...
 
 CmsMetadataService (string endpointConfigurationName)
 Creates a new instance of the CmsMetadataService class. More...
 
 CmsMetadataService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the CmsMetadataService class. More...
 
 CmsMetadataService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the CmsMetadataService class. More...
 
 CmsMetadataService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the CmsMetadataService class. More...
 
virtual
Google.Api.Ads.AdManager.v202208.CmsMetadataKeyPage 
getCmsMetadataKeysByStatement (Google.Api.Ads.AdManager.v202208.Statement statement)
 Returns a page of CmsMetadataKeys matching the specified Statement. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CmsMetadataKeyPage
getCmsMetadataKeysByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement statement)
 
virtual
Google.Api.Ads.AdManager.v202208.CmsMetadataValuePage 
getCmsMetadataValuesByStatement (Google.Api.Ads.AdManager.v202208.Statement statement)
 Returns a page of CmsMetadataValues matching the specified Statement. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CmsMetadataValuePage
getCmsMetadataValuesByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement statement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performCmsMetadataKeyAction (Google.Api.Ads.AdManager.v202208.CmsMetadataKeyAction keyAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on CmsMetadataKey objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performCmsMetadataKeyActionAsync (Google.Api.Ads.AdManager.v202208.CmsMetadataKeyAction keyAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performCmsMetadataValueAction (Google.Api.Ads.AdManager.v202208.CmsMetadataValueAction valueAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on CmsMetadataValue objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performCmsMetadataValueActionAsync (Google.Api.Ads.AdManager.v202208.CmsMetadataValueAction valueAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 

Detailed Description

Provides methods for querying CMS metadata keys and values.

A CMS metadata value corresponds to one key value pair ingested from a publisher's CMS and is used to target all the content with which it is associated in the CMS.

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.v202208.CmsMetadataService.CmsMetadataService ( )
inline

Creates a new instance of the CmsMetadataService class.

Google.Api.Ads.AdManager.v202208.CmsMetadataService.CmsMetadataService ( string  endpointConfigurationName)
inline

Creates a new instance of the CmsMetadataService class.

Google.Api.Ads.AdManager.v202208.CmsMetadataService.CmsMetadataService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the CmsMetadataService class.

Google.Api.Ads.AdManager.v202208.CmsMetadataService.CmsMetadataService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the CmsMetadataService class.

Google.Api.Ads.AdManager.v202208.CmsMetadataService.CmsMetadataService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the CmsMetadataService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202208.CmsMetadataKeyPage Google.Api.Ads.AdManager.v202208.CmsMetadataService.getCmsMetadataKeysByStatement ( Google.Api.Ads.AdManager.v202208.Statement  statement)
inlinevirtual

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

Implements Google.Api.Ads.AdManager.v202208.CmsMetadataServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CmsMetadataKeyPage> Google.Api.Ads.AdManager.v202208.CmsMetadataService.getCmsMetadataKeysByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  statement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CmsMetadataValuePage Google.Api.Ads.AdManager.v202208.CmsMetadataService.getCmsMetadataValuesByStatement ( Google.Api.Ads.AdManager.v202208.Statement  statement)
inlinevirtual

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
status CmsMetadataValue::status

Implements Google.Api.Ads.AdManager.v202208.CmsMetadataServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CmsMetadataValuePage> Google.Api.Ads.AdManager.v202208.CmsMetadataService.getCmsMetadataValuesByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  statement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.CmsMetadataService.performCmsMetadataKeyAction ( Google.Api.Ads.AdManager.v202208.CmsMetadataKeyAction  keyAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

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

Parameters
keyActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of cms metadata keys.
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.CmsMetadataServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.CmsMetadataService.performCmsMetadataKeyActionAsync ( Google.Api.Ads.AdManager.v202208.CmsMetadataKeyAction  keyAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.CmsMetadataService.performCmsMetadataValueAction ( Google.Api.Ads.AdManager.v202208.CmsMetadataValueAction  valueAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

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

Parameters
valueActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of cms metadata values.
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.CmsMetadataServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.CmsMetadataService.performCmsMetadataValueActionAsync ( Google.Api.Ads.AdManager.v202208.CmsMetadataValueAction  valueAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

The documentation for this class was generated from the following file: