DEFAULT_APPLICATION_NAME
DEFAULT_APPLICATION_NAME
Builds Ad Manager sessions.
fromFile(string|null $path = null): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Reads configuration settings from the specified filepath. The filepath is optional, and if omitted, it will look for the default configuration filename in the home directory of the user running PHP.
| string|null | $path | the filepath |
if the configuration file could not be found
this builder populated from the configuration
from(\Google\AdsApi\Common\Configuration $configuration): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Populates this builder from the specified configuration object.
| \Google\AdsApi\Common\Configuration | $configuration | a configuration object that holds the same data as an *.ini file would have |
this builder populated from the configuration
withNetworkCode(string $networkCode): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Includes network code. This is required.
| string | $networkCode |
this builder
withApplicationName(string $applicationName): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Includes application name. This is required.
| string | $applicationName |
this builder
withEndpoint(string|null $endpoint): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Includes the Ad Manager API server's base endpoint. This is optional.
| string|null | $endpoint |
this builder
withOAuth2Credential(\Google\Auth\FetchAuthTokenInterface $oAuth2Credential): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Includes the OAuth2 credential to be used for authentication. This is required.
| \Google\Auth\FetchAuthTokenInterface | $oAuth2Credential |
this builder
withConnectionSettings(\Google\AdsApi\Common\ConnectionSettings $connectionSettings): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Includes connection settings. This is optional.
| \Google\AdsApi\Common\ConnectionSettings | $connectionSettings |
this builder
withSoapSettings(\Google\AdsApi\Common\SoapSettings $soapSettings): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Includes SOAP settings. This is optional.
| \Google\AdsApi\Common\SoapSettings | $soapSettings |
this builder
asIcsUserForNetwork(string $networkCode): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Allows the session to act as an ICS user for the specified network.
| string | $networkCode |
this builder
asImpersonatedUser(string $impersonatedUser): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Impersonates the specified user.
| string | $impersonatedUser | the email address of the user to impersonate |
this builder
withSoapLogger(\Psr\Log\LoggerInterface $soapLogger): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Includes a PSR-3 compliant logger for logging SOAP calls. This is optional.
| \Psr\Log\LoggerInterface | $soapLogger |
this builder
withReportDownloaderLogger(\Psr\Log\LoggerInterface $reportDownloaderLogger): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Includes a PSR-3 compliant logger for the report downloader utility to log report download calls. This is optional.
| \Psr\Log\LoggerInterface | $reportDownloaderLogger |
this builder
withAdsHeaderFormatter(\Google\AdsApi\Common\AdsHeaderFormatter $adsHeaderFormatter): \Google\AdsApi\AdManager\AdManagerSessionBuilder
Includes ads header formatter. This is optional.
| \Google\AdsApi\Common\AdsHeaderFormatter | $adsHeaderFormatter |
this builder
getConnectionSettings(): \Google\AdsApi\Common\ConnectionSettings
Gets the connection settings.
getSoapSettings(): \Google\AdsApi\Common\SoapSettings
Gets the SOAP settings.
getAdsHeaderFormatter(): \Google\AdsApi\Common\AdsHeaderFormatter
Gets ads header formatter.