Element index for package GoogleApiAdsCommon
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ o ]
[ p ]
[ r ]
[ s ]
[ u ]
[ v ]
[ x ]
[ _ ]
_
- __construct
- in file ReportDownloadException.php, method ReportDownloadException::__construct()
Constructor for ReportDownloadException.
- __construct
- in file SoapClientFactory.php, method SoapClientFactory::__construct()
The constructor called by any sub-class.
- __construct
- in file ValidationException.php, method ValidationException::__construct()
Constructor for ValidationException where the exception will appear as "Validation failed for [$trigger] with value [$value]: $message".
- __construct
- in file AuthTokenException.php, method AuthTokenException::__construct()
Constructor for AuthTokenException.
- __construct
- in file AdsUser.php, method AdsUser::__construct()
Constructor for AdsUser.
- __construct
- in file AdsSoapClient.php, method AdsSoapClient::__construct()
The constructor intended to be called by all sub-classes.
- __doRequest
- in file AdsSoapClient.php, method AdsSoapClient::__doRequest()
Overrides the method SoapClient.__doRequest() to perform a clean up of the request XML before marshalling.
- __soapCall
- in file AdsSoapClient.php, method AdsSoapClient::__soapCall()
Overrides the method SoapClient.__soapCall() to process the response from the SOAP call.
- __construct
- in file SoapRequestXmlFixer.php, method SoapRequestXmlFixer::__construct()
Constructor to determine how the XML should be fixed.
- __construct
- in file AuthToken.php, method AuthToken::__construct()
Constructor for the authentication token.
top
a
- AdsSoapClient
- in file AdsSoapClient.php, class AdsSoapClient
An extension of the SoapClient class intended to prepare the XML before making a request as well as perform any book-keeping on the response.
- AdsUser
- in file AdsUser.php, class AdsUser
User class for all API modules using the Ads API.
- AuthTokenException
- in file AuthTokenException.php, class AuthTokenException
Exception class for any AuthToken (ClientLogin) error.
- AdsSoapClient.php
- procedural page AdsSoapClient.php
- AdsUser.php
- procedural page AdsUser.php
- AuthTokenException.php
- procedural page AuthTokenException.php
- AuthToken
- in file AuthToken.php, class AuthToken
Client used to retrieve an authentication token for the supplied credentials with the client login API.
- AuthToken.php
- procedural page AuthToken.php
top
c
- CreateSoapHeader
- in file AdsSoapClient.php, method AdsSoapClient::CreateSoapHeader()
Creates a SOAP header for the client given the user. It assumes that each element within the header to be filled in is a publicly acessible feild of the SOAP header element.
- ChoiceUtils
- in file ChoiceUtils.php, class ChoiceUtils
A collection of utility methods for working with choices. Choices are objects which contain many fields, but any time only one of which will contain a value.
- ChoiceUtils.php
- procedural page ChoiceUtils.php
- CurlUtils.php
- procedural page CurlUtils.php
- CreateSession
- in file CurlUtils.php, method CurlUtils::CreateSession()
Creates a new cURL session with the default options applied.
- CurlUtils
- in file CurlUtils.php, class CurlUtils
A collection of utility methods for working with cURL.
top
top
e
- $ERROR
- in file Logger.php, variable Logger::$ERROR
ERROR level.
- ErrorUtils.php
- procedural page ErrorUtils.php
- ErrorUtils
- in file ErrorUtils.php, class ErrorUtils
A collection of utility methods for working with errors.
top
top
g
- GenerateRequestInfoMessage
- in file AdsSoapClient.php, method AdsSoapClient::GenerateRequestInfoMessage()
Generates the request information using the request and response. This method is called after the request has been made and RemoveSensitiveInfo() has been called as well.
- GenerateServiceClient
- in file SoapClientFactory.php, method SoapClientFactory::GenerateServiceClient()
Generates the SOAP service client without the proper headers set yet.
- GenerateSoapClient
- in file SoapClientFactory.php, method SoapClientFactory::GenerateSoapClient()
Generates a SOAP client for the given service name. Generates a user level error if this instalation of PHP does not have the extension for SOAP installed.
- GenerateSoapHeader
- in file AdsSoapClient.php, method AdsSoapClient::GenerateSoapHeader()
Generates the SOAP header for the client.
- GetAdsUser
- in file SoapClientFactory.php, method SoapClientFactory::GetAdsUser()
Gets the user associated with this factory.
- GetAdsUser
- in file AdsSoapClient.php, method AdsSoapClient::GetAdsUser()
Gets the user for this client.
- GetAuthServer
- in file AdsUser.php, method AdsUser::GetAuthServer()
Gets the server used for authentication.
- GetAuthVarValue
- in file AdsUser.php, method AdsUser::GetAuthVarValue()
Gets the authenticaiton value for the $authVar supplied. If the $authVar is set, it is is used. Otherwirse, the supplied $authenticationIni is queired for the variable. If none is found NULL is returned.
- GetCaptchaToken
- in file AuthTokenException.php, method AuthTokenException::GetCaptchaToken()
Gets the CATPCHA token for the error.
- GetCaptchaUrl
- in file AuthTokenException.php, method AuthTokenException::GetCaptchaUrl()
Gets the CAPTCHA URL for the error.
- GetClientLibraryIdentifier
- in file AdsUser.php, method AdsUser::GetClientLibraryIdentifier()
Gets the client library identifier used for user-agent fields.
- GetDefaultServer
- in file AdsUser.php, method AdsUser::GetDefaultServer()
Gets the default server.
- GetDefaultVersion
- in file AdsUser.php, method AdsUser::GetDefaultVersion()
Gets the default version.
- GetEmail
- in file AdsSoapClient.php, method AdsSoapClient::GetEmail()
Gets the email of the user making the request.
- GetError
- in file AuthTokenException.php, method AuthTokenException::GetError()
Gets the error that caused the exception.
- GetHeaderNames
- in file AdsUser.php, method AdsUser::GetHeaderNames()
Gets the names of all registered request header elements.
- GetHeaderNames
- in file AdsSoapClient.php, method AdsSoapClient::GetHeaderNames()
Gets the names of all registered request header elements.
- GetHeaderValue
- in file AdsUser.php, method AdsUser::GetHeaderValue()
Gets the value for a registered request header element.
- GetHeaderValue
- in file AdsSoapClient.php, method AdsSoapClient::GetHeaderValue()
Gets the value for a registered request header element.
- GetLastFaultMessage
- in file AdsSoapClient.php, method AdsSoapClient::GetLastFaultMessage()
Returns the SOAP fault message if there was any
- GetLastMethodName
- in file AdsSoapClient.php, method AdsSoapClient::GetLastMethodName()
Gets the method name for the last method called.
- GetLastRequestDom
- in file AdsSoapClient.php, method AdsSoapClient::GetLastRequestDom()
Get the DOMDocument representing the last request from this client.
- GetLastRequestId
- in file AdsSoapClient.php, method AdsSoapClient::GetLastRequestId()
Gets the request ID for the last call
- GetLastResponseDom
- in file AdsSoapClient.php, method AdsSoapClient::GetLastResponseDom()
Gets the DOMDocument representing the last response from this client.
- GetLastResponseTime
- in file AdsSoapClient.php, method AdsSoapClient::GetLastResponseTime()
Gets the response time for the last call
- GetLogsDirectory
- in file AdsUser.php, method AdsUser::GetLogsDirectory()
Gets the logs directory.
- GetOAuthAuthorizationUrl
- in file AdsUser.php, method AdsUser::GetOAuthAuthorizationUrl()
Gets the OAuth authorization URL for the OAuth token.
- GetOAuthInfo
- in file AdsUser.php, method AdsUser::GetOAuthInfo()
Gets the OAuth info for this user.
- GetOAuthScope
- in file AdsUser.php, method AdsUser::GetOAuthScope()
Gets the OAuth scope for this user.
- GetProductName
- in file SoapClientFactory.php, method SoapClientFactory::GetProductName()
Gets the product name associated with this factory.
- GetServer
- in file AdsSoapClient.php, method AdsSoapClient::GetServer()
Gets the server that the request was made to.
- GetServer
- in file SoapClientFactory.php, method SoapClientFactory::GetServer()
Gets the server associated with this factory.
- GetServiceLocation
- in file SoapClientFactory.php, method SoapClientFactory::GetServiceLocation()
Gets the end-point location of the service.
- GetServiceName
- in file AdsSoapClient.php, method AdsSoapClient::GetServiceName()
Gets the service name for this client.
- GetServiceSoapClient
- in file AdsUser.php, method AdsUser::GetServiceSoapClient()
Gets the service by its service name.
- GetSoapCompressionLevel
- in file AdsUser.php, method AdsUser::GetSoapCompressionLevel()
Gets the SOAP compression level.
- GetUrl
- in file AuthTokenException.php, method AuthTokenException::GetUrl()
Gets the URL associated with the error.
- GetVersion
- in file SoapClientFactory.php, method SoapClientFactory::GetVersion()
Gets the version associated with this factory.
- GetWsdlCacheType
- in file AdsUser.php, method AdsUser::GetWsdlCacheType()
Gets the type of WSDL caching in use.
- GetAccessToken
- in file OAuthUtils.php, method OAuthUtils::GetAccessToken()
Gets the access token for an authorized request token.
- GetApiErrors
- in file ErrorUtils.php, method ErrorUtils::GetApiErrors()
Gets the ApiErrors in the SOAP fault, if any.
- GetAuthorizationUrl
- in file OAuthUtils.php, method OAuthUtils::GetAuthorizationUrl()
Gets the authorization URL for a request token.
- GetAuthToken
- in file AuthToken.php, method AuthToken::GetAuthToken()
Peforms a POST to get the auth token and then parses the result.
- GetBase64Data
- in file MediaUtils.php, method MediaUtils::GetBase64Data()
Gets the base64 encoded data from an asset located at path for use with the API where <x>Data is needed.
- GetDomFromXml
- in file XmlUtils.php, method XmlUtils::GetDomFromXml()
Gets the DOMDocument of the $xml.
- GetMap
- in file MapUtils.php, method MapUtils::GetMap()
Gets a map (associative array) from an array of map entries. A map entry is any object that has a key and value field.
- GetMapEntries
- in file MapUtils.php, method MapUtils::GetMapEntries()
Gets an array of map entries from a map (associative array). A map entry is any object that has a key and value field. An optional map entry class name can be specified for constructing the entries, otherise the stdClass is used.
- GetRequestToken
- in file OAuthUtils.php, method OAuthUtils::GetRequestToken()
Gets a request token.
- GetServer
- in file AuthToken.php, method AuthToken::GetServer()
Returns the server to make requests to.
- GetSignedRequestParameters
- in file OAuthUtils.php, method OAuthUtils::GetSignedRequestParameters()
Gets the signed OAuth parameters needed to make a request against the given URL.
- GetSourceOperationIndex
- in file ErrorUtils.php, method ErrorUtils::GetSourceOperationIndex()
Gets the index of the operation that was the source of an error.
- GetValue
- in file OgnlUtils.php, method OgnlUtils::GetValue()
Gets the value of an OGNL expression in the given context.
- GetValue
- in file ChoiceUtils.php, method ChoiceUtils::GetValue()
Gets the value of a choice object.
top
h
- $headers
- in file AdsSoapClient.php, variable AdsSoapClient::$headers
The header values.
- HandleXmlError
- in file XmlUtils.php, function HandleXmlError()
Caputures the warnings thrown by the loadXML function to create a proper DOMException.
top
top
l
- $lastArguments
- in file AdsSoapClient.php, variable AdsSoapClient::$lastArguments
The last arguments passed to the called SOAP method
- $lastMethodName
- in file AdsSoapClient.php, variable AdsSoapClient::$lastMethodName
The name of the last method called from this client.
- $lastRequest
- in file AdsSoapClient.php, variable AdsSoapClient::$lastRequest
The last SOAP XML request made to the server after PrepareRequest() and RemoveSensitiveInfo() have been called on it.
- $lastResponse
- in file AdsSoapClient.php, variable AdsSoapClient::$lastResponse
The last SOAP XML response from the server.
- $lastSoapFault
- in file AdsSoapClient.php, variable AdsSoapClient::$lastSoapFault
The last SOAP fault generated from the server. NULL if none.
- LoadSettings
- in file AdsUser.php, method AdsUser::LoadSettings()
Loads the settings for this client library. If the settings INI file located at $settingsIniPath cannot be loaded, then the parameters passed into this method are used.
- LogDefaults
- in file AdsUser.php, method AdsUser::LogDefaults()
Initiates the default logging behavior of logging all HTTP headers and SOAP XML to the soap_xml.log file and all request information to the request_info.log file under the logs directory.
- Logger.php
- procedural page Logger.php
- Log
- in file Logger.php, method Logger::Log()
Logs a message to the log at a specific level.
- Logger
- in file Logger.php, class Logger
A logger class which registers appenders (any writable handle location which can be fopen'ed) with a unique name for that log. The library will write all incoming/outgoing SOAP XML to SOAP_XML_LOG and all records of requests to REQUEST_INFO_LOG.
- LogToFile
- in file Logger.php, method Logger::LogToFile()
Logs the given log to a file at the file path.
- LogToStream
- in file Logger.php, method Logger::LogToStream()
Logs the given log to a stream represented by $phpIoStream. The availble streams are listed here:
top
m
- MapUtils.php
- procedural page MapUtils.php
- MediaUtils.php
- procedural page MediaUtils.php
- MapUtils
- in file MapUtils.php, class MapUtils
A collection of utility methods for working with maps (associative arrays).
- MediaUtils
- in file MediaUtils.php, class MediaUtils
A utility class to handle data of media assets (such as image, SWF, or video files).
top
o
- OAuthUtils.php
- procedural page OAuthUtils.php
- OgnlUtils.php
- procedural page OgnlUtils.php
- OAuthUtils
- in file OAuthUtils.php, class OAuthUtils
A utility class for working with OAuth.
- OgnlUtils
- in file OgnlUtils.php, class OgnlUtils
A collection of utility methods for working with OGNL paths.
top
p
- PrepareRequest
- in file AdsSoapClient.php, method AdsSoapClient::PrepareRequest()
Depending on the version of PHP, the xsi:types need to be added and empty tags may need to be removed. The SoapRequestXmlFixer class can facilitate these changes.
- PrettyPrint
- in file XmlUtils.php, method XmlUtils::PrettyPrint()
Returns a pretty printed XML. If the XML cannot be loaded a string stripped of any newlines is returned.
top
top
s
- $serviceName
- in file AdsSoapClient.php, variable AdsSoapClient::$serviceName
The name of the service this client is accessing.
- $serviceNamespace
- in file AdsSoapClient.php, variable AdsSoapClient::$serviceNamespace
The namespace of the service this client is accessing.
- SoapClientFactory.php
- procedural page SoapClientFactory.php
- SetDefaultServer
- in file AdsUser.php, method AdsUser::SetDefaultServer()
Sets the default server.
- SetDefaultVersion
- in file AdsUser.php, method AdsUser::SetDefaultVersion()
Sets the default version.
- SetHeaderValue
- in file AdsUser.php, method AdsUser::SetHeaderValue()
Sets the value for a request header.
- SetHeaderValue
- in file AdsSoapClient.php, method AdsSoapClient::SetHeaderValue()
Sets the value for a request header.
- SetOAuthInfo
- in file AdsUser.php, method AdsUser::SetOAuthInfo()
Sets the OAuth info for this user.
- SoapClientFactory
- in file SoapClientFactory.php, class SoapClientFactory
Base class for all SOAP client factories of Ads client libraries.
- $SOAP_XML_LOG
- in file Logger.php, variable Logger::$SOAP_XML_LOG
Logs all incomming and outgoing SOAP XML.
- $STD_ERR_STREAM
- in file Logger.php, variable Logger::$STD_ERR_STREAM
Standard error stream for use with the LogToStream method.
- $STD_OUT_STREAM
- in file Logger.php, variable Logger::$STD_OUT_STREAM
Standard out stream for use with the LogToStream method.
- SoapRequestXmlFixer.php
- procedural page SoapRequestXmlFixer.php
- SoapRequestXmlFixer
- in file SoapRequestXmlFixer.php, class SoapRequestXmlFixer
The SOAP XML request fixer used to fix some inconsistencies among the different versions of the PHP SoapClient.
top
top
top
x
- XmlUtils.php
- procedural page XmlUtils.php
- XmlUtils
- in file XmlUtils.php, class XmlUtils
A collection of utility methods for working with XML.
top
|
|
