Google Ads Data Manager V1 Client - Class UserListDirectLicenseServiceClient (0.2.0)

Reference documentation and code samples for the Google Ads Data Manager V1 Client class UserListDirectLicenseServiceClient.

Service Description: Service for managing user list direct licenses. Delete is not a supported operation for UserListDirectLicenses. Callers should update the license status to DISABLED to instead to deactivate a license.

This feature is only available to data partners.

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 \ DataManager \ 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`	`FetchAuthTokenInterface\|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\DataManager\V1\UserListDirectLicenseServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new UserListDirectLicenseServiceClient(['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\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. 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 = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods 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\|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'.

createUserListDirectLicense

Creates a user list direct license.

This feature is only available to data partners.

The async variant is UserListDirectLicenseServiceClient::createUserListDirectLicenseAsync() .

Parameters
Name	Description
`request`	`Google\Ads\DataManager\V1\CreateUserListDirectLicenseRequest` 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\DataManager\V1\UserListDirectLicense`

Example

use Google\Ads\DataManager\V1\Client\UserListDirectLicenseServiceClient;
use Google\Ads\DataManager\V1\CreateUserListDirectLicenseRequest;
use Google\Ads\DataManager\V1\UserListDirectLicense;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent The account that owns the user list being licensed. Should be in
 *                                the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
 *                                Please see {@see UserListDirectLicenseServiceClient::accountName()} for help formatting this field.
 */
function create_user_list_direct_license_sample(string $formattedParent): void
{
    // Create a client.
    $userListDirectLicenseServiceClient = new UserListDirectLicenseServiceClient();

    // Prepare the request message.
    $userListDirectLicense = new UserListDirectLicense();
    $request = (new CreateUserListDirectLicenseRequest())
        ->setParent($formattedParent)
        ->setUserListDirectLicense($userListDirectLicense);

    // Call the API and handle any network failures.
    try {
        /** @var UserListDirectLicense $response */
        $response = $userListDirectLicenseServiceClient->createUserListDirectLicense($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 = UserListDirectLicenseServiceClient::accountName('[ACCOUNT_TYPE]', '[ACCOUNT]');

    create_user_list_direct_license_sample($formattedParent);
}

getUserListDirectLicense

Retrieves a user list direct license.

This feature is only available to data partners.

The async variant is UserListDirectLicenseServiceClient::getUserListDirectLicenseAsync() .

Parameters
Name	Description
`request`	`Google\Ads\DataManager\V1\GetUserListDirectLicenseRequest` 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\DataManager\V1\UserListDirectLicense`

Example

use Google\Ads\DataManager\V1\Client\UserListDirectLicenseServiceClient;
use Google\Ads\DataManager\V1\GetUserListDirectLicenseRequest;
use Google\Ads\DataManager\V1\UserListDirectLicense;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the user list direct license. Please see
 *                              {@see UserListDirectLicenseServiceClient::userListDirectLicenseName()} for help formatting this field.
 */
function get_user_list_direct_license_sample(string $formattedName): void
{
    // Create a client.
    $userListDirectLicenseServiceClient = new UserListDirectLicenseServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var UserListDirectLicense $response */
        $response = $userListDirectLicenseServiceClient->getUserListDirectLicense($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 = UserListDirectLicenseServiceClient::userListDirectLicenseName(
        '[ACCOUNT_TYPE]',
        '[ACCOUNT]',
        '[USER_LIST_DIRECT_LICENSE]'
    );

    get_user_list_direct_license_sample($formattedName);
}

listUserListDirectLicenses

Lists all user list direct licenses owned by the parent account.

This feature is only available to data partners.

The async variant is UserListDirectLicenseServiceClient::listUserListDirectLicensesAsync() .

Parameters
Name	Description
`request`	`Google\Ads\DataManager\V1\ListUserListDirectLicensesRequest` 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\DataManager\V1\Client\UserListDirectLicenseServiceClient;
use Google\Ads\DataManager\V1\ListUserListDirectLicensesRequest;
use Google\Ads\DataManager\V1\UserListDirectLicense;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The account whose licenses are being queried. Should be in the
 *                                format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
 *                                Please see {@see UserListDirectLicenseServiceClient::accountName()} for help formatting this field.
 */
function list_user_list_direct_licenses_sample(string $formattedParent): void
{
    // Create a client.
    $userListDirectLicenseServiceClient = new UserListDirectLicenseServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $userListDirectLicenseServiceClient->listUserListDirectLicenses($request);

        /** @var UserListDirectLicense $element */
        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 = UserListDirectLicenseServiceClient::accountName('[ACCOUNT_TYPE]', '[ACCOUNT]');

    list_user_list_direct_licenses_sample($formattedParent);
}

updateUserListDirectLicense

Updates a user list direct license.

This feature is only available to data partners.

The async variant is UserListDirectLicenseServiceClient::updateUserListDirectLicenseAsync() .

Parameters
Name	Description
`request`	`Google\Ads\DataManager\V1\UpdateUserListDirectLicenseRequest` 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\DataManager\V1\UserListDirectLicense`

Example

use Google\Ads\DataManager\V1\Client\UserListDirectLicenseServiceClient;
use Google\Ads\DataManager\V1\UpdateUserListDirectLicenseRequest;
use Google\Ads\DataManager\V1\UserListDirectLicense;
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_user_list_direct_license_sample(): void
{
    // Create a client.
    $userListDirectLicenseServiceClient = new UserListDirectLicenseServiceClient();

    // Prepare the request message.
    $userListDirectLicense = new UserListDirectLicense();
    $request = (new UpdateUserListDirectLicenseRequest())
        ->setUserListDirectLicense($userListDirectLicense);

    // Call the API and handle any network failures.
    try {
        /** @var UserListDirectLicense $response */
        $response = $userListDirectLicenseServiceClient->updateUserListDirectLicense($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

createUserListDirectLicenseAsync

Parameters
Name	Description
`request`	`Google\Ads\DataManager\V1\CreateUserListDirectLicenseRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\DataManager\V1\UserListDirectLicense>`

getUserListDirectLicenseAsync

Parameters
Name	Description
`request`	`Google\Ads\DataManager\V1\GetUserListDirectLicenseRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\DataManager\V1\UserListDirectLicense>`

listUserListDirectLicensesAsync

Parameters
Name	Description
`request`	`Google\Ads\DataManager\V1\ListUserListDirectLicensesRequest`
`optionalArgs`	`array`

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

updateUserListDirectLicenseAsync

Parameters
Name	Description
`request`	`Google\Ads\DataManager\V1\UpdateUserListDirectLicenseRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\DataManager\V1\UserListDirectLicense>`

static::accountName

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

Parameters
Name	Description
`accountType`	`string`
`account`	`string`

Returns
Type	Description
`string`	The formatted account resource.

static::userListDirectLicenseName

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

Parameters
Name	Description
`accountType`	`string`
`account`	`string`
`userListDirectLicense`	`string`

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

account: accountTypes/{account_type}/accounts/{account}
userListDirectLicense: accountTypes/{account_type}/accounts/{account}/userListDirectLicenses/{user_list_direct_license}

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 Data Manager V1 Client - Class UserListDirectLicenseServiceClient (0.2.0) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

createUserListDirectLicense

getUserListDirectLicense

listUserListDirectLicenses

updateUserListDirectLicense

createUserListDirectLicenseAsync

getUserListDirectLicenseAsync

listUserListDirectLicensesAsync

updateUserListDirectLicenseAsync

static::accountName

static::userListDirectLicenseName

static::parseName

Google Ads Data Manager V1 Client - Class UserListDirectLicenseServiceClient (0.2.0)