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

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

Service Description: Provides methods for handling Partner 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\PartnerServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new PartnerServiceClient(['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'.

batchUpdatePartners

Batch updates Partner objects.

The async variant is PartnerServiceClient::batchUpdatePartnersAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchUpdatePartnersRequest` 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\BatchUpdatePartnersResponse`

Example

use Google\Ads\AdManager\V1\BatchUpdatePartnersRequest;
use Google\Ads\AdManager\V1\BatchUpdatePartnersResponse;
use Google\Ads\AdManager\V1\Client\PartnerServiceClient;
use Google\Ads\AdManager\V1\Partner;
use Google\Ads\AdManager\V1\UpdatePartnerRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent            The parent resource where
 *                                           [Partner][google.ads.admanager.v1.Partner]s will be updated. Format:
 *                                           `networks/{network_code}` The parent field in the
 *                                           [UpdatePartnerRequest][google.ads.admanager.v1.UpdatePartnerRequest] must
 *                                           match this field. Please see
 *                                           {@see PartnerServiceClient::networkName()} for help formatting this field.
 * @param string $requestsPartnerDisplayName The display name of the
 *                                           [Partner][google.ads.admanager.v1.Partner].
 */
function batch_update_partners_sample(
    string $formattedParent,
    string $requestsPartnerDisplayName
): void {
    // Create a client.
    $partnerServiceClient = new PartnerServiceClient();

    // Prepare the request message.
    $requestsPartner = (new Partner())
        ->setDisplayName($requestsPartnerDisplayName);
    $updatePartnerRequest = (new UpdatePartnerRequest())
        ->setPartner($requestsPartner);
    $requests = [$updatePartnerRequest,];
    $request = (new BatchUpdatePartnersRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdatePartnersResponse $response */
        $response = $partnerServiceClient->batchUpdatePartners($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 = PartnerServiceClient::networkName('[NETWORK_CODE]');
    $requestsPartnerDisplayName = '[DISPLAY_NAME]';

    batch_update_partners_sample($formattedParent, $requestsPartnerDisplayName);
}

getPartner

Retrieves a Partner object.

The async variant is PartnerServiceClient::getPartnerAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\GetPartnerRequest` 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\Partner`

Example

use Google\Ads\AdManager\V1\Client\PartnerServiceClient;
use Google\Ads\AdManager\V1\GetPartnerRequest;
use Google\Ads\AdManager\V1\Partner;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the
 *                              [Partner][google.ads.admanager.v1.Partner]. Format:
 *                              `networks/{network_code}/partners/{partner_id}`
 *                              Please see {@see PartnerServiceClient::partnerName()} for help formatting this field.
 */
function get_partner_sample(string $formattedName): void
{
    // Create a client.
    $partnerServiceClient = new PartnerServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Partner $response */
        $response = $partnerServiceClient->getPartner($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 = PartnerServiceClient::partnerName('[NETWORK_CODE]', '[PARTNER]');

    get_partner_sample($formattedName);
}

listPartners

Lists Partner objects.

The async variant is PartnerServiceClient::listPartnersAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\ListPartnersRequest` 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\PartnerServiceClient;
use Google\Ads\AdManager\V1\ListPartnersRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $partnerServiceClient->listPartners($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 = PartnerServiceClient::networkName('[NETWORK_CODE]');

    list_partners_sample($formattedParent);
}

updatePartner

Updates a Partner object.

The async variant is PartnerServiceClient::updatePartnerAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\UpdatePartnerRequest` 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\Partner`

Example

use Google\Ads\AdManager\V1\Client\PartnerServiceClient;
use Google\Ads\AdManager\V1\Partner;
use Google\Ads\AdManager\V1\UpdatePartnerRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $partnerDisplayName The display name of the
 *                                   [Partner][google.ads.admanager.v1.Partner].
 */
function update_partner_sample(string $partnerDisplayName): void
{
    // Create a client.
    $partnerServiceClient = new PartnerServiceClient();

    // Prepare the request message.
    $partner = (new Partner())
        ->setDisplayName($partnerDisplayName);
    $request = (new UpdatePartnerRequest())
        ->setPartner($partner);

    // Call the API and handle any network failures.
    try {
        /** @var Partner $response */
        $response = $partnerServiceClient->updatePartner($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
{
    $partnerDisplayName = '[DISPLAY_NAME]';

    update_partner_sample($partnerDisplayName);
}

batchUpdatePartnersAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchUpdatePartnersRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\BatchUpdatePartnersResponse>`

getPartnerAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\GetPartnerRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\Partner>`

listPartnersAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\ListPartnersRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

updatePartnerAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\UpdatePartnerRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\Partner>`

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::labelName

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

Parameters
Name	Description
`networkCode`	`string`
`label`	`string`

Returns
Type	Description
`string`	The formatted label 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::partnerName

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

Parameters
Name	Description
`networkCode`	`string`
`partner`	`string`

Returns
Type	Description
`string`	The formatted partner 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::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}
label: networks/{network_code}/labels/{label}
network: networks/{network_code}
partner: networks/{network_code}/partners/{partner}
team: networks/{network_code}/teams/{team}

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.

Google Ads Ad Manager V1 Client - Class PartnerServiceClient (0.14.1) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

batchUpdatePartners

getPartner

listPartners

updatePartner

batchUpdatePartnersAsync

getPartnerAsync

listPartnersAsync

updatePartnerAsync

static::contactName

static::labelName

static::networkName

static::partnerName

static::teamName

static::parseName

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