\Google\AdsApi\CommonSoapSettingsBuilder

__construct()

__construct()

from()

from(\Google\AdsApi\Common\Configuration  $configuration): \Google\AdsApi\Common\AdsBuilder

Populates this builder from the specified configuration object.

Parameters

Returns

this builder populated from the configuration

withCompressionLevel()

withCompressionLevel(integer|null  $compressionLevel): \Google\AdsApi\Common\SoapSettingsBuilder

Includes gzip compression level.

The level of gzip compression to use, from 1 to 9. The higher the level the greater the compression and time needed to perform the compression. This is optional and defaults to null, in which case PHP will use its default value.

Parameters

Returns

this builder

withWsdlCacheType()

withWsdlCacheType(integer|null  $wsdlCacheType): \Google\AdsApi\Common\SoapSettingsBuilder

Includes WSDL cache type. Additional WSDL caching settings can be set in the php.ini. This is optional and defaults to `null`, in which case PHP will use its default value.

Parameters

Returns

this builder

disableSslVerify()

disableSslVerify(): \Google\AdsApi\Common\SoapSettingsBuilder

Disables SSL verification. Enabled by default.

This is not recommended.

Returns

this builder

withSslCaFile()

withSslCaFile(string|null  $sslCaFile): \Google\AdsApi\Common\SoapSettingsBuilder

Includes the path to a CA bundle file to use for SSL verification. This field is only meaningful if SSL verification is not disabled.

This is optional and defaults to null, in which case this library will try to automatically find your system CA bundle file. Use this function only if you want to use a custom CA bundle file or you're getting SSL verification errors because this library cannot find a CA bundle file for you on your system.

Parameters

Returns

this builder

build()

build(): mixed

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

Returns

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).

getCompressionLevel()

getCompressionLevel(): integer|null

Gets the gzip compression level.

Returns

getWsdlCacheType()

getWsdlCacheType(): integer|null

Gets the type of WSDL caching in use.

Returns

getSslVerify()

getSslVerify(): boolean

Gets whether SSL verification is enabled.

Returns

getSslCaFile()

getSslCaFile(): string|null

Gets the SSL CA file.

Returns