Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class ProgramsServiceClient.
Service Description: Service for program management.
Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant's store to be shown across Google for free.
This service exposes methods to retrieve a merchant's participation in all available programs, in addition to methods for explicitly enabling or disabling participation in each program.
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 \ Shopping \ Merchant \ Accounts \ V1beta \ ClientMethods
__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 |
↳ 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 |
↳ 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. |
disableProgram
Disable participation in the specified program for the account. Executing this method requires admin access.
The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\ProgramsServiceClient::disableProgramAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\DisableProgramRequest
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\Shopping\Merchant\Accounts\V1beta\Program |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1beta\Client\ProgramsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\DisableProgramRequest;
use Google\Shopping\Merchant\Accounts\V1beta\Program;
/**
* @param string $formattedName The name of the program for which to disable participation for
* the given account. Format: `accounts/{account}/programs/{program}`
* Please see {@see ProgramsServiceClient::programName()} for help formatting this field.
*/
function disable_program_sample(string $formattedName): void
{
// Create a client.
$programsServiceClient = new ProgramsServiceClient();
// Prepare the request message.
$request = (new DisableProgramRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Program $response */
$response = $programsServiceClient->disableProgram($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 = ProgramsServiceClient::programName('[ACCOUNT]', '[PROGRAM]');
disable_program_sample($formattedName);
}
enableProgram
Enable participation in the specified program for the account. Executing this method requires admin access.
The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\ProgramsServiceClient::enableProgramAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\EnableProgramRequest
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\Shopping\Merchant\Accounts\V1beta\Program |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1beta\Client\ProgramsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\EnableProgramRequest;
use Google\Shopping\Merchant\Accounts\V1beta\Program;
/**
* @param string $formattedName The name of the program for which to enable participation for the
* given account. Format: `accounts/{account}/programs/{program}`
* Please see {@see ProgramsServiceClient::programName()} for help formatting this field.
*/
function enable_program_sample(string $formattedName): void
{
// Create a client.
$programsServiceClient = new ProgramsServiceClient();
// Prepare the request message.
$request = (new EnableProgramRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Program $response */
$response = $programsServiceClient->enableProgram($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 = ProgramsServiceClient::programName('[ACCOUNT]', '[PROGRAM]');
enable_program_sample($formattedName);
}
getProgram
Retrieves the specified program for the account.
The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\ProgramsServiceClient::getProgramAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\GetProgramRequest
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\Shopping\Merchant\Accounts\V1beta\Program |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1beta\Client\ProgramsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\GetProgramRequest;
use Google\Shopping\Merchant\Accounts\V1beta\Program;
/**
* @param string $formattedName The name of the program to retrieve.
* Format: `accounts/{account}/programs/{program}`
* Please see {@see ProgramsServiceClient::programName()} for help formatting this field.
*/
function get_program_sample(string $formattedName): void
{
// Create a client.
$programsServiceClient = new ProgramsServiceClient();
// Prepare the request message.
$request = (new GetProgramRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Program $response */
$response = $programsServiceClient->getProgram($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 = ProgramsServiceClient::programName('[ACCOUNT]', '[PROGRAM]');
get_program_sample($formattedName);
}
listPrograms
Retrieves all programs for the account.
The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\ProgramsServiceClient::listProgramsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\ListProgramsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Shopping\Merchant\Accounts\V1beta\Client\ProgramsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\ListProgramsRequest;
use Google\Shopping\Merchant\Accounts\V1beta\Program;
/**
* @param string $formattedParent The name of the account for which to retrieve all programs.
* Format: `accounts/{account}`
* Please see {@see ProgramsServiceClient::accountName()} for help formatting this field.
*/
function list_programs_sample(string $formattedParent): void
{
// Create a client.
$programsServiceClient = new ProgramsServiceClient();
// Prepare the request message.
$request = (new ListProgramsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $programsServiceClient->listPrograms($request);
/** @var Program $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 = ProgramsServiceClient::accountName('[ACCOUNT]');
list_programs_sample($formattedParent);
}
disableProgramAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\DisableProgramRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
enableProgramAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\EnableProgramRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getProgramAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\GetProgramRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listProgramsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\ListProgramsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
static::accountName
Formats a string containing the fully-qualified path to represent a account resource.
Parameter | |
---|---|
Name | Description |
account |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted account resource. |
static::programName
Formats a string containing the fully-qualified path to represent a program resource.
Parameters | |
---|---|
Name | Description |
account |
string
|
program |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted program 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: accounts/{account}
- program: accounts/{account}/programs/{program}
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. |