\Google\AdsApi\CommonConnectionSettingsBuilder

Builds connection settings.

Summary

Methods
Properties
Constants
__construct()
from()
withProxyUrl()
enableReportingGzip()
build()
defaultOptionals()
validate()
getProxyUrl()
isReportingGzipEnabled()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$configurationLoader
$proxyUrl
$isReportingGzipEnabled
N/A

Properties

$configurationLoader

$configurationLoader :

Type

$proxyUrl

$proxyUrl :

Type

$isReportingGzipEnabled

$isReportingGzipEnabled :

Type

Methods

__construct()

__construct()

withProxyUrl()

withProxyUrl(string|null  $proxyUrl): \Google\AdsApi\Common\ConnectionSettingsBuilder

Includes proxy URL. This is optional and defaults to `null`.

Parameters

string|null $proxyUrl

Returns

\Google\AdsApi\Common\ConnectionSettingsBuilder

this builder

enableReportingGzip()

enableReportingGzip(boolean|null  $isReportingGzipEnabled): \Google\AdsApi\Common\ConnectionSettingsBuilder

Whether gzip compression should be enabled for all reporting requests.

This is optional and defaults to false.

Parameters

boolean|null $isReportingGzipEnabled

Returns

\Google\AdsApi\Common\ConnectionSettingsBuilder

this builder

build()

build(): mixed

Creates a new instance of the data object being populated. This method should call defaultOptionals() and validate().

Returns

mixed —

the data object

defaultOptionals()

defaultOptionals()

Sets all optional fields to their default if they are `null`.

validate()

validate()

Checks that required fields have been included and all included fields are valid (e.g., URIs are valid).

getProxyUrl()

getProxyUrl(): string|null

Gets the proxy URL.

Returns

string|null

isReportingGzipEnabled()

isReportingGzipEnabled(): boolean|null

Whether gzip compression is enabled for reporting requests.

Returns

boolean|null