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

Provides operations for creating, updating and retrieving CustomTargetingKey and CustomTargetingValue objects. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202208.CustomTargetingService:
Google.Api.Ads.AdManager.v202208.ICustomTargetingService Google.Api.Ads.AdManager.v202208.CustomTargetingServiceInterface

Public Member Functions

 CustomTargetingService ()
 Creates a new instance of the CustomTargetingService class. More...
 
 CustomTargetingService (string endpointConfigurationName)
 Creates a new instance of the CustomTargetingService class. More...
 
 CustomTargetingService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the CustomTargetingService class. More...
 
 CustomTargetingService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the CustomTargetingService class. More...
 
 CustomTargetingService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the CustomTargetingService class. More...
 
virtual
Google.Api.Ads.AdManager.v202208.CustomTargetingKey[] 
createCustomTargetingKeys (Google.Api.Ads.AdManager.v202208.CustomTargetingKey[] keys)
 Creates new CustomTargetingKey objects. The following fields are required: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomTargetingKey[]> 
createCustomTargetingKeysAsync (Google.Api.Ads.AdManager.v202208.CustomTargetingKey[] keys)
 
virtual
Google.Api.Ads.AdManager.v202208.CustomTargetingValue[] 
createCustomTargetingValues (Google.Api.Ads.AdManager.v202208.CustomTargetingValue[] values)
 Creates new CustomTargetingValue objects. The following fields are required: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomTargetingValue[]> 
createCustomTargetingValuesAsync (Google.Api.Ads.AdManager.v202208.CustomTargetingValue[] values)
 
virtual
Google.Api.Ads.AdManager.v202208.CustomTargetingKeyPage 
getCustomTargetingKeysByStatement (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Gets a CustomTargetingKeyPage of CustomTargetingKey objects that satisfy the given Statement::query. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomTargetingKeyPage
getCustomTargetingKeysByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.CustomTargetingValuePage 
getCustomTargetingValuesByStatement (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Gets a CustomTargetingValuePage of CustomTargetingValue objects that satisfy the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomTargetingValuePage
getCustomTargetingValuesByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performCustomTargetingKeyAction (Google.Api.Ads.AdManager.v202208.CustomTargetingKeyAction customTargetingKeyAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on CustomTargetingKey objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performCustomTargetingKeyActionAsync (Google.Api.Ads.AdManager.v202208.CustomTargetingKeyAction customTargetingKeyAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performCustomTargetingValueAction (Google.Api.Ads.AdManager.v202208.CustomTargetingValueAction customTargetingValueAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on CustomTargetingValue objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performCustomTargetingValueActionAsync (Google.Api.Ads.AdManager.v202208.CustomTargetingValueAction customTargetingValueAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.CustomTargetingKey[] 
updateCustomTargetingKeys (Google.Api.Ads.AdManager.v202208.CustomTargetingKey[] keys)
 Updates the specified CustomTargetingKey objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomTargetingKey[]> 
updateCustomTargetingKeysAsync (Google.Api.Ads.AdManager.v202208.CustomTargetingKey[] keys)
 
virtual
Google.Api.Ads.AdManager.v202208.CustomTargetingValue[] 
updateCustomTargetingValues (Google.Api.Ads.AdManager.v202208.CustomTargetingValue[] values)
 Updates the specified CustomTargetingValue objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomTargetingValue[]> 
updateCustomTargetingValuesAsync (Google.Api.Ads.AdManager.v202208.CustomTargetingValue[] values)
 

Detailed Description

Provides operations for creating, updating and retrieving CustomTargetingKey and CustomTargetingValue objects.

Constructor & Destructor Documentation

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

Creates a new instance of the CustomTargetingService class.

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

Creates a new instance of the CustomTargetingService class.

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

Creates a new instance of the CustomTargetingService class.

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

Creates a new instance of the CustomTargetingService class.

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

Creates a new instance of the CustomTargetingService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202208.CustomTargetingKey [] Google.Api.Ads.AdManager.v202208.CustomTargetingService.createCustomTargetingKeys ( Google.Api.Ads.AdManager.v202208.CustomTargetingKey[]  keys)
inlinevirtual

Creates new CustomTargetingKey objects. The following fields are required:

Parameters
keysthe custom targeting keys to update
Returns
the updated custom targeting keys

Implements Google.Api.Ads.AdManager.v202208.ICustomTargetingService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomTargetingKey[]> Google.Api.Ads.AdManager.v202208.CustomTargetingService.createCustomTargetingKeysAsync ( Google.Api.Ads.AdManager.v202208.CustomTargetingKey[]  keys)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CustomTargetingValue [] Google.Api.Ads.AdManager.v202208.CustomTargetingService.createCustomTargetingValues ( Google.Api.Ads.AdManager.v202208.CustomTargetingValue[]  values)
inlinevirtual

Creates new CustomTargetingValue objects. The following fields are required:

Parameters
valuesthe custom targeting values to update
Returns
the updated custom targeting keys

Implements Google.Api.Ads.AdManager.v202208.ICustomTargetingService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomTargetingValue[]> Google.Api.Ads.AdManager.v202208.CustomTargetingService.createCustomTargetingValuesAsync ( Google.Api.Ads.AdManager.v202208.CustomTargetingValue[]  values)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CustomTargetingKeyPage Google.Api.Ads.AdManager.v202208.CustomTargetingService.getCustomTargetingKeysByStatement ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual

Gets a CustomTargetingKeyPage of CustomTargetingKey objects that satisfy the given Statement::query. The following fields are supported for filtering:

PQL Property Object Property
id CustomTargetingKey::id
name CustomTargetingKey::name
displayName CustomTargetingKey::displayName
type CustomTargetingKey::type
Parameters
filterStatementa Publisher Query Language statement used to filter a set of custom targeting keys
Returns
the custom targeting keys that match the given filter

Implements Google.Api.Ads.AdManager.v202208.CustomTargetingServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomTargetingKeyPage> Google.Api.Ads.AdManager.v202208.CustomTargetingService.getCustomTargetingKeysByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CustomTargetingValuePage Google.Api.Ads.AdManager.v202208.CustomTargetingService.getCustomTargetingValuesByStatement ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual

Gets a CustomTargetingValuePage of CustomTargetingValue objects that satisfy the given Statement::query.

The WHERE clause in the Statement::query must always contain CustomTargetingValue::customTargetingKeyId as one of its columns in a way that it is AND'ed with the rest of the query. So, if you want to retrieve values for a known set of key ids, valid Statement::query would look like:

  1. "WHERE customTargetingKeyId IN ('17','18','19')" retrieves all values that are associated with keys having ids 17, 18, 19.
  2. "WHERE customTargetingKeyId = '17' AND name = 'red'" retrieves values that are associated with keys having id 17 and value name is 'red'.



The following fields are supported for filtering:

PQL Property Object Property
id CustomTargetingValue::id
customTargetingKeyId CustomTargetingValue::customTargetingKeyId
name CustomTargetingValue::name
displayName CustomTargetingValue::displayName
matchType CustomTargetingValue::matchType
Parameters
filterStatementa Publisher Query Language statement used to filter a set of custom targeting values
Returns
the custom targeting values that match the given filter

Implements Google.Api.Ads.AdManager.v202208.CustomTargetingServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomTargetingValuePage> Google.Api.Ads.AdManager.v202208.CustomTargetingService.getCustomTargetingValuesByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.CustomTargetingService.performCustomTargetingKeyAction ( Google.Api.Ads.AdManager.v202208.CustomTargetingKeyAction  customTargetingKeyAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

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

Parameters
customTargetingKeyActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of custom targeting keys
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.CustomTargetingServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.CustomTargetingService.performCustomTargetingKeyActionAsync ( Google.Api.Ads.AdManager.v202208.CustomTargetingKeyAction  customTargetingKeyAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.CustomTargetingService.performCustomTargetingValueAction ( Google.Api.Ads.AdManager.v202208.CustomTargetingValueAction  customTargetingValueAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

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

Parameters
customTargetingValueActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of ad units
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.CustomTargetingServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.CustomTargetingService.performCustomTargetingValueActionAsync ( Google.Api.Ads.AdManager.v202208.CustomTargetingValueAction  customTargetingValueAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CustomTargetingKey [] Google.Api.Ads.AdManager.v202208.CustomTargetingService.updateCustomTargetingKeys ( Google.Api.Ads.AdManager.v202208.CustomTargetingKey[]  keys)
inlinevirtual

Updates the specified CustomTargetingKey objects.

Parameters
keysthe custom targeting keys to update
Returns
the updated custom targeting keys

Implements Google.Api.Ads.AdManager.v202208.ICustomTargetingService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomTargetingKey[]> Google.Api.Ads.AdManager.v202208.CustomTargetingService.updateCustomTargetingKeysAsync ( Google.Api.Ads.AdManager.v202208.CustomTargetingKey[]  keys)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CustomTargetingValue [] Google.Api.Ads.AdManager.v202208.CustomTargetingService.updateCustomTargetingValues ( Google.Api.Ads.AdManager.v202208.CustomTargetingValue[]  values)
inlinevirtual

Updates the specified CustomTargetingValue objects.

Parameters
valuesthe custom targeting values to update
Returns
the updated custom targeting values

Implements Google.Api.Ads.AdManager.v202208.ICustomTargetingService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomTargetingValue[]> Google.Api.Ads.AdManager.v202208.CustomTargetingService.updateCustomTargetingValuesAsync ( Google.Api.Ads.AdManager.v202208.CustomTargetingValue[]  values)
inlinevirtual

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