Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.Lib.AdWordsUser Class Reference

Represents an AdWords API user. More...

Inheritance diagram for Google.Api.Ads.AdWords.Lib.AdWordsUser:
Google.Api.Ads.Common.Lib.AdsUser Google.Api.Ads.Common.Lib.Configurable

Public Member Functions

 AdWordsUser (AdWordsAppConfig config)
 Public constructor. Use this version if you want to construct an AdWordsUser with a custom configuration. More...
 
 AdWordsUser ()
 Public constructor. Use this version if you want the library to use all settings from App.config. More...
 
 AdWordsUser (Dictionary< string, string > headers)
 Parameterized constructor. Use this version if you want to construct an AdWordsUser with a custom set of headers. More...
 
override Type[] GetServiceTypes ()
 Gets all the service types to be registered against this user. More...
 
override SoapListener[] GetDefaultListeners ()
 Gets the list of default SOAP listeners. More...
 
void AddCallDetails (ApiCallEntry apiCall)
 Adds an API call detail to this user instance. More...
 
ApiCallEntry[] GetCallDetails ()
 Gets the details of the API calls made by this user. More...
 
int GetTotalOperationCount ()
 Gets the total number of operations made by this user. More...
 
int GetOperationCountForLastCall ()
 Gets the number of operations for the last API call. More...
 
void ResetCallHistory ()
 Resets the call history for this user. More...
 
- Public Member Functions inherited from Google.Api.Ads.Common.Lib.AdsUser
void RegisterService (string serviceId, ServiceFactory serviceFactory)
 Register a service with AdsUser. More...
 
ServiceFactory GetServiceFactory (string serviceId)
 Gets the service factory for a service. More...
 
AdsClient GetService (ServiceSignature serviceSignature)
 Creates an object of the requested type of service. More...
 
AdsClient GetService (ServiceSignature serviceSignature, string serverUrl)
 Creates an object of the requested type of service. More...
 
AdsClient GetService (ServiceSignature serviceSignature, Uri serverUrl)
 Creates an object of the requested type of service. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Google.Api.Ads.Common.Lib.AdsUser
 AdsUser (AppConfigBase config)
 Protected constructor. Use this version from a derived class if you want the library to use all settings from App.config. More...
 
 AdsUser (AppConfigBase config, Dictionary< string, string > headers)
 Protected constructor. Use this version from a derived class if you want the library to use all settings from App.config. More...
 
void RegisterServices (Type[] servicesFamilies)
 Registers a family of services against this user. More...
 
void SetHeadersFromConfig ()
 Set the user headers from App.config. More...
 
- Properties inherited from Google.Api.Ads.Common.Lib.AdsUser
AdsOAuthProvider OAuthProvider [get, set]
 Gets or sets the OAuth provider. More...
 
AppConfig Config [get]
 Gets or sets the application configuration for this user. More...
 
List< SoapListenerListeners [get]
 Gets the listeners. More...
 
- Properties inherited from Google.Api.Ads.Common.Lib.Configurable
AppConfig Config [get]
 Gets the application configuration class for this object. More...
 

Detailed Description

Represents an AdWords API user.

Constructor & Destructor Documentation

Google.Api.Ads.AdWords.Lib.AdWordsUser.AdWordsUser ( AdWordsAppConfig  config)
inline

Public constructor. Use this version if you want to construct an AdWordsUser with a custom configuration.

Google.Api.Ads.AdWords.Lib.AdWordsUser.AdWordsUser ( )
inline

Public constructor. Use this version if you want the library to use all settings from App.config.

Google.Api.Ads.AdWords.Lib.AdWordsUser.AdWordsUser ( Dictionary< string, string >  headers)
inline

Parameterized constructor. Use this version if you want to construct an AdWordsUser with a custom set of headers.

Parameters
headersThe custom set of headers.

Member Function Documentation

void Google.Api.Ads.AdWords.Lib.AdWordsUser.AddCallDetails ( ApiCallEntry  apiCall)
inline

Adds an API call detail to this user instance.

Parameters
apiCallThe API call details to be added.
ApiCallEntry [] Google.Api.Ads.AdWords.Lib.AdWordsUser.GetCallDetails ( )
inline

Gets the details of the API calls made by this user.

Returns
The list of all call details.
override SoapListener [] Google.Api.Ads.AdWords.Lib.AdWordsUser.GetDefaultListeners ( )
inlinevirtual

Gets the list of default SOAP listeners.

Returns
A list of default SOAP listeners.

Implements Google.Api.Ads.Common.Lib.AdsUser.

int Google.Api.Ads.AdWords.Lib.AdWordsUser.GetOperationCountForLastCall ( )
inline

Gets the number of operations for the last API call.

Returns
The number of operations for the last API call, or 0 if no API calls have been made so far.
override Type [] Google.Api.Ads.AdWords.Lib.AdWordsUser.GetServiceTypes ( )
inlinevirtual

Gets all the service types to be registered against this user.

Returns
The type of all service classes to be registered.

Implements Google.Api.Ads.Common.Lib.AdsUser.

int Google.Api.Ads.AdWords.Lib.AdWordsUser.GetTotalOperationCount ( )
inline

Gets the total number of operations made by this user.

Returns
The total number of operations made by this user, or 0 if no calls were made.
void Google.Api.Ads.AdWords.Lib.AdWordsUser.ResetCallHistory ( )
inline

Resets the call history for this user.


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