com.google.api.ads.dfp.axis.v201306

Class AdRuleServiceSoapBindingStub

java.lang.Object

org.apache.axis.client.Stub

com.google.api.ads.dfp.axis.v201306.AdRuleServiceSoapBindingStub

All Implemented Interfaces:

AdRuleServiceInterface, Remote, javax.xml.rpc.Stub

public class AdRuleServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements AdRuleServiceInterface

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
AdRuleServiceSoapBindingStub()
AdRuleServiceSoapBindingStub(javax.xml.rpc.Service service)
AdRuleServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Methods

Modifier and Type	Method and Description
AdRule	createAdRule(AdRule adRule) Creates a new AdRule.
AdRule[]	createAdRules(AdRule[] adRules) Creates new AdRule objects.
protected org.apache.axis.client.Call	createCall()
AdRule	getAdRule(Integer adRuleId) Returns the AdRule uniquely identified by the given ID.
AdRulePage	getAdRulesByStatement(Statement statement) Gets an AdRulePage of AdRule objects that satisfy the given Statement.query.
UpdateResult	performAdRuleAction(AdRuleAction adRuleAction, Statement filterStatement) Performs actions on AdRule objects that match the given Statement.query.
AdRule	updateAdRule(AdRule adRule) Updates a previously-created AdRule.
AdRule[]	updateAdRules(AdRule[] adRules) Updates the specified AdRule 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

AdRuleServiceSoapBindingStub

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

Throws:

org.apache.axis.AxisFault

AdRuleServiceSoapBindingStub

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

Throws:

org.apache.axis.AxisFault

AdRuleServiceSoapBindingStub

public AdRuleServiceSoapBindingStub(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

createAdRule

public AdRule createAdRule(AdRule adRule)
                    throws RemoteException,
                           ApiException

Description copied from interface: AdRuleServiceInterface

Creates a new AdRule. The following fields are required:

• AdRule.id
• AdRule.name
• AdRule.priority
• AdRule.startDateTime
• AdRule.endDateTime
• AdRule.preroll
• AdRule.midroll
• AdRule.postroll

Specified by:

createAdRule in interface AdRuleServiceInterface

Parameters:

adRule - the ad rule to create

Returns:

the ad rule with its ID filled in

Throws:

ApiException - if there the ad rule is invalid or there is another error

RemoteException

createAdRules

public AdRule[] createAdRules(AdRule[] adRules)
                       throws RemoteException,
                              ApiException

Description copied from interface: AdRuleServiceInterface

Creates new AdRule objects.

Specified by:

createAdRules in interface AdRuleServiceInterface

Parameters:

adRules - the ad rules to create

Returns:

the created ad rules with their IDs filled in

Throws:

RemoteException

ApiException

getAdRule

public AdRule getAdRule(Integer adRuleId)
                 throws RemoteException,
                        ApiException

Description copied from interface: AdRuleServiceInterface

Returns the AdRule uniquely identified by the given ID.

Specified by:

getAdRule in interface AdRuleServiceInterface

Parameters:

adRuleId - the ID of the ad rule, which must already exist

Returns:

the AdRule uniquely identified by the given ID

Throws:

ApiException - if there is an error retrieving the ad rule or the ID is invalid

RemoteException

getAdRulesByStatement

public AdRulePage getAdRulesByStatement(Statement statement)
                                 throws RemoteException,
                                        ApiException

Description copied from interface: AdRuleServiceInterface

Gets an AdRulePage of AdRule objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	AdRule.id
name	AdRule.name
priority	AdRule.priority
status	AdRule.status

Specified by:

getAdRulesByStatement in interface AdRuleServiceInterface

Returns:

the ad rules that match the given filter

Throws:

ApiException - if the ID of the active network does not exist or there is a backend error

RemoteException

performAdRuleAction

public UpdateResult performAdRuleAction(AdRuleAction adRuleAction,
                               Statement filterStatement)
                                 throws RemoteException,
                                        ApiException

Description copied from interface: AdRuleServiceInterface

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

Specified by:

performAdRuleAction in interface AdRuleServiceInterface

Parameters:

adRuleAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of ad rules

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateAdRule

public AdRule updateAdRule(AdRule adRule)
                    throws RemoteException,
                           ApiException

Description copied from interface: AdRuleServiceInterface

Updates a previously-created AdRule.

Specified by:

updateAdRule in interface AdRuleServiceInterface

Parameters:

adRule - the ad rule that should be updated

Returns:

the updated ad rule

Throws:

ApiException - if there is an error updating the ad rule

RemoteException

updateAdRules

public AdRule[] updateAdRules(AdRule[] adRules)
                       throws RemoteException,
                              ApiException

Description copied from interface: AdRuleServiceInterface

Updates the specified AdRule objects.

Specified by:

updateAdRules in interface AdRuleServiceInterface

Parameters:

adRules - the ad rules to update

Returns:

the updated ad rules

Throws:

ApiException - if there is an error updating the ad rules

RemoteException