Reference documentation and code samples for the Google Ads Data Manager V1 Client class UserListServiceClient.
Service Description: Service for managing UserList resources.
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 \ ClientMethods
__construct
Constructor.
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\UserListServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new UserListServiceClient(['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'.
createUserList
Creates a UserList.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
The async variant is UserListServiceClient::createUserListAsync() .
request
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.
use Google\Ads\DataManager\V1\Client\UserListServiceClient;
use Google\Ads\DataManager\V1\CreateUserListRequest;
use Google\Ads\DataManager\V1\UserList;
use Google\ApiCore\ApiException;
/**
* @param string $formattedParent The parent account where this user list will be created.
* Format: accountTypes/{account_type}/accounts/{account}
* Please see {@see UserListServiceClient::accountName()} for help formatting this field.
* @param string $userListDisplayName The display name of the user list.
*/
function create_user_list_sample(string $formattedParent, string $userListDisplayName): void
{
// Create a client.
$userListServiceClient = new UserListServiceClient();
// Prepare the request message.
$userList = (new UserList())
->setDisplayName($userListDisplayName);
$request = (new CreateUserListRequest())
->setParent($formattedParent)
->setUserList($userList);
// Call the API and handle any network failures.
try {
/** @var UserList $response */
$response = $userListServiceClient->createUserList($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 = UserListServiceClient::accountName('[ACCOUNT_TYPE]', '[ACCOUNT]');
$userListDisplayName = '[DISPLAY_NAME]';
create_user_list_sample($formattedParent, $userListDisplayName);
}
deleteUserList
Deletes a UserList.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
The async variant is UserListServiceClient::deleteUserListAsync() .
request
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.
use Google\Ads\DataManager\V1\Client\UserListServiceClient;
use Google\Ads\DataManager\V1\DeleteUserListRequest;
use Google\ApiCore\ApiException;
/**
* @param string $formattedName The name of the user list to delete.
* Format:
* accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
* Please see {@see UserListServiceClient::userListName()} for help formatting this field.
*/
function delete_user_list_sample(string $formattedName): void
{
// Create a client.
$userListServiceClient = new UserListServiceClient();
// Prepare the request message.
$request = (new DeleteUserListRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$userListServiceClient->deleteUserList($request);
printf('Call completed successfully.' . PHP_EOL);
} 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 = UserListServiceClient::userListName('[ACCOUNT_TYPE]', '[ACCOUNT]', '[USER_LIST]');
delete_user_list_sample($formattedName);
}
getUserList
Gets a UserList.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
The async variant is UserListServiceClient::getUserListAsync() .
request
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.
use Google\Ads\DataManager\V1\Client\UserListServiceClient;
use Google\Ads\DataManager\V1\GetUserListRequest;
use Google\Ads\DataManager\V1\UserList;
use Google\ApiCore\ApiException;
/**
* @param string $formattedName The resource name of the UserList to retrieve.
* Format:
* accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
* Please see {@see UserListServiceClient::userListName()} for help formatting this field.
*/
function get_user_list_sample(string $formattedName): void
{
// Create a client.
$userListServiceClient = new UserListServiceClient();
// Prepare the request message.
$request = (new GetUserListRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var UserList $response */
$response = $userListServiceClient->getUserList($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 = UserListServiceClient::userListName('[ACCOUNT_TYPE]', '[ACCOUNT]', '[USER_LIST]');
get_user_list_sample($formattedName);
}
listUserLists
Lists UserLists.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
The async variant is UserListServiceClient::listUserListsAsync() .
request
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.
use Google\Ads\DataManager\V1\Client\UserListServiceClient;
use Google\Ads\DataManager\V1\ListUserListsRequest;
use Google\Ads\DataManager\V1\UserList;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
/**
* @param string $formattedParent The parent account which owns this collection of user lists.
* Format: accountTypes/{account_type}/accounts/{account}
* Please see {@see UserListServiceClient::accountName()} for help formatting this field.
*/
function list_user_lists_sample(string $formattedParent): void
{
// Create a client.
$userListServiceClient = new UserListServiceClient();
// Prepare the request message.
$request = (new ListUserListsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $userListServiceClient->listUserLists($request);
/** @var UserList $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 = UserListServiceClient::accountName('[ACCOUNT_TYPE]', '[ACCOUNT]');
list_user_lists_sample($formattedParent);
}
updateUserList
Updates a UserList.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
The async variant is UserListServiceClient::updateUserListAsync() .
request
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.
use Google\Ads\DataManager\V1\Client\UserListServiceClient;
use Google\Ads\DataManager\V1\UpdateUserListRequest;
use Google\Ads\DataManager\V1\UserList;
use Google\ApiCore\ApiException;
/**
* @param string $userListDisplayName The display name of the user list.
*/
function update_user_list_sample(string $userListDisplayName): void
{
// Create a client.
$userListServiceClient = new UserListServiceClient();
// Prepare the request message.
$userList = (new UserList())
->setDisplayName($userListDisplayName);
$request = (new UpdateUserListRequest())
->setUserList($userList);
// Call the API and handle any network failures.
try {
/** @var UserList $response */
$response = $userListServiceClient->updateUserList($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
{
$userListDisplayName = '[DISPLAY_NAME]';
update_user_list_sample($userListDisplayName);
}
createUserListAsync
optionalArgs
array
deleteUserListAsync
optionalArgs
array
getUserListAsync
listUserListsAsync
optionalArgs
array
updateUserListAsync
optionalArgs
array
static::accountName
Formats a string containing the fully-qualified path to represent a account resource.
accountType
string
account
string
string
static::userListName
Formats a string containing the fully-qualified path to represent a user_list resource.
accountType
string
account
string
userList
string
string
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}
- userList: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
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.
formattedName
string
The formatted name string
template
?string
Optional name of template to match
array
