Google Shopping Merchant DataSources V1beta Client - Class DataSourcesServiceClient (0.2.3)

Reference documentation and code samples for the Google Shopping Merchant DataSources V1beta Client class DataSourcesServiceClient.

Service Description: Service to manage primary, supplemental, inventory and other data sources.

See more in the Merchant Center help article.

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 \ DataSources \ V1beta \ 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. 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

createDataSource

Creates the new data source configuration for the given account.

The async variant is DataSourcesServiceClient::createDataSourceAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\CreateDataSourceRequest` 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\DataSources\V1beta\DataSource`

Example

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\DataSources\V1beta\Client\DataSourcesServiceClient;
use Google\Shopping\Merchant\DataSources\V1beta\CreateDataSourceRequest;
use Google\Shopping\Merchant\DataSources\V1beta\DataSource;
use Google\Shopping\Merchant\DataSources\V1beta\PrimaryProductDataSource;
use Google\Shopping\Merchant\DataSources\V1beta\PrimaryProductDataSource\Channel;

/**
 * @param string $formattedParent                           The account where this data source will be created.
 *                                                          Format: `accounts/{account}`
 *                                                          Please see {@see DataSourcesServiceClient::accountName()} for help formatting this field.
 * @param int    $dataSourcePrimaryProductDataSourceChannel Immutable. Specifies the type of data source channel.
 * @param string $dataSourceDisplayName                     The displayed data source name in the Merchant Center UI.
 */
function create_data_source_sample(
    string $formattedParent,
    int $dataSourcePrimaryProductDataSourceChannel,
    string $dataSourceDisplayName
): void {
    // Create a client.
    $dataSourcesServiceClient = new DataSourcesServiceClient();

    // Prepare the request message.
    $dataSourcePrimaryProductDataSource = (new PrimaryProductDataSource())
        ->setChannel($dataSourcePrimaryProductDataSourceChannel);
    $dataSource = (new DataSource())
        ->setPrimaryProductDataSource($dataSourcePrimaryProductDataSource)
        ->setDisplayName($dataSourceDisplayName);
    $request = (new CreateDataSourceRequest())
        ->setParent($formattedParent)
        ->setDataSource($dataSource);

    // Call the API and handle any network failures.
    try {
        /** @var DataSource $response */
        $response = $dataSourcesServiceClient->createDataSource($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 = DataSourcesServiceClient::accountName('[ACCOUNT]');
    $dataSourcePrimaryProductDataSourceChannel = Channel::CHANNEL_UNSPECIFIED;
    $dataSourceDisplayName = '[DISPLAY_NAME]';

    create_data_source_sample(
        $formattedParent,
        $dataSourcePrimaryProductDataSourceChannel,
        $dataSourceDisplayName
    );
}

deleteDataSource

Deletes a data source from your Merchant Center account.

The async variant is DataSourcesServiceClient::deleteDataSourceAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\DeleteDataSourceRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\DataSources\V1beta\Client\DataSourcesServiceClient;
use Google\Shopping\Merchant\DataSources\V1beta\DeleteDataSourceRequest;

/**
 * @param string $formattedName The name of the data source to delete.
 *                              Format: `accounts/{account}/dataSources/{datasource}`
 *                              Please see {@see DataSourcesServiceClient::dataSourceName()} for help formatting this field.
 */
function delete_data_source_sample(string $formattedName): void
{
    // Create a client.
    $dataSourcesServiceClient = new DataSourcesServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $dataSourcesServiceClient->deleteDataSource($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 = DataSourcesServiceClient::dataSourceName('[ACCOUNT]', '[DATASOURCE]');

    delete_data_source_sample($formattedName);
}

fetchDataSource

Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead.

This method only works on data sources with a file input set.

The async variant is DataSourcesServiceClient::fetchDataSourceAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\FetchDataSourceRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\DataSources\V1beta\Client\DataSourcesServiceClient;
use Google\Shopping\Merchant\DataSources\V1beta\FetchDataSourceRequest;

/**
 * @param string $formattedName The name of the data source resource to fetch.
 *                              Format: `accounts/{account}/dataSources/{datasource}`
 *                              Please see {@see DataSourcesServiceClient::dataSourceName()} for help formatting this field.
 */
function fetch_data_source_sample(string $formattedName): void
{
    // Create a client.
    $dataSourcesServiceClient = new DataSourcesServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $dataSourcesServiceClient->fetchDataSource($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 = DataSourcesServiceClient::dataSourceName('[ACCOUNT]', '[DATASOURCE]');

    fetch_data_source_sample($formattedName);
}

getDataSource

Retrieves the data source configuration for the given account.

The async variant is DataSourcesServiceClient::getDataSourceAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\GetDataSourceRequest` 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\DataSources\V1beta\DataSource`

Example

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\DataSources\V1beta\Client\DataSourcesServiceClient;
use Google\Shopping\Merchant\DataSources\V1beta\DataSource;
use Google\Shopping\Merchant\DataSources\V1beta\GetDataSourceRequest;

/**
 * @param string $formattedName The name of the data source to retrieve.
 *                              Format: `accounts/{account}/dataSources/{datasource}`
 *                              Please see {@see DataSourcesServiceClient::dataSourceName()} for help formatting this field.
 */
function get_data_source_sample(string $formattedName): void
{
    // Create a client.
    $dataSourcesServiceClient = new DataSourcesServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DataSource $response */
        $response = $dataSourcesServiceClient->getDataSource($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 = DataSourcesServiceClient::dataSourceName('[ACCOUNT]', '[DATASOURCE]');

    get_data_source_sample($formattedName);
}

listDataSources

Lists the configurations for data sources for the given account.

The async variant is DataSourcesServiceClient::listDataSourcesAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\ListDataSourcesRequest` 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\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Shopping\Merchant\DataSources\V1beta\Client\DataSourcesServiceClient;
use Google\Shopping\Merchant\DataSources\V1beta\DataSource;
use Google\Shopping\Merchant\DataSources\V1beta\ListDataSourcesRequest;

/**
 * @param string $formattedParent The account to list data sources for.
 *                                Format: `accounts/{account}`
 *                                Please see {@see DataSourcesServiceClient::accountName()} for help formatting this field.
 */
function list_data_sources_sample(string $formattedParent): void
{
    // Create a client.
    $dataSourcesServiceClient = new DataSourcesServiceClient();

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

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

        /** @var DataSource $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 = DataSourcesServiceClient::accountName('[ACCOUNT]');

    list_data_sources_sample($formattedParent);
}

updateDataSource

Updates the existing data source configuration. The fields that are set in the update mask but not provided in the resource will be deleted.

The async variant is DataSourcesServiceClient::updateDataSourceAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\UpdateDataSourceRequest` 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\DataSources\V1beta\DataSource`

Example

use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;
use Google\Shopping\Merchant\DataSources\V1beta\Client\DataSourcesServiceClient;
use Google\Shopping\Merchant\DataSources\V1beta\DataSource;
use Google\Shopping\Merchant\DataSources\V1beta\PrimaryProductDataSource;
use Google\Shopping\Merchant\DataSources\V1beta\PrimaryProductDataSource\Channel;
use Google\Shopping\Merchant\DataSources\V1beta\UpdateDataSourceRequest;

/**
 * @param int    $dataSourcePrimaryProductDataSourceChannel Immutable. Specifies the type of data source channel.
 * @param string $dataSourceDisplayName                     The displayed data source name in the Merchant Center UI.
 */
function update_data_source_sample(
    int $dataSourcePrimaryProductDataSourceChannel,
    string $dataSourceDisplayName
): void {
    // Create a client.
    $dataSourcesServiceClient = new DataSourcesServiceClient();

    // Prepare the request message.
    $dataSourcePrimaryProductDataSource = (new PrimaryProductDataSource())
        ->setChannel($dataSourcePrimaryProductDataSourceChannel);
    $dataSource = (new DataSource())
        ->setPrimaryProductDataSource($dataSourcePrimaryProductDataSource)
        ->setDisplayName($dataSourceDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdateDataSourceRequest())
        ->setDataSource($dataSource)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var DataSource $response */
        $response = $dataSourcesServiceClient->updateDataSource($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
{
    $dataSourcePrimaryProductDataSourceChannel = Channel::CHANNEL_UNSPECIFIED;
    $dataSourceDisplayName = '[DISPLAY_NAME]';

    update_data_source_sample($dataSourcePrimaryProductDataSourceChannel, $dataSourceDisplayName);
}

createDataSourceAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\CreateDataSourceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\DataSources\V1beta\DataSource>`

deleteDataSourceAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\DeleteDataSourceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

fetchDataSourceAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\FetchDataSourceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

getDataSourceAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\GetDataSourceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\DataSources\V1beta\DataSource>`

listDataSourcesAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\ListDataSourcesRequest`
`optionalArgs`	`array`

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

updateDataSourceAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\DataSources\V1beta\UpdateDataSourceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\DataSources\V1beta\DataSource>`

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::dataSourceName

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

Parameters
Name	Description
`account`	`string`
`datasource`	`string`

Returns
Type	Description
`string`	The formatted data_source 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}
dataSource: accounts/{account}/dataSources/{datasource}

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.