Reference documentation and code samples for the Google Shopping Merchant Products V1beta Client class ProductInputsServiceClient.
Service Description: Service to use ProductInput resource.
This service works for products with online channel only.
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 \ Products \ 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
deleteProductInput
Deletes a product input from your Merchant Center account.
After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
The async variant is ProductInputsServiceClient::deleteProductInputAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Products\V1beta\DeleteProductInputRequest
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. |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Products\V1beta\Client\ProductInputsServiceClient;
use Google\Shopping\Merchant\Products\V1beta\DeleteProductInputRequest;
/**
* @param string $formattedName The name of the product input resource to delete.
* Format: accounts/{account}/productInputs/{product}
* where the last section `product` consists of 4 parts:
* channel~content_language~feed_label~offer_id
* example for product name is
* "accounts/123/productInputs/online~en~US~sku123"
* Please see {@see ProductInputsServiceClient::productInputName()} for help formatting this field.
* @param string $dataSource The primary or supplemental data source from which the product
* input should be deleted. Format:
* `accounts/{account}/dataSources/{datasource}`.
*/
function delete_product_input_sample(string $formattedName, string $dataSource): void
{
// Create a client.
$productInputsServiceClient = new ProductInputsServiceClient();
// Prepare the request message.
$request = (new DeleteProductInputRequest())
->setName($formattedName)
->setDataSource($dataSource);
// Call the API and handle any network failures.
try {
$productInputsServiceClient->deleteProductInput($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 = ProductInputsServiceClient::productInputName('[ACCOUNT]', '[PRODUCTINPUT]');
$dataSource = '[DATA_SOURCE]';
delete_product_input_sample($formattedName, $dataSource);
}
insertProductInput
Uploads a product input to your Merchant Center account. If an input with the same contentLanguage, offerId, and dataSource already exists, this method replaces that entry.
After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
The async variant is ProductInputsServiceClient::insertProductInputAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Products\V1beta\InsertProductInputRequest
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\Products\V1beta\ProductInput |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Products\V1beta\Client\ProductInputsServiceClient;
use Google\Shopping\Merchant\Products\V1beta\InsertProductInputRequest;
use Google\Shopping\Merchant\Products\V1beta\ProductInput;
use Google\Shopping\Type\Channel\ChannelEnum;
/**
* @param string $formattedParent The account where this product will be inserted.
* Format: accounts/{account}
* Please see {@see ProductInputsServiceClient::accountName()} for help formatting this field.
* @param int $productInputChannel Immutable. The
* [channel](https://support.google.com/merchants/answer/7361332) of the
* product.
* @param string $productInputOfferId Immutable. Your unique identifier for the product. This is the
* same for the product input and processed product. Leading and trailing
* whitespaces are stripped and multiple whitespaces are replaced by a single
* whitespace upon submission. See the [products data
* specification](https://support.google.com/merchants/answer/188494#id) for
* details.
* @param string $productInputContentLanguage Immutable. The two-letter [ISO
* 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the
* product.
* @param string $productInputFeedLabel Immutable. The [feed
* label](https://developers.google.com/shopping-content/guides/products/feed-labels)
* for the product.
* @param string $dataSource The primary or supplemental product data source name. If the
* product already exists and data source provided is different, then the
* product will be moved to a new data source. Format:
* `accounts/{account}/dataSources/{datasource}`.
*/
function insert_product_input_sample(
string $formattedParent,
int $productInputChannel,
string $productInputOfferId,
string $productInputContentLanguage,
string $productInputFeedLabel,
string $dataSource
): void {
// Create a client.
$productInputsServiceClient = new ProductInputsServiceClient();
// Prepare the request message.
$productInput = (new ProductInput())
->setChannel($productInputChannel)
->setOfferId($productInputOfferId)
->setContentLanguage($productInputContentLanguage)
->setFeedLabel($productInputFeedLabel);
$request = (new InsertProductInputRequest())
->setParent($formattedParent)
->setProductInput($productInput)
->setDataSource($dataSource);
// Call the API and handle any network failures.
try {
/** @var ProductInput $response */
$response = $productInputsServiceClient->insertProductInput($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 = ProductInputsServiceClient::accountName('[ACCOUNT]');
$productInputChannel = ChannelEnum::CHANNEL_ENUM_UNSPECIFIED;
$productInputOfferId = '[OFFER_ID]';
$productInputContentLanguage = '[CONTENT_LANGUAGE]';
$productInputFeedLabel = '[FEED_LABEL]';
$dataSource = '[DATA_SOURCE]';
insert_product_input_sample(
$formattedParent,
$productInputChannel,
$productInputOfferId,
$productInputContentLanguage,
$productInputFeedLabel,
$dataSource
);
}
deleteProductInputAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Products\V1beta\DeleteProductInputRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
insertProductInputAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Products\V1beta\InsertProductInputRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Products\V1beta\ProductInput> |
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::productInputName
Formats a string containing the fully-qualified path to represent a product_input resource.
Parameters | |
---|---|
Name | Description |
account |
string
|
productinput |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted product_input 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}
- productInput: accounts/{account}/productInputs/{productinput}
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. |