Google Ads Ad Manager V1 Client - Class EntitySignalsMappingServiceClient (0.1.1)

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

Service Description: Provides methods for handling EntitySignalsMapping 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` 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`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ 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\|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.

batchCreateEntitySignalsMappings

API to batch create EntitySignalsMapping objects.

The async variant is Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient::batchCreateEntitySignalsMappingsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchCreateEntitySignalsMappingsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`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\BatchCreateEntitySignalsMappingsResponse`

Example

use Google\Ads\AdManager\V1\BatchCreateEntitySignalsMappingsRequest;
use Google\Ads\AdManager\V1\BatchCreateEntitySignalsMappingsResponse;
use Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient;
use Google\Ads\AdManager\V1\CreateEntitySignalsMappingRequest;
use Google\Ads\AdManager\V1\EntitySignalsMapping;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                                        The parent resource where `EntitySignalsMappings` will be
 *                                                                       created. Format: `networks/{network_code}` The parent field in the
 *                                                                       CreateEntitySignalsMappingRequest must match this field. Please see
 *                                                                       {@see EntitySignalsMappingServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent                                The parent resource where this EntitySignalsMapping will be
 *                                                                       created. Format: `networks/{network_code}`
 *                                                                       Please see {@see EntitySignalsMappingServiceClient::networkName()} for help formatting this field.
 * @param int    $requestsEntitySignalsMappingTaxonomyCategoryIdsElement The IDs of the categories that are associated with the
 *                                                                       referencing entity.
 */
function batch_create_entity_signals_mappings_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    int $requestsEntitySignalsMappingTaxonomyCategoryIdsElement
): void {
    // Create a client.
    $entitySignalsMappingServiceClient = new EntitySignalsMappingServiceClient();

    // Prepare the request message.
    $requestsEntitySignalsMappingTaxonomyCategoryIds = [
        $requestsEntitySignalsMappingTaxonomyCategoryIdsElement,
    ];
    $requestsEntitySignalsMapping = (new EntitySignalsMapping())
        ->setTaxonomyCategoryIds($requestsEntitySignalsMappingTaxonomyCategoryIds);
    $createEntitySignalsMappingRequest = (new CreateEntitySignalsMappingRequest())
        ->setParent($formattedRequestsParent)
        ->setEntitySignalsMapping($requestsEntitySignalsMapping);
    $requests = [$createEntitySignalsMappingRequest,];
    $request = (new BatchCreateEntitySignalsMappingsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateEntitySignalsMappingsResponse $response */
        $response = $entitySignalsMappingServiceClient->batchCreateEntitySignalsMappings($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 = EntitySignalsMappingServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = EntitySignalsMappingServiceClient::networkName('[NETWORK_CODE]');
    $requestsEntitySignalsMappingTaxonomyCategoryIdsElement = 0;

    batch_create_entity_signals_mappings_sample(
        $formattedParent,
        $formattedRequestsParent,
        $requestsEntitySignalsMappingTaxonomyCategoryIdsElement
    );
}

batchUpdateEntitySignalsMappings

API to batch update EntitySignalsMapping objects.

The async variant is Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient::batchUpdateEntitySignalsMappingsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchUpdateEntitySignalsMappingsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`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\BatchUpdateEntitySignalsMappingsResponse`

Example

use Google\Ads\AdManager\V1\BatchUpdateEntitySignalsMappingsRequest;
use Google\Ads\AdManager\V1\BatchUpdateEntitySignalsMappingsResponse;
use Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient;
use Google\Ads\AdManager\V1\EntitySignalsMapping;
use Google\Ads\AdManager\V1\UpdateEntitySignalsMappingRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param string $formattedParent                                        The parent resource where `EntitySignalsMappings` will be
 *                                                                       updated. Format: `networks/{network_code}` The parent field in the
 *                                                                       UpdateEntitySignalsMappingRequest must match this field. Please see
 *                                                                       {@see EntitySignalsMappingServiceClient::networkName()} for help formatting this field.
 * @param int    $requestsEntitySignalsMappingTaxonomyCategoryIdsElement The IDs of the categories that are associated with the
 *                                                                       referencing entity.
 */
function batch_update_entity_signals_mappings_sample(
    string $formattedParent,
    int $requestsEntitySignalsMappingTaxonomyCategoryIdsElement
): void {
    // Create a client.
    $entitySignalsMappingServiceClient = new EntitySignalsMappingServiceClient();

    // Prepare the request message.
    $requestsEntitySignalsMappingTaxonomyCategoryIds = [
        $requestsEntitySignalsMappingTaxonomyCategoryIdsElement,
    ];
    $requestsEntitySignalsMapping = (new EntitySignalsMapping())
        ->setTaxonomyCategoryIds($requestsEntitySignalsMappingTaxonomyCategoryIds);
    $requestsUpdateMask = new FieldMask();
    $updateEntitySignalsMappingRequest = (new UpdateEntitySignalsMappingRequest())
        ->setEntitySignalsMapping($requestsEntitySignalsMapping)
        ->setUpdateMask($requestsUpdateMask);
    $requests = [$updateEntitySignalsMappingRequest,];
    $request = (new BatchUpdateEntitySignalsMappingsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateEntitySignalsMappingsResponse $response */
        $response = $entitySignalsMappingServiceClient->batchUpdateEntitySignalsMappings($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 = EntitySignalsMappingServiceClient::networkName('[NETWORK_CODE]');
    $requestsEntitySignalsMappingTaxonomyCategoryIdsElement = 0;

    batch_update_entity_signals_mappings_sample(
        $formattedParent,
        $requestsEntitySignalsMappingTaxonomyCategoryIdsElement
    );
}

createEntitySignalsMapping

API to create an EntitySignalsMapping object.

The async variant is Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient::createEntitySignalsMappingAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\CreateEntitySignalsMappingRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`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\EntitySignalsMapping`

Example

use Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient;
use Google\Ads\AdManager\V1\CreateEntitySignalsMappingRequest;
use Google\Ads\AdManager\V1\EntitySignalsMapping;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                                The parent resource where this EntitySignalsMapping will be
 *                                                               created. Format: `networks/{network_code}`
 *                                                               Please see {@see EntitySignalsMappingServiceClient::networkName()} for help formatting this field.
 * @param int    $entitySignalsMappingTaxonomyCategoryIdsElement The IDs of the categories that are associated with the
 *                                                               referencing entity.
 */
function create_entity_signals_mapping_sample(
    string $formattedParent,
    int $entitySignalsMappingTaxonomyCategoryIdsElement
): void {
    // Create a client.
    $entitySignalsMappingServiceClient = new EntitySignalsMappingServiceClient();

    // Prepare the request message.
    $entitySignalsMappingTaxonomyCategoryIds = [$entitySignalsMappingTaxonomyCategoryIdsElement,];
    $entitySignalsMapping = (new EntitySignalsMapping())
        ->setTaxonomyCategoryIds($entitySignalsMappingTaxonomyCategoryIds);
    $request = (new CreateEntitySignalsMappingRequest())
        ->setParent($formattedParent)
        ->setEntitySignalsMapping($entitySignalsMapping);

    // Call the API and handle any network failures.
    try {
        /** @var EntitySignalsMapping $response */
        $response = $entitySignalsMappingServiceClient->createEntitySignalsMapping($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 = EntitySignalsMappingServiceClient::networkName('[NETWORK_CODE]');
    $entitySignalsMappingTaxonomyCategoryIdsElement = 0;

    create_entity_signals_mapping_sample(
        $formattedParent,
        $entitySignalsMappingTaxonomyCategoryIdsElement
    );
}

getEntitySignalsMapping

API to retrieve a EntitySignalsMapping object.

The async variant is Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient::getEntitySignalsMappingAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\GetEntitySignalsMappingRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`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\EntitySignalsMapping`

Example

use Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient;
use Google\Ads\AdManager\V1\EntitySignalsMapping;
use Google\Ads\AdManager\V1\GetEntitySignalsMappingRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the EntitySignalsMapping.
 *                              Format:
 *                              `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}`
 *                              Please see {@see EntitySignalsMappingServiceClient::entitySignalsMappingName()} for help formatting this field.
 */
function get_entity_signals_mapping_sample(string $formattedName): void
{
    // Create a client.
    $entitySignalsMappingServiceClient = new EntitySignalsMappingServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var EntitySignalsMapping $response */
        $response = $entitySignalsMappingServiceClient->getEntitySignalsMapping($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 = EntitySignalsMappingServiceClient::entitySignalsMappingName(
        '[NETWORK_CODE]',
        '[ENTITY_SIGNALS_MAPPING]'
    );

    get_entity_signals_mapping_sample($formattedName);
}

listEntitySignalsMappings

API to retrieve a list of EntitySignalsMapping objects.

The async variant is Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient::listEntitySignalsMappingsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\ListEntitySignalsMappingsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`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\EntitySignalsMappingServiceClient;
use Google\Ads\AdManager\V1\ListEntitySignalsMappingsRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent, which owns this collection of EntitySignalsMappings.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see EntitySignalsMappingServiceClient::networkName()} for help formatting this field.
 */
function list_entity_signals_mappings_sample(string $formattedParent): void
{
    // Create a client.
    $entitySignalsMappingServiceClient = new EntitySignalsMappingServiceClient();

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

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

    list_entity_signals_mappings_sample($formattedParent);
}

updateEntitySignalsMapping

API to update an EntitySignalsMapping object.

The async variant is Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient::updateEntitySignalsMappingAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\UpdateEntitySignalsMappingRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`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\EntitySignalsMapping`

Example

use Google\Ads\AdManager\V1\Client\EntitySignalsMappingServiceClient;
use Google\Ads\AdManager\V1\EntitySignalsMapping;
use Google\Ads\AdManager\V1\UpdateEntitySignalsMappingRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param int $entitySignalsMappingTaxonomyCategoryIdsElement The IDs of the categories that are associated with the
 *                                                            referencing entity.
 */
function update_entity_signals_mapping_sample(
    int $entitySignalsMappingTaxonomyCategoryIdsElement
): void {
    // Create a client.
    $entitySignalsMappingServiceClient = new EntitySignalsMappingServiceClient();

    // Prepare the request message.
    $entitySignalsMappingTaxonomyCategoryIds = [$entitySignalsMappingTaxonomyCategoryIdsElement,];
    $entitySignalsMapping = (new EntitySignalsMapping())
        ->setTaxonomyCategoryIds($entitySignalsMappingTaxonomyCategoryIds);
    $updateMask = new FieldMask();
    $request = (new UpdateEntitySignalsMappingRequest())
        ->setEntitySignalsMapping($entitySignalsMapping)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var EntitySignalsMapping $response */
        $response = $entitySignalsMappingServiceClient->updateEntitySignalsMapping($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
{
    $entitySignalsMappingTaxonomyCategoryIdsElement = 0;

    update_entity_signals_mapping_sample($entitySignalsMappingTaxonomyCategoryIdsElement);
}

PromiseInterface

Returns
Type	Description
`void`

static::entitySignalsMappingName

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

Parameters
Name	Description
`networkCode`	`string`
`entitySignalsMapping`	`string`

Returns
Type	Description
`string`	The formatted entity_signals_mapping 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

entitySignalsMapping: networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}
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.