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

Provides methods for the creation and management of CustomField objects. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202208.CustomFieldService:
Google.Api.Ads.AdManager.v202208.ICustomFieldService Google.Api.Ads.AdManager.v202208.CustomFieldServiceInterface

Public Member Functions

 CustomFieldService ()
 Creates a new instance of the CustomFieldService class. More...
 
 CustomFieldService (string endpointConfigurationName)
 Creates a new instance of the CustomFieldService class. More...
 
 CustomFieldService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the CustomFieldService class. More...
 
 CustomFieldService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the CustomFieldService class. More...
 
 CustomFieldService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the CustomFieldService class. More...
 
virtual
Google.Api.Ads.AdManager.v202208.CustomFieldOption[] 
createCustomFieldOptions (Google.Api.Ads.AdManager.v202208.CustomFieldOption[] customFieldOptions)
 Creates new CustomFieldOption objects. The following fields are required: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomFieldOption[]> 
createCustomFieldOptionsAsync (Google.Api.Ads.AdManager.v202208.CustomFieldOption[] customFieldOptions)
 
virtual
Google.Api.Ads.AdManager.v202208.CustomField[] 
createCustomFields (Google.Api.Ads.AdManager.v202208.CustomField[] customFields)
 Creates new CustomField objects. The following fields are required: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomField[]> 
createCustomFieldsAsync (Google.Api.Ads.AdManager.v202208.CustomField[] customFields)
 
virtual
Google.Api.Ads.AdManager.v202208.CustomFieldOption 
getCustomFieldOption (long customFieldOptionId)
 Returns the CustomFieldOption uniquely identified by the given ID. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomFieldOption
getCustomFieldOptionAsync (long customFieldOptionId)
 
virtual
Google.Api.Ads.AdManager.v202208.CustomFieldPage 
getCustomFieldsByStatement (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Gets a CustomFieldPage of CustomField 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.CustomFieldPage
getCustomFieldsByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performCustomFieldAction (Google.Api.Ads.AdManager.v202208.CustomFieldAction customFieldAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on CustomField objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performCustomFieldActionAsync (Google.Api.Ads.AdManager.v202208.CustomFieldAction customFieldAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.CustomFieldOption[] 
updateCustomFieldOptions (Google.Api.Ads.AdManager.v202208.CustomFieldOption[] customFieldOptions)
 Updates the specified CustomFieldOption objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomFieldOption[]> 
updateCustomFieldOptionsAsync (Google.Api.Ads.AdManager.v202208.CustomFieldOption[] customFieldOptions)
 
virtual
Google.Api.Ads.AdManager.v202208.CustomField[] 
updateCustomFields (Google.Api.Ads.AdManager.v202208.CustomField[] customFields)
 Updates the specified CustomField objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CustomField[]> 
updateCustomFieldsAsync (Google.Api.Ads.AdManager.v202208.CustomField[] customFields)
 

Detailed Description

Provides methods for the creation and management of CustomField objects.

Constructor & Destructor Documentation

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

Creates a new instance of the CustomFieldService class.

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

Creates a new instance of the CustomFieldService class.

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

Creates a new instance of the CustomFieldService class.

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

Creates a new instance of the CustomFieldService class.

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

Creates a new instance of the CustomFieldService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202208.CustomFieldOption [] Google.Api.Ads.AdManager.v202208.CustomFieldService.createCustomFieldOptions ( Google.Api.Ads.AdManager.v202208.CustomFieldOption[]  customFieldOptions)
inlinevirtual

Creates new CustomFieldOption objects. The following fields are required:

Parameters
customFieldOptionsthe custom fields to create
Returns
the created custom field options with their IDs filled in

Implements Google.Api.Ads.AdManager.v202208.ICustomFieldService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomFieldOption[]> Google.Api.Ads.AdManager.v202208.CustomFieldService.createCustomFieldOptionsAsync ( Google.Api.Ads.AdManager.v202208.CustomFieldOption[]  customFieldOptions)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CustomField [] Google.Api.Ads.AdManager.v202208.CustomFieldService.createCustomFields ( Google.Api.Ads.AdManager.v202208.CustomField[]  customFields)
inlinevirtual

Creates new CustomField objects. The following fields are required:

Parameters
customFieldsthe custom fields to create
Returns
the created custom fields with their IDs filled in

Implements Google.Api.Ads.AdManager.v202208.ICustomFieldService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomField[]> Google.Api.Ads.AdManager.v202208.CustomFieldService.createCustomFieldsAsync ( Google.Api.Ads.AdManager.v202208.CustomField[]  customFields)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CustomFieldOption Google.Api.Ads.AdManager.v202208.CustomFieldService.getCustomFieldOption ( long  customFieldOptionId)
inlinevirtual

Returns the CustomFieldOption uniquely identified by the given ID.

Parameters
customFieldOptionIdthe ID of the custom field option, which must already exist
Returns
the CustomFieldOption uniquely identified by the given ID

Implements Google.Api.Ads.AdManager.v202208.CustomFieldServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomFieldOption> Google.Api.Ads.AdManager.v202208.CustomFieldService.getCustomFieldOptionAsync ( long  customFieldOptionId)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CustomFieldPage Google.Api.Ads.AdManager.v202208.CustomFieldService.getCustomFieldsByStatement ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual

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

PQL Property Object Property
id CustomField::id
entityType CustomField::entityType
name CustomField::name
isActive CustomField::isActive
visibility CustomField::visibility
Parameters
filterStatementa Publisher Query Language statement used to filter a set of custom fields.
Returns
the custom fields that match the given filter

Implements Google.Api.Ads.AdManager.v202208.CustomFieldServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomFieldPage> Google.Api.Ads.AdManager.v202208.CustomFieldService.getCustomFieldsByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.CustomFieldService.performCustomFieldAction ( Google.Api.Ads.AdManager.v202208.CustomFieldAction  customFieldAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

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

Parameters
customFieldActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of custom fields
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.CustomFieldServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.CustomFieldService.performCustomFieldActionAsync ( Google.Api.Ads.AdManager.v202208.CustomFieldAction  customFieldAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CustomFieldOption [] Google.Api.Ads.AdManager.v202208.CustomFieldService.updateCustomFieldOptions ( Google.Api.Ads.AdManager.v202208.CustomFieldOption[]  customFieldOptions)
inlinevirtual

Updates the specified CustomFieldOption objects.

Parameters
customFieldOptionsthe custom field options to update
Returns
the updated custom field options

Implements Google.Api.Ads.AdManager.v202208.ICustomFieldService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomFieldOption[]> Google.Api.Ads.AdManager.v202208.CustomFieldService.updateCustomFieldOptionsAsync ( Google.Api.Ads.AdManager.v202208.CustomFieldOption[]  customFieldOptions)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CustomField [] Google.Api.Ads.AdManager.v202208.CustomFieldService.updateCustomFields ( Google.Api.Ads.AdManager.v202208.CustomField[]  customFields)
inlinevirtual

Updates the specified CustomField objects.

Parameters
customFieldsthe custom fields to update
Returns
the updated custom fields

Implements Google.Api.Ads.AdManager.v202208.ICustomFieldService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CustomField[]> Google.Api.Ads.AdManager.v202208.CustomFieldService.updateCustomFieldsAsync ( Google.Api.Ads.AdManager.v202208.CustomField[]  customFields)
inlinevirtual

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