com.google.api.ads.admanager.axis.v201808

Class CustomFieldServiceSoapBindingStub

java.lang.Object

org.apache.axis.client.Stub

com.google.api.ads.admanager.axis.v201808.CustomFieldServiceSoapBindingStub

All Implemented Interfaces:

CustomFieldServiceInterface, Remote, javax.xml.rpc.Stub

public class CustomFieldServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements CustomFieldServiceInterface

Field Summary

Fields inherited from class org.apache.axis.client.Stub

_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
CustomFieldServiceSoapBindingStub()
CustomFieldServiceSoapBindingStub(javax.xml.rpc.Service service)
CustomFieldServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Modifier and Type	Method and Description
protected org.apache.axis.client.Call	createCall()
CustomFieldOption[]	createCustomFieldOptions(CustomFieldOption[] customFieldOptions) Creates new CustomFieldOption objects.
CustomField[]	createCustomFields(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.
CustomFieldOption[]	updateCustomFieldOptions(CustomFieldOption[] customFieldOptions) Updates the specified CustomFieldOption objects.
CustomField[]	updateCustomFields(CustomField[] customFields) Updates the specified CustomField objects.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomFieldServiceSoapBindingStub

public CustomFieldServiceSoapBindingStub()
                                  throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

CustomFieldServiceSoapBindingStub

public CustomFieldServiceSoapBindingStub(URL endpointURL,
                                         javax.xml.rpc.Service service)
                                  throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

CustomFieldServiceSoapBindingStub

public CustomFieldServiceSoapBindingStub(javax.xml.rpc.Service service)
                                  throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:

RemoteException

createCustomFieldOptions

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

Description copied from interface: CustomFieldServiceInterface

Creates new CustomFieldOption objects. The following fields are required:

• CustomFieldOption.displayName
• CustomFieldOption.customFieldId

Specified by:

createCustomFieldOptions in interface CustomFieldServiceInterface

Parameters:

customFieldOptions - the custom fields to create

Returns:

the created custom field options with their IDs filled in

Throws:

RemoteException

ApiException

createCustomFields

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

Description copied from interface: CustomFieldServiceInterface

Creates new CustomField objects. The following fields are required:

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

Specified by:

createCustomFields in interface CustomFieldServiceInterface

Parameters:

customFields - the custom fields to create

Returns:

the created custom fields with their IDs filled in

Throws:

RemoteException

ApiException

getCustomFieldOption

public CustomFieldOption getCustomFieldOption(Long customFieldOptionId)
                                       throws RemoteException,
                                              ApiException

Description copied from interface: CustomFieldServiceInterface

Returns the CustomFieldOption uniquely identified by the given ID.

Specified by:

getCustomFieldOption in interface CustomFieldServiceInterface

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

public CustomFieldPage getCustomFieldsByStatement(Statement filterStatement)
                                           throws RemoteException,
                                                  ApiException

Description copied from interface: CustomFieldServiceInterface

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

Specified by:

getCustomFieldsByStatement in interface CustomFieldServiceInterface

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

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

Description copied from interface: CustomFieldServiceInterface

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

Specified by:

performCustomFieldAction in interface CustomFieldServiceInterface

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

updateCustomFieldOptions

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

Description copied from interface: CustomFieldServiceInterface

Updates the specified CustomFieldOption objects.

Specified by:

updateCustomFieldOptions in interface CustomFieldServiceInterface

Parameters:

customFieldOptions - the custom field options to update

Returns:

the updated custom field options

Throws:

RemoteException

ApiException

updateCustomFields

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

Description copied from interface: CustomFieldServiceInterface

Updates the specified CustomField objects.

Specified by:

updateCustomFields in interface CustomFieldServiceInterface

Parameters:

customFields - the custom fields to update

Returns:

the updated custom fields

Throws:

RemoteException

ApiException