AdManager API Documentation
\
Google
AdsApi
AdManager
Util
v202105
v202108
v202111
v202202
Common
Util

\Google\AdsApi\AdManagerAdManagerSession

A session for using the Ad Manager API.

Summary

Methods
Properties
Constants
__construct()
getNetworkCode()
getApplicationName()
getEndpoint()
getOAuth2Credential()
getConnectionSettings()
getSoapSettings()
isIcsUser()
getImpersonatedUser()
getSoapLogger()
getReportDownloaderLogger()
getAdsHeaderFormatter()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$networkCode
$applicationName
$endpoint
$oAuth2Credential
$connectionSettings
$soapSettings
$isIcsUser
$impersonatedUser
$soapLogger
$reportDownloaderLogger
$adsHeaderFormatter
N/A

Properties

$networkCode

$networkCode :

Type

$applicationName

$applicationName :

Type

$endpoint

$endpoint :

Type

$oAuth2Credential

$oAuth2Credential :

Type

$connectionSettings

$connectionSettings :

Type

$soapSettings

$soapSettings :

Type

$isIcsUser

$isIcsUser :

Type

$impersonatedUser

$impersonatedUser :

Type

$soapLogger

$soapLogger :

Type

$reportDownloaderLogger

$reportDownloaderLogger :

Type

$adsHeaderFormatter

$adsHeaderFormatter :

Type

Methods

__construct()

__construct(\Google\AdsApi\AdManager\AdManagerSessionBuilder  $builder)

Creates a Ad Manager session from the specified builder.

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

Parameters

\Google\AdsApi\AdManager\AdManagerSessionBuilder $builder

the builder to create an instance of this session from

getNetworkCode()

getNetworkCode(): string

Gets the network code.

Returns

string

getApplicationName()

getApplicationName(): string

Gets the application name.

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

isIcsUser()

isIcsUser(): boolean|null

Whether this session represents a user with ICS access.

Returns

boolean|null

getImpersonatedUser()

getImpersonatedUser(): string|null

Gets the email address of a Ad Manager user to impersonate.

This is null if API requests should be performed by the authenticated user within the impersonated network.

Returns

string|null

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