Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.Common.Lib.ServiceFactory Class Referenceabstract

Interface to a factory which can create a particular group of services. For every new service supported, you need an implementation of this interface. More...

Inheritance diagram for Google.Api.Ads.Common.Lib.ServiceFactory:
Google.Api.Ads.Common.Lib.Configurable Google.Api.Ads.AdManager.Lib.AdManagerServiceFactory Google.Api.Ads.AdWords.Lib.AdWordsServiceFactory

Public Member Functions

abstract AdsClient CreateService (ServiceSignature signature, AdsUser user, Uri serverUrl)
 Create a service object. More...
 

Protected Member Functions

abstract void ReadHeadersFromConfig (AppConfig config)
 Reads the headers from App.config. More...
 
abstract void CheckServicePreconditions (ServiceSignature signature)
 Checks preconditions of the service signature and throws and exception if the service cannot be generated. More...
 

Properties

AppConfig Config [get, set]
 Gets an App.config reader suitable for this factory. More...
 
- Properties inherited from Google.Api.Ads.Common.Lib.Configurable
AppConfig Config [get]
 Gets the application configuration class for this object. More...
 

Detailed Description

Interface to a factory which can create a particular group of services. For every new service supported, you need an implementation of this interface.

Member Function Documentation

abstract void Google.Api.Ads.Common.Lib.ServiceFactory.CheckServicePreconditions ( ServiceSignature  signature)
protectedpure virtual

Checks preconditions of the service signature and throws and exception if the service cannot be generated.

Parameters
signaturethe service signature for generating the service

Implemented in Google.Api.Ads.AdWords.Lib.AdWordsServiceFactory, and Google.Api.Ads.AdManager.Lib.AdManagerServiceFactory.

abstract AdsClient Google.Api.Ads.Common.Lib.ServiceFactory.CreateService ( ServiceSignature  signature,
AdsUser  user,
Uri  serverUrl 
)
pure virtual

Create a service object.

Parameters
signatureSignature of the service being created.
userThe user for which the service is being created.
serverUrlThe server to which the API calls should be made.
Returns
An object of the desired service type.

Implemented in Google.Api.Ads.AdManager.Lib.AdManagerServiceFactory, and Google.Api.Ads.AdWords.Lib.AdWordsServiceFactory.

abstract void Google.Api.Ads.Common.Lib.ServiceFactory.ReadHeadersFromConfig ( AppConfig  config)
protectedpure virtual

Reads the headers from App.config.

Parameters
configThe configuration class.

Implemented in Google.Api.Ads.AdWords.Lib.AdWordsServiceFactory, and Google.Api.Ads.AdManager.Lib.AdManagerServiceFactory.

Property Documentation

AppConfig Google.Api.Ads.Common.Lib.ServiceFactory.Config
getset

Gets an App.config reader suitable for this factory.


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