com.google.api.ads.adwords.v201109.cm
Class SoapHeader

java.lang.Object
  com.google.api.ads.adwords.v201109.cm.SoapHeader

All Implemented Interfaces:

Serializable

public class SoapHeader
extends Object
implements Serializable

Defines the required and optional elements within the header of a SOAP request.

See Also:

Serialized Form

Constructor Summary

SoapHeader()

SoapHeader(String authToken, String clientCustomerId, String developerToken, String userAgent, Boolean validateOnly, Boolean partialFailure)

Method Summary

boolean	equals(Object obj)
String	getAuthToken() Gets the authToken value for this SoapHeader.
String	getClientCustomerId() Gets the clientCustomerId value for this SoapHeader.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
String	getDeveloperToken() Gets the developerToken value for this SoapHeader.
Boolean	getPartialFailure() Gets the partialFailure value for this SoapHeader.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
String	getUserAgent() Gets the userAgent value for this SoapHeader.
Boolean	getValidateOnly() Gets the validateOnly value for this SoapHeader.
int	hashCode()
void	setAuthToken(String authToken) Sets the authToken value for this SoapHeader.
void	setClientCustomerId(String clientCustomerId) Sets the clientCustomerId value for this SoapHeader.
void	setDeveloperToken(String developerToken) Sets the developerToken value for this SoapHeader.
void	setPartialFailure(Boolean partialFailure) Sets the partialFailure value for this SoapHeader.
void	setUserAgent(String userAgent) Sets the userAgent value for this SoapHeader.
void	setValidateOnly(Boolean validateOnly) Sets the validateOnly value for this SoapHeader.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoapHeader

public SoapHeader()

SoapHeader

public SoapHeader(String authToken,
                  String clientCustomerId,
                  String developerToken,
                  String userAgent,
                  Boolean validateOnly,
                  Boolean partialFailure)

Method Detail

getAuthToken

public String getAuthToken()

Gets the authToken value for this SoapHeader.

Returns:

authToken * Authentication token from Google ClientLogin API. Developers need to authenticate themselves with that API before they can send a request to AdWords API. This header identifies either the MCC manager acting on behalf of their client, or the advertiser managing their own account.

setAuthToken

public void setAuthToken(String authToken)

Sets the authToken value for this SoapHeader.

Parameters:

authToken - * Authentication token from Google ClientLogin API. Developers need to authenticate themselves with that API before they can send a request to AdWords API. This header identifies either the MCC manager acting on behalf of their client, or the advertiser managing their own account.

getClientCustomerId

public String getClientCustomerId()

Gets the clientCustomerId value for this SoapHeader.

Returns:

clientCustomerId * Optional header: the customer id of the client of the MCC manager. Applicable only if an MCC manager, as identified by authToken, is acting on behalf of their client.

setClientCustomerId

public void setClientCustomerId(String clientCustomerId)

Sets the clientCustomerId value for this SoapHeader.

Parameters:

clientCustomerId - * Optional header: the customer id of the client of the MCC manager. Applicable only if an MCC manager, as identified by authToken, is acting on behalf of their client.

getDeveloperToken

public String getDeveloperToken()

Gets the developerToken value for this SoapHeader.

Returns:

developerToken * Developer token to identify that the person making the call has enough quota.

setDeveloperToken

public void setDeveloperToken(String developerToken)

Sets the developerToken value for this SoapHeader.

Parameters:

developerToken - * Developer token to identify that the person making the call has enough quota.

getUserAgent

public String getUserAgent()

Gets the userAgent value for this SoapHeader.

Returns:

userAgent * UserAgent is used to track distribution of API client programs and application usage. The client is responsible for putting in a meaningful value for tracking purposes. To be clear this is not the same as an HTTP user agent.

setUserAgent

public void setUserAgent(String userAgent)

Sets the userAgent value for this SoapHeader.

Parameters:

userAgent - * UserAgent is used to track distribution of API client programs and application usage. The client is responsible for putting in a meaningful value for tracking purposes. To be clear this is not the same as an HTTP user agent.

getValidateOnly

public Boolean getValidateOnly()

Gets the validateOnly value for this SoapHeader.

Returns:

validateOnly * Used to validate the request without executing it.

setValidateOnly

public void setValidateOnly(Boolean validateOnly)

Sets the validateOnly value for this SoapHeader.

Parameters:

validateOnly - * Used to validate the request without executing it.

getPartialFailure

public Boolean getPartialFailure()

Gets the partialFailure value for this SoapHeader.

Returns:

partialFailure * If true, API will try to commit as many error free operations as possible and report the other operations' errors.

Ignored for non-mutate calls.

setPartialFailure

public void setPartialFailure(Boolean partialFailure)

Sets the partialFailure value for this SoapHeader.

Parameters:

partialFailure - * If true, API will try to commit as many error free operations as possible and report the other operations' errors.

Ignored for non-mutate calls.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer