Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel > Class Template Reference

Base class for all SOAP services supported by this library. More...

Inheritance diagram for Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >:
Google.Api.Ads.Common.Lib.AdsClient Google.Api.Ads.AdManager.Lib.AdManagerSoapClient< TChannel > Google.Api.Ads.AdWords.Lib.AdWordsSoapClient< TChannel >

Public Member Functions

 AdsSoapClient (string endpointConfigurationName)
 Initializes a new instance of the AdsSoapClient class. More...
 
 AdsSoapClient (string endpointConfigurationName, EndpointAddress remoteAddress)
 Initializes a new instance of the AdsSoapClient class. More...
 
 AdsSoapClient (Binding binding, EndpointAddress remoteAddress)
 Initializes a new instance of the AdsSoapClient class. More...
 
 AdsSoapClient (string endpointConfigurationName, string remoteAddress)
 Initializes a new instance of the AdsSoapClient class. More...
 
 AdsSoapClient ()
 Default constructor. More...
 
void Dispose ()
 Disposes of this AdsSoapClient. More...
 

Protected Member Functions

virtual void InitForCall (string methodName, object[] parameters)
 Initializes the service before MakeApiCall. More...
 
virtual void CleanupAfterCall (string methodName, object[] parameters)
 Cleans up the service after MakeApiCall. More...
 

Properties

int Timeout [get, set]
 The timeout for the request in milliseconds. More...
 
string Url [get, set]
 The url endpoint for the service. More...
 
bool EnableDecompression [get, set]
 Gets or sets whether gzip compression is enabled. More...
 
IWebProxy Proxy [get, set]
 Gets or sets proxy information for making a service request through a firewall. More...
 
string UserAgent [get, set]
 Gets or sets the value for the user agent header that is sent with each request. More...
 
AdsUser User [get, set]
 The user that created this service instance. More...
 
ServiceSignature Signature [get, set]
 The signature for this service. More...
 
- Properties inherited from Google.Api.Ads.Common.Lib.AdsClient
int Timeout [get, set]
 The timeout for the request. More...
 
string Url [get, set]
 The url endpoint for the service. More...
 
bool EnableDecompression [get, set]
 Gets or sets whether gzip compression is enabled. More...
 
IWebProxy Proxy [get, set]
 Gets or sets proxy information for making a service request through a firewall. More...
 
string UserAgent [get, set]
 Gets or sets the value for the user agent header that is sent with each request. More...
 
AdsUser User [get, set]
 Gets or sets the AdsUser object that created this service. More...
 
ServiceSignature Signature [get, set]
 Gets or sets the signature for this service. More...
 

Detailed Description

Base class for all SOAP services supported by this library.

Type Constraints
TChannel :class 

Constructor & Destructor Documentation

Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.AdsSoapClient ( string  endpointConfigurationName)
inline

Initializes a new instance of the AdsSoapClient class.

Parameters
endpointConfigurationNameThe name of the endpoint in the application configuration file.
Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.AdsSoapClient ( string  endpointConfigurationName,
EndpointAddress  remoteAddress 
)
inline

Initializes a new instance of the AdsSoapClient class.

Parameters
endpointConfigurationNameThe name of the endpoint in the application configuration file.
remoteAddressRemote address of the service.
Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.AdsSoapClient ( Binding  binding,
EndpointAddress  remoteAddress 
)
inline

Initializes a new instance of the AdsSoapClient class.

Parameters
bindingThe binding with which to make calls to the service.
remoteAddressRemote address of the service.
Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.AdsSoapClient ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Initializes a new instance of the AdsSoapClient class.

Parameters
endpointConfigurationNameThe name of the endpoint in the application configuration file.
remoteAddressRemote address of the service.
Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.AdsSoapClient ( )
inline

Default constructor.

Member Function Documentation

virtual void Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.CleanupAfterCall ( string  methodName,
object[]  parameters 
)
inlineprotectedvirtual

Cleans up the service after MakeApiCall.

Parameters
methodNameName of the method.
parametersThe method parameters.

Reimplemented in Google.Api.Ads.AdWords.Lib.AdWordsSoapClient< TChannel >.

void Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.Dispose ( )
inline

Disposes of this AdsSoapClient.

virtual void Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.InitForCall ( string  methodName,
object[]  parameters 
)
inlineprotectedvirtual

Initializes the service before MakeApiCall.

Parameters
methodNameName of the method.
parametersThe method parameters.

Property Documentation

bool Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.EnableDecompression
getset

Gets or sets whether gzip compression is enabled.

IWebProxy Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.Proxy
getset

Gets or sets proxy information for making a service request through a firewall.

ServiceSignature Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.Signature
getset

The signature for this service.

int Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.Timeout
getset

The timeout for the request in milliseconds.

string Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.Url
getset

The url endpoint for the service.

AdsUser Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.User
getset

The user that created this service instance.

string Google.Api.Ads.Common.Lib.AdsSoapClient< TChannel >.UserAgent
getset

Gets or sets the value for the user agent header that is sent with each request.


The documentation for this class was generated from the following file: