Reference documentation and code samples for the Google Ads Ad Manager V1 Client class NetworkServiceClient.
Service Description: Provides methods for handling Network objects.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Ads \ AdManager \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array|Google\ApiCore\Options\ClientOptions
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
Google\Auth\FetchAuthTokenInterface|Google\ApiCore\CredentialsWrapper
This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|Google\ApiCore\Transport\TransportInterface
The transport used for executing network requests. At the moment, supports only |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|Psr\Log\LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
↳ universeDomain |
string
The service domain for the client. Defaults to 'googleapis.com'. |
getDefaultThirdPartyDataDeclaration
Returns the [DefaultThirdPartyDataDeclaration] for this network.
The async variant is NetworkServiceClient::getDefaultThirdPartyDataDeclarationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Ads\AdManager\V1\GetDefaultThirdPartyDataDeclarationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Ads\AdManager\V1\DefaultThirdPartyDataDeclaration |
|
use Google\Ads\AdManager\V1\Client\NetworkServiceClient;
use Google\Ads\AdManager\V1\DefaultThirdPartyDataDeclaration;
use Google\Ads\AdManager\V1\GetDefaultThirdPartyDataDeclarationRequest;
use Google\ApiCore\ApiException;
/**
* @param string $formattedName Resource name of DefaultThirdPartyDataDeclaration.
* Format: networks/{network_code}/defaultThirdPartyDataDeclaration
* Please see {@see NetworkServiceClient::defaultThirdPartyDataDeclarationName()} for help formatting this field.
*/
function get_default_third_party_data_declaration_sample(string $formattedName): void
{
// Create a client.
$networkServiceClient = new NetworkServiceClient();
// Prepare the request message.
$request = (new GetDefaultThirdPartyDataDeclarationRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DefaultThirdPartyDataDeclaration $response */
$response = $networkServiceClient->getDefaultThirdPartyDataDeclaration($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = NetworkServiceClient::defaultThirdPartyDataDeclarationName('[NETWORK_CODE]');
get_default_third_party_data_declaration_sample($formattedName);
}
getNetwork
Retrieves a Network object.
The async variant is NetworkServiceClient::getNetworkAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Ads\AdManager\V1\GetNetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Ads\AdManager\V1\Network |
|
use Google\Ads\AdManager\V1\Client\NetworkServiceClient;
use Google\Ads\AdManager\V1\GetNetworkRequest;
use Google\Ads\AdManager\V1\Network;
use Google\ApiCore\ApiException;
/**
* @param string $formattedName Resource name of Network.
* Format: networks/{network_code}
* Please see {@see NetworkServiceClient::networkName()} for help formatting this field.
*/
function get_network_sample(string $formattedName): void
{
// Create a client.
$networkServiceClient = new NetworkServiceClient();
// Prepare the request message.
$request = (new GetNetworkRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Network $response */
$response = $networkServiceClient->getNetwork($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = NetworkServiceClient::networkName('[NETWORK_CODE]');
get_network_sample($formattedName);
}
listNetworks
Retrieves all the networks the current user has access to.
The async variant is NetworkServiceClient::listNetworksAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Ads\AdManager\V1\ListNetworksRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\Ads\AdManager\V1\Client\NetworkServiceClient;
use Google\Ads\AdManager\V1\ListNetworksRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function list_networks_sample(): void
{
// Create a client.
$networkServiceClient = new NetworkServiceClient();
// Prepare the request message.
$request = new ListNetworksRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $networkServiceClient->listNetworks($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
provisionTestNetwork
Provisions a test network associated with the current user. Only one test network can be provisioned per user.
Before the test network can be used, you must complete setup in the Ad Manager UI. If the test network's owner is a service account, you must add a non-service account user by calling UserService.CreateUser.
Test networks are limited in the following ways:
- Test networks have a maximum of 10,000 objects per entity type.
- Test networks cannot serve ads.
- Reports on serving data have zero rows.
- Forecast service results contain mock data.
- Test networks do not have Ad Manager 360 or premium features enabled.
The async variant is NetworkServiceClient::provisionTestNetworkAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Ads\AdManager\V1\ProvisionTestNetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Ads\AdManager\V1\Network |
|
use Google\Ads\AdManager\V1\Client\NetworkServiceClient;
use Google\Ads\AdManager\V1\Network;
use Google\Ads\AdManager\V1\ProvisionTestNetworkRequest;
use Google\ApiCore\ApiException;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function provision_test_network_sample(): void
{
// Create a client.
$networkServiceClient = new NetworkServiceClient();
// Prepare the request message.
$request = new ProvisionTestNetworkRequest();
// Call the API and handle any network failures.
try {
/** @var Network $response */
$response = $networkServiceClient->provisionTestNetwork($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateNetwork
Updates a Network object. Currently, only the network display name can be
updated.
The async variant is NetworkServiceClient::updateNetworkAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Ads\AdManager\V1\UpdateNetworkRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Ads\AdManager\V1\Network |
|
use Google\Ads\AdManager\V1\Client\NetworkServiceClient;
use Google\Ads\AdManager\V1\Network;
use Google\Ads\AdManager\V1\UpdateNetworkRequest;
use Google\ApiCore\ApiException;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_network_sample(): void
{
// Create a client.
$networkServiceClient = new NetworkServiceClient();
// Prepare the request message.
$network = new Network();
$request = (new UpdateNetworkRequest())
->setNetwork($network);
// Call the API and handle any network failures.
try {
/** @var Network $response */
$response = $networkServiceClient->updateNetwork($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getDefaultThirdPartyDataDeclarationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Ads\AdManager\V1\GetDefaultThirdPartyDataDeclarationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\DefaultThirdPartyDataDeclaration> |
|
getNetworkAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Ads\AdManager\V1\GetNetworkRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\Network> |
|
listNetworksAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Ads\AdManager\V1\ListNetworksRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
provisionTestNetworkAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Ads\AdManager\V1\ProvisionTestNetworkRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\Network> |
|
updateNetworkAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Ads\AdManager\V1\UpdateNetworkRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\Network> |
|
static::adUnitName
Formats a string containing the fully-qualified path to represent a ad_unit resource.
| Parameters | |
|---|---|
| Name | Description |
networkCode |
string
|
adUnit |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted ad_unit resource. |
static::defaultThirdPartyDataDeclarationName
Formats a string containing the fully-qualified path to represent a default_third_party_data_declaration resource.
| Parameter | |
|---|---|
| Name | Description |
networkCode |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted default_third_party_data_declaration resource. |
static::networkName
Formats a string containing the fully-qualified path to represent a network resource.
| Parameter | |
|---|---|
| Name | Description |
networkCode |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted network resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- adUnit: networks/{network_code}/adUnits/{ad_unit}
- defaultThirdPartyDataDeclaration: networks/{network_code}/defaultThirdPartyDataDeclaration
- network: networks/{network_code}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
| Parameters | |
|---|---|
| Name | Description |
formattedName |
string
The formatted name string |
template |
?string
Optional name of template to match |
| Returns | |
|---|---|
| Type | Description |
array |
An associative array from name component IDs to component values. |