AdWords API Documentation
\
Google
AdsApi
AdWords
BatchJobs
v201809
Query
v201809
Reporting
v201809
Shopping
v201809
Common
Util

\Google\AdsApi\AdWordsAdWordsSession

A session for using the AdWords API.

Summary

Methods
Properties
Constants
__construct()
getDeveloperToken()
getUserAgent()
getEndpoint()
getOAuth2Credential()
getConnectionSettings()
getSoapSettings()
getClientCustomerId()
isValidateOnly()
setValidateOnly()
isPartialFailure()
setPartialFailure()
isIncludeUtilitiesInUserAgent()
setIncludeUtilitiesInUserAgent()
getReportSettings()
getSoapLogger()
getReportDownloaderLogger()
getBatchJobsUtilLogger()
getAdsHeaderFormatter()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$developerToken
$userAgent
$endpoint
$oAuth2Credential
$connectionSettings
$soapSettings
$clientCustomerId
$isValidateOnly
$isPartialFailure
$isIncludeUtilitiesInUserAgent
$reportSettings
$soapLogger
$reportDownloaderLogger
$batchJobsUtilLogger
$adsHeaderFormatter
N/A

Properties

$developerToken

$developerToken :

Type

$userAgent

$userAgent :

Type

$endpoint

$endpoint :

Type

$oAuth2Credential

$oAuth2Credential :

Type

$connectionSettings

$connectionSettings :

Type

$soapSettings

$soapSettings :

Type

$clientCustomerId

$clientCustomerId :

Type

$isValidateOnly

$isValidateOnly :

Type

$isPartialFailure

$isPartialFailure :

Type

$isIncludeUtilitiesInUserAgent

$isIncludeUtilitiesInUserAgent :

Type

$reportSettings

$reportSettings :

Type

$soapLogger

$soapLogger :

Type

$reportDownloaderLogger

$reportDownloaderLogger :

Type

$batchJobsUtilLogger

$batchJobsUtilLogger :

Type

$adsHeaderFormatter

$adsHeaderFormatter :

Type

Methods

__construct()

__construct(\Google\AdsApi\AdWords\AdWordsSessionBuilder  $builder)

Creates an AdWords session from the specified builder.

Do not use this constructor, instances should be created by using the AdWordsSessionBuilder instead.

Parameters

\Google\AdsApi\AdWords\AdWordsSessionBuilder $builder

the builder to create an instance of this session from

getDeveloperToken()

getDeveloperToken(): string

Gets the developer token.

Returns

string

getUserAgent()

getUserAgent(): string

Gets the user agent.

Returns

string

getEndpoint()

getEndpoint(): string

Gets the server endpoint to make API requests against.

Returns

string —

the non-null server endpoint

getOAuth2Credential()

getOAuth2Credential(): \Google\Auth\FetchAuthTokenInterface

Gets the Google OAuth2 credential for authenticating API requests.

Returns

\Google\Auth\FetchAuthTokenInterface —

the non-null Google OAuth2 credential

getConnectionSettings()

getConnectionSettings(): \Google\AdsApi\Common\ConnectionSettings

Gets the connection settings to apply to API requests.

Returns

\Google\AdsApi\Common\ConnectionSettings —

the non-null connection settings

getSoapSettings()

getSoapSettings(): \Google\AdsApi\Common\SoapSettings

Gets the SOAP settings to apply to API requests.

Returns

\Google\AdsApi\Common\SoapSettings —

the non-null SOAP settings

getClientCustomerId()

getClientCustomerId(): string|null

Gets the client customer ID.

Returns

string|null

isValidateOnly()

isValidateOnly(): boolean

Whether the session should only validate the request.

Returns

boolean

setValidateOnly()

setValidateOnly(boolean  $isValidateOnly)

Sets whether this session should only validate the request.

Parameters

boolean $isValidateOnly

isPartialFailure()

isPartialFailure(): boolean

Whether the session should allow partial failure.

Returns

boolean

setPartialFailure()

setPartialFailure(boolean  $isPartialFailure)

Sets whether this session should allow partial failure.

Parameters

boolean $isPartialFailure

isIncludeUtilitiesInUserAgent()

isIncludeUtilitiesInUserAgent(): boolean

Whether the session should include utilities usages into user agents.

Returns

boolean

setIncludeUtilitiesInUserAgent()

setIncludeUtilitiesInUserAgent(boolean  $isIncludeUtilitiesInUserAgent)

Sets whether this session should include utilities usages into user agents.

Parameters

boolean $isIncludeUtilitiesInUserAgent

getSoapLogger()

getSoapLogger(): \Psr\Log\LoggerInterface

Gets the PSR-3 compliant logger that logs SOAP messages for this session.

Returns

\Psr\Log\LoggerInterface —

the non-null logger

getReportDownloaderLogger()

getReportDownloaderLogger(): \Psr\Log\LoggerInterface

Gets the report downloader logger.

Returns

\Psr\Log\LoggerInterface

getBatchJobsUtilLogger()

getBatchJobsUtilLogger(): \Psr\Log\LoggerInterface

Gets the batch jobs utility logger.

Returns

\Psr\Log\LoggerInterface