com.google.api.ads.dfp.axis.v201311

Interface CustomFieldServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

CustomFieldServiceSoapBindingStub

public interface CustomFieldServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
CustomField	createCustomField(CustomField customField) Creates a new CustomField.
CustomFieldOption	createCustomFieldOption(CustomFieldOption customFieldOption) Creates a new CustomFieldOption.
CustomFieldOption[]	createCustomFieldOptions(CustomFieldOption[] customFieldOptions) Creates new CustomFieldOption objects.
CustomField[]	createCustomFields(CustomField[] customFields) Creates new CustomField objects.
CustomField	getCustomField(Long customFieldId) Returns the CustomField uniquely identified by the given ID.
CustomFieldOption	getCustomFieldOption(Long customFieldOptionId) Returns the CustomFieldOption uniquely identified by the given ID.
CustomFieldPage	getCustomFieldsByStatement(Statement filterStatement) Gets a CustomFieldPage of CustomField objects that satisfy the given Statement.query.
UpdateResult	performCustomFieldAction(CustomFieldAction customFieldAction, Statement filterStatement) Performs actions on CustomField objects that match the given Statement.query.
CustomField	updateCustomField(CustomField customField) Updates the specified CustomField.
CustomFieldOption	updateCustomFieldOption(CustomFieldOption customFieldOption) Updates the specified CustomFieldOption.
CustomFieldOption[]	updateCustomFieldOptions(CustomFieldOption[] customFieldOptions) Updates the specified CustomFieldOption objects.
CustomField[]	updateCustomFields(CustomField[] customFields) Updates the specified CustomField objects.

Method Detail

createCustomField

CustomField createCustomField(CustomField customField)
                              throws RemoteException,
                                     ApiException

Creates a new CustomField. The following fields are required:

• CustomField.name
• CustomField.entityType
• CustomField.dataType
• CustomField.visibility

Parameters:

customField - the custom field to create

Returns:

the custom field with its ID filled in

Throws:

RemoteException

ApiException

createCustomFieldOption

CustomFieldOption createCustomFieldOption(CustomFieldOption customFieldOption)
                                          throws RemoteException,
                                                 ApiException

Creates a new CustomFieldOption. The following fields are required:

• CustomFieldOption.displayName
• CustomFieldOption.customFieldId

Parameters:

customFieldOption - the custom field to create

Returns:

the custom field option with its ID filled in

Throws:

RemoteException

ApiException

createCustomFieldOptions

CustomFieldOption[] createCustomFieldOptions(CustomFieldOption[] customFieldOptions)
                                             throws RemoteException,
                                                    ApiException

Creates new CustomFieldOption objects. The following fields are required:

• CustomFieldOption.displayName
• CustomFieldOption.customFieldId

Parameters:

customFieldOptions - the custom fields to create

Returns:

the created custom field options with their IDs filled in

Throws:

RemoteException

ApiException

createCustomFields

CustomField[] createCustomFields(CustomField[] customFields)
                                 throws RemoteException,
                                        ApiException

Creates new CustomField objects. The following fields are required:

• CustomField.name
• CustomField.entityType
• CustomField.dataType
• CustomField.visibility

Parameters:

customFields - the custom fields to create

Returns:

the created custom fields with their IDs filled in

Throws:

RemoteException

ApiException

getCustomField

CustomField getCustomField(Long customFieldId)
                           throws RemoteException,
                                  ApiException

Returns the CustomField uniquely identified by the given ID.

Parameters:

customFieldId - the ID of the custom field, which must already exist

Returns:

the CustomField uniquely identified by the given ID

Throws:

RemoteException

ApiException

getCustomFieldOption

CustomFieldOption getCustomFieldOption(Long customFieldOptionId)
                                       throws RemoteException,
                                              ApiException

Returns the CustomFieldOption uniquely identified by the given ID.

Parameters:

customFieldOptionId - the ID of the custom field option, which must already exist

Returns:

the CustomFieldOption uniquely identified by the given ID

Throws:

RemoteException

ApiException

getCustomFieldsByStatement

CustomFieldPage getCustomFieldsByStatement(Statement filterStatement)
                                           throws RemoteException,
                                                  ApiException

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:

filterStatement - a Publisher Query Language statement used to filter a set of custom fields.

Returns:

the custom fields that match the given filter

Throws:

RemoteException

ApiException

performCustomFieldAction

UpdateResult performCustomFieldAction(CustomFieldAction customFieldAction,
                                    Statement filterStatement)
                                      throws RemoteException,
                                             ApiException

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

Parameters:

customFieldAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of custom fields

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateCustomField

CustomField updateCustomField(CustomField customField)
                              throws RemoteException,
                                     ApiException

Updates the specified CustomField.

Parameters:

customField - the custom field to update

Returns:

the updated customField

Throws:

RemoteException

ApiException

updateCustomFieldOption

CustomFieldOption updateCustomFieldOption(CustomFieldOption customFieldOption)
                                          throws RemoteException,
                                                 ApiException

Updates the specified CustomFieldOption.

Parameters:

customFieldOption - the custom field option to update

Returns:

the updated customFieldOption

Throws:

RemoteException

ApiException

updateCustomFieldOptions

CustomFieldOption[] updateCustomFieldOptions(CustomFieldOption[] customFieldOptions)
                                             throws RemoteException,
                                                    ApiException

Updates the specified CustomFieldOption objects.

Parameters:

customFieldOptions - the custom field options to update

Returns:

the updated custom field options

Throws:

RemoteException

ApiException

updateCustomFields

CustomField[] updateCustomFields(CustomField[] customFields)
                                 throws RemoteException,
                                        ApiException

Updates the specified CustomField objects.

Parameters:

customFields - the custom fields to update

Returns:

the updated custom fields

Throws:

RemoteException

ApiException