Google Ads Ad Manager V1 Client - Class ViewabilityProviderServiceClient (0.14.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class ViewabilityProviderServiceClient.

Service Description: Provides methods for handling ViewabilityProvider 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 \ Client

Methods

__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 use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Ads\AdManager\V1\ViewabilityProviderServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new ViewabilityProviderServiceClient(['credentials' => $creds]); https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
↳ 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 false.
↳ 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 rest. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ 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'.

batchCreateViewabilityProviders

Creates ViewabilityProvider objects.

The async variant is ViewabilityProviderServiceClient::batchCreateViewabilityProvidersAsync() .

Parameters
Name Description
request Google\Ads\AdManager\V1\BatchCreateViewabilityProvidersRequest

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\BatchCreateViewabilityProvidersResponse
Example 
use Google\Ads\AdManager\V1\BatchCreateViewabilityProvidersRequest;
use Google\Ads\AdManager\V1\BatchCreateViewabilityProvidersResponse;
use Google\Ads\AdManager\V1\Client\ViewabilityProviderServiceClient;
use Google\Ads\AdManager\V1\CreateViewabilityProviderRequest;
use Google\Ads\AdManager\V1\ViewabilityProvider;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                                  The parent resource where
 *                                                                 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]s will be
 *                                                                 created. Format: `networks/{network_code}` The parent field in the
 *                                                                 CreateViewabilityProviderRequest must match this field. Please see
 *                                                                 {@see ViewabilityProviderServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent                          The parent resource where this
 *                                                                 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] will be
 *                                                                 created. Format: `networks/{network_code}`
 *                                                                 Please see {@see ViewabilityProviderServiceClient::networkName()} for help formatting this field.
 * @param string $requestsViewabilityProviderDisplayName           The display name of the
 *                                                                 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 * @param string $requestsViewabilityProviderVendorKey             The key for the
 *                                                                 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 * @param string $requestsViewabilityProviderVerificationScriptUrl The URL that hosts the verification script for the
 *                                                                 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 */
function batch_create_viewability_providers_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsViewabilityProviderDisplayName,
    string $requestsViewabilityProviderVendorKey,
    string $requestsViewabilityProviderVerificationScriptUrl
): void {
    // Create a client.
    $viewabilityProviderServiceClient = new ViewabilityProviderServiceClient();

    // Prepare the request message.
    $requestsViewabilityProvider = (new ViewabilityProvider())
        ->setDisplayName($requestsViewabilityProviderDisplayName)
        ->setVendorKey($requestsViewabilityProviderVendorKey)
        ->setVerificationScriptUrl($requestsViewabilityProviderVerificationScriptUrl);
    $createViewabilityProviderRequest = (new CreateViewabilityProviderRequest())
        ->setParent($formattedRequestsParent)
        ->setViewabilityProvider($requestsViewabilityProvider);
    $requests = [$createViewabilityProviderRequest,];
    $request = (new BatchCreateViewabilityProvidersRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateViewabilityProvidersResponse $response */
        $response = $viewabilityProviderServiceClient->batchCreateViewabilityProviders($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
{
    $formattedParent = ViewabilityProviderServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = ViewabilityProviderServiceClient::networkName('[NETWORK_CODE]');
    $requestsViewabilityProviderDisplayName = '[DISPLAY_NAME]';
    $requestsViewabilityProviderVendorKey = '[VENDOR_KEY]';
    $requestsViewabilityProviderVerificationScriptUrl = '[VERIFICATION_SCRIPT_URL]';

    batch_create_viewability_providers_sample(
        $formattedParent,
        $formattedRequestsParent,
        $requestsViewabilityProviderDisplayName,
        $requestsViewabilityProviderVendorKey,
        $requestsViewabilityProviderVerificationScriptUrl
    );
}

batchUpdateViewabilityProviders

Batch updates ViewabilityProvider objects.

The async variant is ViewabilityProviderServiceClient::batchUpdateViewabilityProvidersAsync() .

Parameters
Name Description
request Google\Ads\AdManager\V1\BatchUpdateViewabilityProvidersRequest

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\BatchUpdateViewabilityProvidersResponse
Example 
use Google\Ads\AdManager\V1\BatchUpdateViewabilityProvidersRequest;
use Google\Ads\AdManager\V1\BatchUpdateViewabilityProvidersResponse;
use Google\Ads\AdManager\V1\Client\ViewabilityProviderServiceClient;
use Google\Ads\AdManager\V1\UpdateViewabilityProviderRequest;
use Google\Ads\AdManager\V1\ViewabilityProvider;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                                  The parent resource where
 *                                                                 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]s will be
 *                                                                 updated. Format: `networks/{network_code}` The parent field in the
 *                                                                 UpdateViewabilityProviderRequest must match this field. Please see
 *                                                                 {@see ViewabilityProviderServiceClient::networkName()} for help formatting this field.
 * @param string $requestsViewabilityProviderDisplayName           The display name of the
 *                                                                 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 * @param string $requestsViewabilityProviderVendorKey             The key for the
 *                                                                 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 * @param string $requestsViewabilityProviderVerificationScriptUrl The URL that hosts the verification script for the
 *                                                                 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 */
function batch_update_viewability_providers_sample(
    string $formattedParent,
    string $requestsViewabilityProviderDisplayName,
    string $requestsViewabilityProviderVendorKey,
    string $requestsViewabilityProviderVerificationScriptUrl
): void {
    // Create a client.
    $viewabilityProviderServiceClient = new ViewabilityProviderServiceClient();

    // Prepare the request message.
    $requestsViewabilityProvider = (new ViewabilityProvider())
        ->setDisplayName($requestsViewabilityProviderDisplayName)
        ->setVendorKey($requestsViewabilityProviderVendorKey)
        ->setVerificationScriptUrl($requestsViewabilityProviderVerificationScriptUrl);
    $updateViewabilityProviderRequest = (new UpdateViewabilityProviderRequest())
        ->setViewabilityProvider($requestsViewabilityProvider);
    $requests = [$updateViewabilityProviderRequest,];
    $request = (new BatchUpdateViewabilityProvidersRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateViewabilityProvidersResponse $response */
        $response = $viewabilityProviderServiceClient->batchUpdateViewabilityProviders($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
{
    $formattedParent = ViewabilityProviderServiceClient::networkName('[NETWORK_CODE]');
    $requestsViewabilityProviderDisplayName = '[DISPLAY_NAME]';
    $requestsViewabilityProviderVendorKey = '[VENDOR_KEY]';
    $requestsViewabilityProviderVerificationScriptUrl = '[VERIFICATION_SCRIPT_URL]';

    batch_update_viewability_providers_sample(
        $formattedParent,
        $requestsViewabilityProviderDisplayName,
        $requestsViewabilityProviderVendorKey,
        $requestsViewabilityProviderVerificationScriptUrl
    );
}

createViewabilityProvider

Creates a ViewabilityProvider object.

The async variant is ViewabilityProviderServiceClient::createViewabilityProviderAsync() .

Parameters
Name Description
request Google\Ads\AdManager\V1\CreateViewabilityProviderRequest

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\ViewabilityProvider
Example 
use Google\Ads\AdManager\V1\Client\ViewabilityProviderServiceClient;
use Google\Ads\AdManager\V1\CreateViewabilityProviderRequest;
use Google\Ads\AdManager\V1\ViewabilityProvider;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                          The parent resource where this
 *                                                         [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] will be
 *                                                         created. Format: `networks/{network_code}`
 *                                                         Please see {@see ViewabilityProviderServiceClient::networkName()} for help formatting this field.
 * @param string $viewabilityProviderDisplayName           The display name of the
 *                                                         [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 * @param string $viewabilityProviderVendorKey             The key for the
 *                                                         [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 * @param string $viewabilityProviderVerificationScriptUrl The URL that hosts the verification script for the
 *                                                         [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 */
function create_viewability_provider_sample(
    string $formattedParent,
    string $viewabilityProviderDisplayName,
    string $viewabilityProviderVendorKey,
    string $viewabilityProviderVerificationScriptUrl
): void {
    // Create a client.
    $viewabilityProviderServiceClient = new ViewabilityProviderServiceClient();

    // Prepare the request message.
    $viewabilityProvider = (new ViewabilityProvider())
        ->setDisplayName($viewabilityProviderDisplayName)
        ->setVendorKey($viewabilityProviderVendorKey)
        ->setVerificationScriptUrl($viewabilityProviderVerificationScriptUrl);
    $request = (new CreateViewabilityProviderRequest())
        ->setParent($formattedParent)
        ->setViewabilityProvider($viewabilityProvider);

    // Call the API and handle any network failures.
    try {
        /** @var ViewabilityProvider $response */
        $response = $viewabilityProviderServiceClient->createViewabilityProvider($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
{
    $formattedParent = ViewabilityProviderServiceClient::networkName('[NETWORK_CODE]');
    $viewabilityProviderDisplayName = '[DISPLAY_NAME]';
    $viewabilityProviderVendorKey = '[VENDOR_KEY]';
    $viewabilityProviderVerificationScriptUrl = '[VERIFICATION_SCRIPT_URL]';

    create_viewability_provider_sample(
        $formattedParent,
        $viewabilityProviderDisplayName,
        $viewabilityProviderVendorKey,
        $viewabilityProviderVerificationScriptUrl
    );
}

getViewabilityProvider

Retrieves a ViewabilityProvider object.

The async variant is ViewabilityProviderServiceClient::getViewabilityProviderAsync() .

Parameters
Name Description
request Google\Ads\AdManager\V1\GetViewabilityProviderRequest

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\ViewabilityProvider
Example 
use Google\Ads\AdManager\V1\Client\ViewabilityProviderServiceClient;
use Google\Ads\AdManager\V1\GetViewabilityProviderRequest;
use Google\Ads\AdManager\V1\ViewabilityProvider;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the
 *                              [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]. Format:
 *                              `networks/{network_code}/viewabilityProviders/{viewability_provider}`
 *                              Please see {@see ViewabilityProviderServiceClient::viewabilityProviderName()} for help formatting this field.
 */
function get_viewability_provider_sample(string $formattedName): void
{
    // Create a client.
    $viewabilityProviderServiceClient = new ViewabilityProviderServiceClient();

    // Prepare the request message.
    $request = (new GetViewabilityProviderRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var ViewabilityProvider $response */
        $response = $viewabilityProviderServiceClient->getViewabilityProvider($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 = ViewabilityProviderServiceClient::viewabilityProviderName(
        '[NETWORK_CODE]',
        '[VIEWABILITY_PROVIDER]'
    );

    get_viewability_provider_sample($formattedName);
}

listViewabilityProviders

Lists ViewabilityProvider objects.

The async variant is ViewabilityProviderServiceClient::listViewabilityProvidersAsync() .

Parameters
Name Description
request Google\Ads\AdManager\V1\ListViewabilityProvidersRequest

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
Example 
use Google\Ads\AdManager\V1\Client\ViewabilityProviderServiceClient;
use Google\Ads\AdManager\V1\ListViewabilityProvidersRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent, which owns this collection of
 *                                [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]s.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see ViewabilityProviderServiceClient::networkName()} for help formatting this field.
 */
function list_viewability_providers_sample(string $formattedParent): void
{
    // Create a client.
    $viewabilityProviderServiceClient = new ViewabilityProviderServiceClient();

    // Prepare the request message.
    $request = (new ListViewabilityProvidersRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $viewabilityProviderServiceClient->listViewabilityProviders($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());
    }
}

/**
 * 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
{
    $formattedParent = ViewabilityProviderServiceClient::networkName('[NETWORK_CODE]');

    list_viewability_providers_sample($formattedParent);
}

updateViewabilityProvider

Updates a ViewabilityProvider object.

The async variant is ViewabilityProviderServiceClient::updateViewabilityProviderAsync() .

Parameters
Name Description
request Google\Ads\AdManager\V1\UpdateViewabilityProviderRequest

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\ViewabilityProvider
Example 
use Google\Ads\AdManager\V1\Client\ViewabilityProviderServiceClient;
use Google\Ads\AdManager\V1\UpdateViewabilityProviderRequest;
use Google\Ads\AdManager\V1\ViewabilityProvider;
use Google\ApiCore\ApiException;

/**
 * @param string $viewabilityProviderDisplayName           The display name of the
 *                                                         [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 * @param string $viewabilityProviderVendorKey             The key for the
 *                                                         [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 * @param string $viewabilityProviderVerificationScriptUrl The URL that hosts the verification script for the
 *                                                         [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].
 */
function update_viewability_provider_sample(
    string $viewabilityProviderDisplayName,
    string $viewabilityProviderVendorKey,
    string $viewabilityProviderVerificationScriptUrl
): void {
    // Create a client.
    $viewabilityProviderServiceClient = new ViewabilityProviderServiceClient();

    // Prepare the request message.
    $viewabilityProvider = (new ViewabilityProvider())
        ->setDisplayName($viewabilityProviderDisplayName)
        ->setVendorKey($viewabilityProviderVendorKey)
        ->setVerificationScriptUrl($viewabilityProviderVerificationScriptUrl);
    $request = (new UpdateViewabilityProviderRequest())
        ->setViewabilityProvider($viewabilityProvider);

    // Call the API and handle any network failures.
    try {
        /** @var ViewabilityProvider $response */
        $response = $viewabilityProviderServiceClient->updateViewabilityProvider($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
{
    $viewabilityProviderDisplayName = '[DISPLAY_NAME]';
    $viewabilityProviderVendorKey = '[VENDOR_KEY]';
    $viewabilityProviderVerificationScriptUrl = '[VERIFICATION_SCRIPT_URL]';

    update_viewability_provider_sample(
        $viewabilityProviderDisplayName,
        $viewabilityProviderVendorKey,
        $viewabilityProviderVerificationScriptUrl
    );
}

batchCreateViewabilityProvidersAsync

Parameters
Name Description
request Google\Ads\AdManager\V1\BatchCreateViewabilityProvidersRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\BatchCreateViewabilityProvidersResponse>

batchUpdateViewabilityProvidersAsync

Parameters
Name Description
request Google\Ads\AdManager\V1\BatchUpdateViewabilityProvidersRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\BatchUpdateViewabilityProvidersResponse>

createViewabilityProviderAsync

Parameters
Name Description
request Google\Ads\AdManager\V1\CreateViewabilityProviderRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\ViewabilityProvider>

getViewabilityProviderAsync

Parameters
Name Description
request Google\Ads\AdManager\V1\GetViewabilityProviderRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\ViewabilityProvider>

listViewabilityProvidersAsync

Parameters
Name Description
request Google\Ads\AdManager\V1\ListViewabilityProvidersRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

updateViewabilityProviderAsync

Parameters
Name Description
request Google\Ads\AdManager\V1\UpdateViewabilityProviderRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\ViewabilityProvider>

static::contactName

Formats a string containing the fully-qualified path to represent a contact resource.

Parameters
Name Description
networkCode string
contact string
Returns
Type Description
string The formatted contact 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::teamName

Formats a string containing the fully-qualified path to represent a team resource.

Parameters
Name Description
networkCode string
team string
Returns
Type Description
string The formatted team resource.

static::viewabilityProviderName

Formats a string containing the fully-qualified path to represent a viewability_provider resource.

Parameters
Name Description
networkCode string
viewabilityProvider string
Returns
Type Description
string The formatted viewability_provider 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

  • contact: networks/{network_code}/contacts/{contact}
  • network: networks/{network_code}
  • team: networks/{network_code}/teams/{team}
  • viewabilityProvider: networks/{network_code}/viewabilityProviders/{viewability_provider}

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.