com.google.api.ads.dfp.jaxws.v201711

Interface CustomFieldServiceInterface

public interface CustomFieldServiceInterface

Provides methods for the creation and management of CustomField objects. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
List<CustomFieldOption>	createCustomFieldOptions(List<CustomFieldOption> customFieldOptions) Creates new CustomFieldOption objects.
List<CustomField>	createCustomFields(List<CustomField> customFields) Creates new CustomField objects.
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.
List<CustomFieldOption>	updateCustomFieldOptions(List<CustomFieldOption> customFieldOptions) Updates the specified CustomFieldOption objects.
List<CustomField>	updateCustomFields(List<CustomField> customFields) Updates the specified CustomField objects.

Method Detail

createCustomFieldOptions

@RequestWrapper(localName="createCustomFieldOptions",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfacecreateCustomFieldOptions")
 @ResponseWrapper(localName="createCustomFieldOptionsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfacecreateCustomFieldOptionsResponse")
List<CustomFieldOption> createCustomFieldOptions(List<CustomFieldOption> customFieldOptions)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws ApiException_Exception

Creates new CustomFieldOption objects. The following fields are required:

• CustomFieldOption.displayName
• CustomFieldOption.customFieldId

Parameters:

customFieldOptions - the custom fields to create

customFieldOptions -

Returns:

the created custom field options with their IDs filled in

Throws:

ApiException_Exception

createCustomFields

@RequestWrapper(localName="createCustomFields",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfacecreateCustomFields")
 @ResponseWrapper(localName="createCustomFieldsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfacecreateCustomFieldsResponse")
List<CustomField> createCustomFields(List<CustomField> customFields)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Creates new CustomField objects. The following fields are required:

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

Parameters:

customFields - the custom fields to create

customFields -

Returns:

the created custom fields with their IDs filled in

Throws:

ApiException_Exception

getCustomFieldOption

@RequestWrapper(localName="getCustomFieldOption",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfacegetCustomFieldOption")
 @ResponseWrapper(localName="getCustomFieldOptionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfacegetCustomFieldOptionResponse")
CustomFieldOption getCustomFieldOption(Long customFieldOptionId)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      throws ApiException_Exception

Returns the CustomFieldOption uniquely identified by the given ID.

Parameters:

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

customFieldOptionId -

Returns:

the CustomFieldOption uniquely identified by the given ID

Throws:

ApiException_Exception

getCustomFieldsByStatement

@RequestWrapper(localName="getCustomFieldsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfacegetCustomFieldsByStatement")
 @ResponseWrapper(localName="getCustomFieldsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfacegetCustomFieldsByStatementResponse")
CustomFieldPage getCustomFieldsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

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.

filterStatement -

Returns:

the custom fields that match the given filter

Throws:

ApiException_Exception

performCustomFieldAction

@RequestWrapper(localName="performCustomFieldAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfaceperformCustomFieldAction")
 @ResponseWrapper(localName="performCustomFieldActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfaceperformCustomFieldActionResponse")
UpdateResult performCustomFieldAction(CustomFieldAction customFieldAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     throws ApiException_Exception

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

customFieldAction -

filterStatement -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateCustomFieldOptions

@RequestWrapper(localName="updateCustomFieldOptions",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfaceupdateCustomFieldOptions")
 @ResponseWrapper(localName="updateCustomFieldOptionsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfaceupdateCustomFieldOptionsResponse")
List<CustomFieldOption> updateCustomFieldOptions(List<CustomFieldOption> customFieldOptions)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws ApiException_Exception

Updates the specified CustomFieldOption objects.

Parameters:

customFieldOptions - the custom field options to update

customFieldOptions -

Returns:

the updated custom field options

Throws:

ApiException_Exception

updateCustomFields

@RequestWrapper(localName="updateCustomFields",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfaceupdateCustomFields")
 @ResponseWrapper(localName="updateCustomFieldsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomFieldServiceInterfaceupdateCustomFieldsResponse")
List<CustomField> updateCustomFields(List<CustomField> customFields)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Updates the specified CustomField objects.

Parameters:

customFields - the custom fields to update

customFields -

Returns:

the updated custom fields

Throws:

ApiException_Exception