Stay organized with collectionsSave and categorize content based on your preferences.
The Data sources sub-API lets you create and manage data sources specifically
for uploading products through the API. You need to specify at least one data
source to be able to provide product details to the Merchant Center.
This guide walks you through common use cases for managing these API-based data
sources. For information about uploading products using these data sources, see
theAdd and manage productsguide.
You can also manage your data sources through the Merchant Center user
interface. For more information, seeManage your data
sources.
Special considerations
When working with data sources in the Merchant API, keep the following in mind:
Feed rules: The Data sources sub-API supports default feed rules for
linking supplemental data sources to primary data sources. You can manage
the order of supplemental data sources within the default rule. Complex
custom rule creation and management aren't supported directly with this API.
You can manage this using theMerchant Center
UI.
Advanced account supplemental feeds: The API doesn't support
supplemental feeds and rules for advanced (multi-client) accounts. You can
manage these supplemental feeds only using the Merchant Center UI.
Create a primary data source for products
When you create a primary data source, you can choose to restrict it to a
specific feed label and language. If you plan to use feed rules or other
configurations (like country targeting) that apply to specific combinations of
feed labels and languages, specifyfeedLabelandcontentLanguage. This
restricts the data source to a specific label and language. Otherwise, to create
a data source that can accept products with various feed labels and languages,
don't specifyfeedLabelandcontentLanguage.
In addition to setting countries at the data source level, you can target
additional countries for specific products by configuring theshippingfield
in theproductsresource. This offers more granular control.
POST https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources
{"displayName":"My API Primary Product Source","primaryProductDataSource":{}}
A successful request returns the newly-createdDataSourceresource. You can
use thenameof the newly-created data source to refer to this data source
when inserting products with the Products sub-API.
{"name":"accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}","dataSourceId":"{DATASOURCE_ID}","displayName":"My API Primary Product Source","primaryProductDataSource":{},"input":"API"}
The following code samples show how to create aPrimaryProductDataSourcewithout setting thefeedLabelandcontentLanguagefields.
Java
importcom.google.api.gax.core.FixedCredentialsProvider;importcom.google.auth.oauth2.GoogleCredentials;importcom.google.shopping.merchant.datasources.v1.CreateDataSourceRequest;importcom.google.shopping.merchant.datasources.v1.DataSource;importcom.google.shopping.merchant.datasources.v1.DataSourcesServiceClient;importcom.google.shopping.merchant.datasources.v1.DataSourcesServiceSettings;importcom.google.shopping.merchant.datasources.v1.PrimaryProductDataSource;importshopping.merchant.samples.utils.Authenticator;importshopping.merchant.samples.utils.Config;/*** This class demonstrates how to create a primary product data source for all `feedLabel` and* `contentLanguage` combinations.*/publicclassCreatePrimaryProductDataSourceMultipleLanguagesSample{privatestaticStringgetParent(StringmerchantId){returnString.format("accounts/%s",merchantId);}publicstaticStringcreateDataSource(Configconfig,StringdisplayName)throwsException{GoogleCredentialscredential=newAuthenticator().authenticate();DataSourcesServiceSettingsdataSourcesServiceSettings=DataSourcesServiceSettings.newBuilder().setCredentialsProvider(FixedCredentialsProvider.create(credential)).build();Stringparent=getParent(config.getAccountId().toString());// The type of data that this datasource will receive.PrimaryProductDataSourceprimaryProductDataSource=PrimaryProductDataSource.newBuilder().addCountries("GB").build();try(DataSourcesServiceClientdataSourcesServiceClient=DataSourcesServiceClient.create(dataSourcesServiceSettings)){CreateDataSourceRequestrequest=CreateDataSourceRequest.newBuilder().setParent(parent).setDataSource(DataSource.newBuilder().setDisplayName(displayName).setPrimaryProductDataSource(primaryProductDataSource).build()).build();System.out.println("Sending Create PrimaryProduct DataSource request");DataSourceresponse=dataSourcesServiceClient.createDataSource(request);System.out.println("Created DataSource Name below");System.out.println(response.getName());returnresponse.getName();}catch(Exceptione){System.out.println(e);System.exit(1);// Null is necessary to satisfy the compiler as we're not returning a String on failure.returnnull;}}publicstaticvoidmain(String[]args)throwsException{Configconfig=Config.load();// The displayed data source name in the Merchant Center UI.StringdisplayName="Primary Product Data Multiple Languages";createDataSource(config,displayName);}}
use Google\ApiCore\ApiException;use Google\Shopping\Merchant\DataSources\V1\Client\DataSourcesServiceClient;use Google\Shopping\Merchant\DataSources\V1\CreateDataSourceRequest;use Google\Shopping\Merchant\DataSources\V1\DataSource;use Google\Shopping\Merchant\DataSources\V1\PrimaryProductDataSource;/*** This class demonstrates how to create a primary product datasource for all `feedLabel` and* `contentLanguage` combinations.*/class CreatePrimaryProductDataSourceMultipleLanguagesSample{/*** Creates a primary product data source.** @param int $merchantId The Merchant Center account ID.* @param string $displayName The displayed data source name in the Merchant Center UI.** @return string The name of the newly created data source.*/public function createDataSource(int $merchantId, string $displayName): string{// Gets the OAuth credentials to make the request.$credentials = Authentication::useServiceAccountOrTokenFile();// Creates options config containing credentials for the client to use.$options = ['credentials' => $credentials];// Creates a client.$dataSourcesServiceClient = new DataSourcesServiceClient($options);$parent = sprintf('accounts/%s', $merchantId);// The type of data that this datasource will receive.$primaryProductDataSource = (new PrimaryProductDataSource())->setCountries(['GB']);// Calls the API and catches and prints any network failures/errors.try {$response = $dataSourcesServiceClient->createDataSource((new CreateDataSourceRequest())->setParent($parent)->setDataSource((new DataSource())->setDisplayName($displayName)->setPrimaryProductDataSource($primaryProductDataSource)));printf('Created DataSource Name below:' . PHP_EOL);printf('%s' . PHP_EOL, $response->getName());return $response->getName();} catch (ApiException $ex) {printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());exit(1);}}// Helper to execute the sample.public function callSample(): void{$config = Config::generateConfig();// The Merchant Center Account ID.$merchantId = $config['accountId'];// The displayed datasource name in the Merchant Center UI.$displayName = 'Primary Product Data Multiple Languages';self::createDataSource($merchantId, $displayName);}}$sample = new CreatePrimaryProductDataSourceMultipleLanguagesSample();$sample->callSample();
fromexamples.authenticationimportconfigurationfromexamples.authenticationimportgenerate_user_credentialsfromgoogle.shopping.merchant_datasources_v1importCreateDataSourceRequestfromgoogle.shopping.merchant_datasources_v1importDataSourcefromgoogle.shopping.merchant_datasources_v1importDataSourcesServiceClientfromgoogle.shopping.merchant_datasources_v1importPrimaryProductDataSource_ACCOUNT=configuration.Configuration().read_merchant_info()_PARENT=f"accounts/{_ACCOUNT}"defcreate_primary_product_data_source_multiple_languages():"""Creates a `DataSource` resource."""# Gets OAuth Credentials.credentials=generate_user_credentials.main()# Creates a client.client=DataSourcesServiceClient(credentials=credentials)# Creates a PrimaryProductDataSource.primary_datasource=PrimaryProductDataSource()primary_datasource.countries=["GB"]# Creates a DataSource and populates its attributes.data_source=DataSource()data_source.display_name="Example Multiple Languages Primary DataSource"data_source.primary_product_data_source=primary_datasource# Creates the request.request=CreateDataSourceRequest(parent=_PARENT,data_source=data_source)# Makes the request and catches and prints any error messages.try:response=client.create_data_source(request=request)print(f"DataSource successfully created:{response}")exceptRuntimeErrorase:print("DataSource creation failed")print(e)if__name__=="__main__":create_primary_product_data_source_multiple_languages()
curl -X POST \"https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources" \-H "Authorization: Bearer <API_TOKEN>" \-H "Content-Type: application/json" \-d '{"displayName": "Primary Product Data Multiple Languages","primaryProductDataSource": {"countries": ["GB"]}}'
Data source for a specific feed label and language
To create a data source that only accepts products for a specific feed label and
language combination, set thefeedLabelandcontentLanguagefields using thedataSources.createmethod:
POST https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources
{"displayName":"My API Primary Product Source (US-en)","primaryProductDataSource":{"feedLabel":"US","contentLanguage":"en","countries":["US"]}}
A successful request returns the newly-createdDataSourceresource. You can
usenameof the newly-created data source to refer to this data source when
inserting products with the Products sub-API.
{"name":"accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}","dataSourceId":"{DATASOURCE_ID}","displayName":"My API Primary Product Source (US-en)","primaryProductDataSource":{"feedLabel":"US","contentLanguage":"en","countries":["US"]},"input":"API"}
The following code samples show how to create a data source that only accepts
products for a specific feed label and language combination.
Java
importcom.google.api.gax.core.FixedCredentialsProvider;importcom.google.auth.oauth2.GoogleCredentials;importcom.google.shopping.merchant.datasources.v1.CreateDataSourceRequest;importcom.google.shopping.merchant.datasources.v1.DataSource;importcom.google.shopping.merchant.datasources.v1.DataSourcesServiceClient;importcom.google.shopping.merchant.datasources.v1.DataSourcesServiceSettings;importcom.google.shopping.merchant.datasources.v1.PrimaryProductDataSource;importcom.google.shopping.type.Destination.DestinationEnum;importshopping.merchant.samples.utils.Authenticator;importshopping.merchant.samples.utils.Config;/*** This class demonstrates how to create a primary product datasource for the "en" and "GB"* `feedLabel` and `contentLanguage` combination.*/publicclassCreatePrimaryProductDataSourceSample{privatestaticStringgetParent(StringmerchantId){returnString.format("accounts/%s",merchantId);}publicstaticStringcreateDataSource(Configconfig,StringdisplayName)throwsException{GoogleCredentialscredential=newAuthenticator().authenticate();DataSourcesServiceSettingsdataSourcesServiceSettings=DataSourcesServiceSettings.newBuilder().setCredentialsProvider(FixedCredentialsProvider.create(credential)).build();Stringparent=getParent(config.getAccountId().toString());// The type of data that this datasource will receive.PrimaryProductDataSourceprimaryProductDataSource=PrimaryProductDataSource.newBuilder().addCountries("GB").setContentLanguage("en").setFeedLabel("GB")// The destinations do not necessarily have to be explicitly listed in which case the// default enabled destinations will be used..addDestinations(PrimaryProductDataSource.Destination.newBuilder().setDestination(DestinationEnum.SHOPPING_ADS).setState(PrimaryProductDataSource.Destination.State.ENABLED).build()).addDestinations(PrimaryProductDataSource.Destination.newBuilder().setDestination(DestinationEnum.FREE_LISTINGS).setState(PrimaryProductDataSource.Destination.State.DISABLED).build()).build();try(DataSourcesServiceClientdataSourcesServiceClient=DataSourcesServiceClient.create(dataSourcesServiceSettings)){CreateDataSourceRequestrequest=CreateDataSourceRequest.newBuilder().setParent(parent).setDataSource(DataSource.newBuilder().setDisplayName(displayName).setPrimaryProductDataSource(primaryProductDataSource).build()).build();System.out.println("Sending Create PrimaryProduct DataSource request");DataSourceresponse=dataSourcesServiceClient.createDataSource(request);System.out.println("Created DataSource Name below");System.out.println(response.getName());returnresponse.getName();}catch(Exceptione){System.out.println(e);System.exit(1);// Null is necessary to satisfy the compiler as we're not returning a String on failure.returnnull;}}publicstaticvoidmain(String[]args)throwsException{Configconfig=Config.load();// The displayed datasource name in the Merchant Center UI.StringdisplayName="British Primary Product Data";createDataSource(config,displayName);}}
use Google\ApiCore\ApiException;use Google\Shopping\Merchant\DataSources\V1\Client\DataSourcesServiceClient;use Google\Shopping\Merchant\DataSources\V1\CreateDataSourceRequest;use Google\Shopping\Merchant\DataSources\V1\DataSource;use Google\Shopping\Merchant\DataSources\V1\PrimaryProductDataSource;use Google\Shopping\Type\Destination\DestinationEnum;/*** This class demonstrates how to create a primary product datasource for the "en" and "GB"* `feedLabel` and `contentLanguage` combination.*/class CreatePrimaryProductDataSourceSample{/*** A helper function to create the parent string for DataSource resources.** @param string $accountId The Merchant Center account ID.* @return string The parent resource name in the format `accounts/{account_id}`.*/private static function getParent(string $accountId): string{return sprintf("accounts/%s", $accountId);}/*** Creates a new primary product data source.** @param array $config The configuration array containing the account ID.* @param string $displayName The display name for the new data source.* @return void*/public static function createDataSourceSample(array $config, string $displayName): void{// Gets the OAuth credentials to make the request.$credentials = Authentication::useServiceAccountOrTokenFile();// Creates options config containing credentials for the client to use.$options = ['credentials' => $credentials];// Creates a DataSourcesServiceClient.$dataSourcesServiceClient = new DataSourcesServiceClient($options);// Constructs the parent resource name from the account ID.$parent = self::getParent($config['accountId']);// Defines the primary product data source specific settings.$primaryProductDataSource = new PrimaryProductDataSource(['countries' => ['GB'],'content_language' => 'en','feed_label' => 'GB',// The destinations do not necessarily have to be explicitly listed in which case the// default enabled destinations will be used.'destinations' => [new PrimaryProductDataSource\Destination(['destination' => DestinationEnum::SHOPPING_ADS,'state' => PrimaryProductDataSource\Destination\State::ENABLED]),new PrimaryProductDataSource\Destination(['destination' => DestinationEnum::FREE_LISTINGS,'state' => PrimaryProductDataSource\Destination\State::DISABLED])]]);// Creates the DataSource object.$dataSource = new DataSource(['display_name' => $displayName,'primary_product_data_source' => $primaryProductDataSource]);// Prepares the request message to create the data source.$request = new CreateDataSourceRequest(['parent' => $parent,'data_source' => $dataSource]);// Calls the API and catches and prints any network failures/errors.try {print "Sending Create PrimaryProduct DataSource request\n";// Issues the create data source request.$response = $dataSourcesServiceClient->createDataSource($request);print("Created DataSource below\n");print($response->serializeToJsonString() . PHP_EOL);} catch (ApiException $e) {printf("ApiException was thrown: %s\n", $e->getMessage());}}/*** Helper to execute the sample.** @return void*/public function callSample(): void{$config = Config::generateConfig();// The displayed datasource name in the Merchant Center UI.$displayName = "British Primary Product Data";self::createDataSourceSample($config, $displayName);}}// Run the script.$sample = new CreatePrimaryProductDataSourceSample();$sample->callSample();
"""Sample for creating a primary product data source."""fromexamples.authenticationimportconfigurationfromexamples.authenticationimportgenerate_user_credentialsfromgoogle.shopping.merchant_datasources_v1importCreateDataSourceRequestfromgoogle.shopping.merchant_datasources_v1importDataSourcefromgoogle.shopping.merchant_datasources_v1importDataSourcesServiceClientfromgoogle.shopping.merchant_datasources_v1importPrimaryProductDataSource# Used for setting the destination type, e.g., SHOPPING_ADS.fromgoogle.shopping.typeimporttypesasmerchant_api_types# Fetches the Merchant Center account ID from the configuration file.# This ID is essential for constructing the 'parent' resource path# required by the API._ACCOUNT_ID=configuration.Configuration().read_merchant_info()# Constructs the parent resource name format for Data Source operations._PARENT=f"accounts/{_ACCOUNT_ID}"defcreate_primary_product_data_source(display_name:str)->None:"""Creates a primary product data source for the 'en' language and 'GB' region, targeting specific destinations.Args:display_name: The user-visible name for the new data source in MerchantCenter.Returns:The resource name of the newly created data source if successful,otherwise None."""# Obtains OAuth 2.0 credentials for API authentication.credentials=generate_user_credentials.main()# Initializes the DataSourcesServiceClient with the obtained credentials.client=DataSourcesServiceClient(credentials=credentials)# Configures the PrimaryProductDataSource.# This section defines the core properties of the product data feed.primary_product_data_source=PrimaryProductDataSource()# Sets the target countries for this data source.primary_product_data_source.countries=["GB"]# Sets the content language for the products.primary_product_data_source.content_language="en"# Sets the feed label, often matching the country or language.primary_product_data_source.feed_label="GB"# Defines the destinations for this data source and their states.# If destinations are not explicitly listed, defaults will be used.# Configure Shopping Ads destination (enabled).destination_shopping_ads=PrimaryProductDataSource.Destination()destination_shopping_ads.destination=(merchant_api_types.Destination.DestinationEnum.SHOPPING_ADS)destination_shopping_ads.state=(PrimaryProductDataSource.Destination.State.ENABLED)# Configure Free Listings destination (disabled).destination_free_listings=PrimaryProductDataSource.Destination()destination_free_listings.destination=(merchant_api_types.Destination.DestinationEnum.FREE_LISTINGS)destination_free_listings.state=(PrimaryProductDataSource.Destination.State.DISABLED)primary_product_data_source.destinations=[destination_free_listings,destination_shopping_ads]# Assembles the DataSource object.data_source=DataSource()data_source.display_name=display_namedata_source.primary_product_data_source=primary_product_data_source# Prepares the CreateDataSourceRequest.# This request includes the parent account and the data source configuration.request=CreateDataSourceRequest(parent=_PARENT,data_source=data_source)try:# Executes the API call to create the data source.print("Sending Create PrimaryProduct DataSource request")response=client.create_data_source(request=request)# Confirms creation and prints the new data source's name.print("Created DataSource Name below")print(response)exceptRuntimeErrorase:# Handles any errors encountered during the API request.print(e)if__name__=="__main__":# Sets the desired display name for the data source in Merchant Center.datasource_display_name="British Primary Product Data"# Calls the function to create the data source.create_primary_product_data_source(datasource_display_name)
Create a supplemental API data source and link it to a primary data source
Supplemental data sources enable you to provide additional product data that
complements your primary data sources.
Step 1: Create the supplemental API data source
Create a supplemental data source usingdataSources.create.
If you want your supplemental data source to be applicable to any primary data
source, you can omitfeedLabelandcontentLanguage. To target primary data
sources with matching configurations, specifyfeedLabeland `contentLanguage.
POST https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources
{"displayName":"My API Supplemental Source","supplementalProductDataSource":{}}
This returns the newly-created supplementalDataSourceresource. Note itsname(which includes thedataSourceId).
{"name":"accounts/{ACCOUNT_ID}/dataSources/{SUPPLEMENTAL_DATASOURCE_ID}","dataSourceId":"{SUPPLEMENTAL_DATASOURCE_ID}","displayName":"My API Supplemental Source","supplementalProductDataSource":{},"input":"API"}
The following code samples show how to create a supplemental product data source
without setting thefeedLabelandcontentLanguagefields.
Java
importcom.google.api.gax.core.FixedCredentialsProvider;importcom.google.auth.oauth2.GoogleCredentials;importcom.google.shopping.merchant.datasources.v1.CreateDataSourceRequest;importcom.google.shopping.merchant.datasources.v1.DataSource;importcom.google.shopping.merchant.datasources.v1.DataSourcesServiceClient;importcom.google.shopping.merchant.datasources.v1.DataSourcesServiceSettings;importcom.google.shopping.merchant.datasources.v1.SupplementalProductDataSource;importshopping.merchant.samples.utils.Authenticator;importshopping.merchant.samples.utils.Config;/*** This class demonstrates how to create a Supplemental product datasource all `feedLabel` and* `contentLanguage` combinations. This works only for API supplemental feeds.*/publicclassCreateSupplementalProductDataSourceMultipleLanguagesSample{privatestaticStringgetParent(StringmerchantId){returnString.format("accounts/%s",merchantId);}publicstaticStringcreateDataSource(Configconfig,StringdisplayName)throwsException{GoogleCredentialscredential=newAuthenticator().authenticate();DataSourcesServiceSettingsdataSourcesServiceSettings=DataSourcesServiceSettings.newBuilder().setCredentialsProvider(FixedCredentialsProvider.create(credential)).build();Stringparent=getParent(config.getAccountId().toString());try(DataSourcesServiceClientdataSourcesServiceClient=DataSourcesServiceClient.create(dataSourcesServiceSettings)){CreateDataSourceRequestrequest=CreateDataSourceRequest.newBuilder().setParent(parent).setDataSource(DataSource.newBuilder().setDisplayName(displayName).setSupplementalProductDataSource(SupplementalProductDataSource.newBuilder().build()).build()).build();System.out.println("Sending create SupplementalProduct DataSource request");DataSourceresponse=dataSourcesServiceClient.createDataSource(request);System.out.println("Created DataSource Name below");System.out.println(response.getName());returnresponse.getName();}catch(Exceptione){System.out.println(e);System.exit(1);returnnull;// Necessary to satisfy the compiler as we're not returning a// String on failure.}}publicstaticvoidmain(String[]args)throwsException{Configconfig=Config.load();// The displayed data source name in the Merchant Center UI.StringdisplayName="Supplemental API Product Data Multiple Languages";createDataSource(config,displayName);}}
use Google\ApiCore\ApiException;use Google\Shopping\Merchant\DataSources\V1\Client\DataSourcesServiceClient;use Google\Shopping\Merchant\DataSources\V1\CreateDataSourceRequest;use Google\Shopping\Merchant\DataSources\V1\DataSource;use Google\Shopping\Merchant\DataSources\V1\SupplementalProductDataSource;/*** Class to demonstrate creating a Supplemental product datasource for all* `feedLabel` and `contentLanguage` combinations. This works only for API* supplemental feeds.*/class CreateSupplementalProductDataSourceMultipleLanguagesSample{/*** Creates a DataSource.** @param int $merchantId The Merchant Center Account ID.* @param string $displayName The display name of the data source.* @return string The name of the newly created data source.*/public function createDataSource(int $merchantId, string $displayName): string{// Gets the OAuth credentials to make the request.$credentials = Authentication::useServiceAccountOrTokenFile();// Creates options config containing credentials for the client to use.$options = ['credentials' => $credentials];// Creates a client.$dataSourcesServiceClient = new DataSourcesServiceClient($options);$parent = sprintf('accounts/%s', $merchantId);// Creates the data source.$dataSource = (new DataSource())->setDisplayName($displayName)->setSupplementalProductDataSource(new SupplementalProductDataSource());// Creates the request.$request = (new CreateDataSourceRequest())->setParent($parent)->setDataSource($dataSource);print('Sending create SupplementalProduct DataSource request' . PHP_EOL);// Calls the API and catches and prints any network failures/errors.try {$response = $dataSourcesServiceClient->createDataSource($request);print('Created DataSource Name below' . PHP_EOL);print($response->getName() . PHP_EOL);return $response->getName();} catch (ApiException $ex) {print('Call failed with message: ' . $ex->getMessage() . PHP_EOL);return '';}}// Helper to execute the sample.public function callSample(): void{$config = Config::generateConfig();// The Merchant Center Account ID.$merchantId = $config['accountId'];// The displayed datasource name in the Merchant Center UI.$displayName = 'Supplemental API Product Data Multiple Languages';self::createDataSource($merchantId, $displayName);}}$sample = new CreateSupplementalProductDataSourceMultipleLanguagesSample();$sample->callSample();
fromexamples.authenticationimportconfigurationfromexamples.authenticationimportgenerate_user_credentialsfromgoogle.shoppingimportmerchant_datasources_v1_ACCOUNT=configuration.Configuration().read_merchant_info()_PARENT=f"accounts/{_ACCOUNT}"defcreate_supplemental_product_data_source_multiple_languages():"""Creates a `DataSource` resource."""# Gets OAuth Credentials.credentials=generate_user_credentials.main()# Creates a client.client=merchant_datasources_v1.DataSourcesServiceClient(credentials=credentials)# Creates a SupplementalProductDataSource.supplemental_datasource=(merchant_datasources_v1.SupplementalProductDataSource())# Creates a DataSource and populates its attributes.data_source=merchant_datasources_v1.DataSource()data_source.display_name=("Example Multiple Languages Supplemental DataSource")data_source.supplemental_product_data_source=supplemental_datasource# Creates the request.request=merchant_datasources_v1.CreateDataSourceRequest(parent=_PARENT,data_source=data_source)# Makes the request and catches and prints any error messages.try:response=client.create_data_source(request=request)print(f"DataSource successfully created:{response}")exceptRuntimeErrorase:print("DataSource creation failed")print(e)if__name__=="__main__":create_supplemental_product_data_source_multiple_languages()
curl -X POST \"https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources" \-H "Authorization: Bearer <API_TOKEN>" \-H "Content-Type: application/json" \-d '{"displayName": "Supplemental API Product Data Multiple Languages","supplementalProductDataSource": {}}'
Step 2: Link the supplemental data source to a primary data source
Update your primary data source to link to the newly-created supplemental data
source. You can achieve this by modifying thedefaultRuleof thePrimaryProductDataSourcewith thedataSources.updatemethod.
ThetakeFromDataSourceslist in thedefaultRulespecifies the order of
precedence. Attributes are taken from the first data source in the list that
provides them. Theselfshorthand points to the primary data source itself.
The following examples shows the default rule setting which first takes data
from the primary data source and if the attribute is not available there, it
takes the attribute from the supplemental source.
A successful request returns the updated primaryDataSourceresource.
{"name":"accounts/{ACCOUNT_ID}/dataSources/{PRIMARY_DATASOURCE_ID}","dataSourceId":"{PRIMARY_DATASOURCE_ID}","displayName":"My API Primary Product Source","primaryProductDataSource":{"countries":["US","GB","DE"],"defaultRule":{"takeFromDataSources":[{"self":true},{"supplementalDataSourceName":"accounts/{ACCOUNT_ID}/dataSources/{SUPPLEMENTAL_DATASOURCE_ID}"}]}},"input":"API"}
The following code samples show how to connect a supplemental feed to the
primary feed.
Java
importshopping.merchant.samples.datasources.v1.UpdateDataSourceSample;importshopping.merchant.samples.utils.Config;/*** This class demonstrates how to add supplemental DataSources to the primary DataSource's default* rule.*/publicclassAddSupplementalDataSourceToPrimaryDataSourceSample{publicstaticvoidaddSupplementalDataSourceToPrimaryDataSource(Configconfig,StringprimaryDataSourceName,StringfirstSupplementalDataSourceName,StringsecondSupplementalDataSourceName)throwsException{// Update the primary DataSource's default rule to include both supplemental feeds.UpdateDataSourceSampleupdateDatasource=newUpdateDataSourceSample();updateDatasource.updateDataSource(config,primaryDataSourceName,firstSupplementalDataSourceName,secondSupplementalDataSourceName);}publicstaticvoidmain(String[]args)throwsException{Configconfig=Config.load();// The names of the primary and supplemental datasources.StringprimaryDataSourceName="accounts/{account_id}/dataSources/{datasource_id}";StringfirstSupplementalDataSourceName="accounts/{account_id}/dataSources/{datasource_id}";StringsecondSupplementalDataSourceName="accounts/{account_id}/dataSources/{datasource_id}";addSupplementalDataSourceToPrimaryDataSource(config,primaryDataSourceName,firstSupplementalDataSourceName,secondSupplementalDataSourceName);}}
You can update properties of an existing data source, such as itsdisplayName.
Use thedataSources.patchmethod and specify the fields to update in theupdateMask.
{"name":"accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}","displayName":"Updated API Primary Source Name"}
A successful request returns the updatedDataSourceresource.
{"name":"accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}","dataSourceId":"{DATASOURCE_ID}","displayName":"Updated API Primary Source Name","primaryProductDataSource":{"feedLabel":"US","contentLanguage":"en","countries":["US"]},"input":"API"}
The following code samples show how to use thepatchmethod to update a data
source.
Java
importcom.google.api.gax.core.FixedCredentialsProvider;importcom.google.auth.oauth2.GoogleCredentials;importcom.google.protobuf.FieldMask;importcom.google.shopping.merchant.datasources.v1.DataSource;importcom.google.shopping.merchant.datasources.v1.DataSourceName;importcom.google.shopping.merchant.datasources.v1.DataSourceReference;importcom.google.shopping.merchant.datasources.v1.DataSourcesServiceClient;importcom.google.shopping.merchant.datasources.v1.DataSourcesServiceSettings;importcom.google.shopping.merchant.datasources.v1.PrimaryProductDataSource;importcom.google.shopping.merchant.datasources.v1.PrimaryProductDataSource.DefaultRule;importcom.google.shopping.merchant.datasources.v1.UpdateDataSourceRequest;importshopping.merchant.samples.utils.Authenticator;importshopping.merchant.samples.utils.Config;/*** This class demonstrates how to update a datasource to change its name in the MC UI. It also* demonstrates how to update a primary datasource to add supplemental datasources to its default* rule (https://support.google.com/merchants/answer/7450276).*/publicclassUpdateDataSourceSample{publicstaticStringupdateDataSource(Configconfig,StringdisplayName,StringdataSourceId)throwsException{GoogleCredentialscredential=newAuthenticator().authenticate();DataSourcesServiceSettingsdataSourcesServiceSettings=DataSourcesServiceSettings.newBuilder().setCredentialsProvider(FixedCredentialsProvider.create(credential)).build();// Creates datasource name to identify datasource.Stringname=DataSourceName.newBuilder().setAccount(config.getAccountId().toString()).setDatasource(dataSourceId).build().toString();DataSourcedataSource=DataSource.newBuilder()// Update the datasource to have the new display name.setDisplayName(displayName).setName(name).build();FieldMaskfieldMask=FieldMask.newBuilder().addPaths("display_name").build();try(DataSourcesServiceClientdataSourcesServiceClient=DataSourcesServiceClient.create(dataSourcesServiceSettings)){UpdateDataSourceRequestrequest=UpdateDataSourceRequest.newBuilder().setDataSource(dataSource).setUpdateMask(fieldMask).build();System.out.println("Sending Update DataSource request");DataSourceresponse=dataSourcesServiceClient.updateDataSource(request);System.out.println("Updated DataSource Name below");System.out.println(response.getName());returnresponse.getName();}catch(Exceptione){System.out.println(e);System.exit(1);returnnull;}}publicStringupdateDataSource(Configconfig,StringprimaryDataSourceName,StringfirstSupplementalDataSourceName,StringsecondSupplementalDataSourceName)throwsException{GoogleCredentialscredential=newAuthenticator().authenticate();DataSourcesServiceSettingsdataSourcesServiceSettings=DataSourcesServiceSettings.newBuilder().setCredentialsProvider(FixedCredentialsProvider.create(credential)).build();// Setting self to 'true' refers to the primary datasource itself.DataSourceReferencedataSourceReferenceSelf=DataSourceReference.newBuilder().setSelf(true).build();DataSourceReferencefirstSupplementalDataSourceReference=DataSourceReference.newBuilder().setSupplementalDataSourceName(firstSupplementalDataSourceName).build();DataSourceReferencesecondSupplementalDataSourceReference=DataSourceReference.newBuilder().setSupplementalDataSourceName(secondSupplementalDataSourceName).build();// The attributes will first be taken from the primary DataSource.// Then the first supplemental DataSource if the attribute is not in the primary DataSource// And finally the second supplemental DataSource if not in the first two DataSources.// Note that CustomRules could change the behavior of how updates are applied.DefaultRuledefaultRule=DefaultRule.newBuilder().addTakeFromDataSources(dataSourceReferenceSelf).addTakeFromDataSources(firstSupplementalDataSourceReference).addTakeFromDataSources(secondSupplementalDataSourceReference).build();// The type of data that this datasource will receive.PrimaryProductDataSourceprimaryProductDataSource=PrimaryProductDataSource.newBuilder().setDefaultRule(defaultRule).build();DataSourcedataSource=DataSource.newBuilder()// Update the primary datasource to have the default rule datasources in the correct// order..setPrimaryProductDataSource(primaryProductDataSource).setName(primaryDataSourceName).build();// The '.' signifies a nested field.FieldMaskfieldMask=FieldMask.newBuilder().addPaths("primary_product_data_source.default_rule").build();try(DataSourcesServiceClientdataSourcesServiceClient=DataSourcesServiceClient.create(dataSourcesServiceSettings)){UpdateDataSourceRequestrequest=UpdateDataSourceRequest.newBuilder().setDataSource(dataSource).setUpdateMask(fieldMask).build();System.out.println("Sending Update DataSource request");DataSourceresponse=dataSourcesServiceClient.updateDataSource(request);System.out.println("Updated DataSource Name below");System.out.println(response.getName());returnresponse.getName();}catch(Exceptione){System.out.println(e);System.exit(1);returnnull;}}publicstaticvoidmain(String[]args)throwsException{Configconfig=Config.load();// The updated displayed datasource name in the Merchant Center UI.StringdisplayName="Great Britain Primary Product Data";// The ID of the datasource to updateStringdataSourceId="11111111";// Replace with your datasource ID.updateDataSource(config,displayName,dataSourceId);}}
use Google\ApiCore\ApiException;use Google\Protobuf\FieldMask;use Google\Shopping\Merchant\DataSources\V1\Client\DataSourcesServiceClient;use Google\Shopping\Merchant\DataSources\V1\DataSource;use Google\Shopping\Merchant\DataSources\V1\UpdateDataSourceRequest;/*** Class to demonstrate updating a datasource to change its name in the MC UI.*/class UpdateDataSourceSample{// ENSURE you fill in the datasource ID for the sample to work.private const DATASOURCE_ID = 'INSERT_DATASOURCE_ID';/*** Updates a DataSource.** @param int $merchantId The Merchant Center Account ID.* @param string $displayName The new display name of the data source.* @param string $dataSourceId The data source ID.* @return string The name of the updated data source.*/public function updateDataSource(int $merchantId, string $displayName, string $dataSourceId): string{// Gets the OAuth credentials to make the request.$credentials = Authentication::useServiceAccountOrTokenFile();// Creates options config containing credentials for the client to use.$options = ['credentials' => $credentials];// Creates a client.$dataSourcesServiceClient = new DataSourcesServiceClient($options);// Creates the data source name.$name = sprintf('accounts/%s/dataSources/%s', $merchantId, $dataSourceId);// Creates the data source.$dataSource = (new DataSource())->setDisplayName($displayName)->setName($name);// Creates a FieldMask to specify which fields to update.$updateMask = new FieldMask(['paths' => ['display_name']]);// Creates the request.$request = (new UpdateDataSourceRequest())->setDataSource($dataSource)->setUpdateMask($updateMask);print('Sending Update DataSource request' . PHP_EOL);// Calls the API and catches and prints any network failures/errors.try {$response = $dataSourcesServiceClient->updateDataSource($request);print('Updated DataSource Name below' . PHP_EOL);print($response->getName() . PHP_EOL);return $response->getName();} catch (ApiException $ex) {print('Call failed with message: ' . $ex->getMessage() . PHP_EOL);return '';}}// Helper to execute the sample.public function callSample(): void{$config = Config::generateConfig();// The Merchant Center Account ID.$merchantId = $config['accountId'];// The updated displayed datasource name in the Merchant Center UI.$displayName = 'new name';self::updateDataSource($merchantId, $displayName, self::DATASOURCE_ID);}}$sample = new UpdateDataSourceSample();$sample->callSample();
fromexamples.authenticationimportconfigurationfromexamples.authenticationimportgenerate_user_credentialsfromgoogle.protobufimportfield_mask_pb2fromgoogle.shoppingimportmerchant_datasources_v1# ENSURE you fill in the datasource ID for the sample to# work._ACCOUNT=configuration.Configuration().read_merchant_info()# An ID automatically assigned to the datasource after creation by Google._DATASOURCE="[INSERT_DATASOURCE_HERE]"_NAME=f"accounts/{_ACCOUNT}/dataSources/{_DATASOURCE}"defupdate_data_source():"""Updates the specified `DataSource` resource."""# Gets OAuth Credentials.credentials=generate_user_credentials.main()# Creates a client.client=merchant_datasources_v1.DataSourcesServiceClient(credentials=credentials)# Creates a DataSource and populates its attributes.data_source=merchant_datasources_v1.DataSource()data_source.name=_NAME# To identify the data source to update.data_source.display_name="Example DataSource 2"# Sets field mask to include only the fields you want to update.field_mask=field_mask_pb2.FieldMask(paths=["display_name"])# Creates the request.request=merchant_datasources_v1.UpdateDataSourceRequest(data_source=data_source,update_mask=field_mask)# Makes the request and catch and print any error messages.try:client.update_data_source(request=request)print("Update successful")exceptRuntimeErrorase:print("Update failed")print(e)if__name__=="__main__":update_data_source()
curl -X PATCH \"https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}?updateMask=displayName" \-H "Authorization: Bearer <API_TOKEN>" \-H "Content-Type: application/json" \-d '{"name": "accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}","displayName": "New Display Name for API Feed"}'
Delete a data source
To remove a data source from your Merchant Center account, use thedataSources.deletemethod. If a supplemental data source is linked to any primary data source, you
won't be able to delete it until you remove all links to it.
The following code samples show how to use thedeletemethod to delete a data
source.
Java
importcom.google.api.gax.core.FixedCredentialsProvider;importcom.google.auth.oauth2.GoogleCredentials;importcom.google.shopping.merchant.datasources.v1.DataSourceName;importcom.google.shopping.merchant.datasources.v1.DataSourcesServiceClient;importcom.google.shopping.merchant.datasources.v1.DataSourcesServiceSettings;importcom.google.shopping.merchant.datasources.v1.DeleteDataSourceRequest;importshopping.merchant.samples.utils.Authenticator;importshopping.merchant.samples.utils.Config;/** This class demonstrates how to delete a datasource. */publicclassDeleteDataSourceSample{publicstaticvoiddeleteDataSource(Configconfig,StringdataSourceId)throwsException{GoogleCredentialscredential=newAuthenticator().authenticate();DataSourcesServiceSettingsdataSourcesServiceSettings=DataSourcesServiceSettings.newBuilder().setCredentialsProvider(FixedCredentialsProvider.create(credential)).build();Stringname=DataSourceName.newBuilder().setAccount(config.getAccountId().toString()).setDatasource(dataSourceId).build().toString();try(DataSourcesServiceClientdataSourcesServiceClient=DataSourcesServiceClient.create(dataSourcesServiceSettings)){DeleteDataSourceRequestrequest=DeleteDataSourceRequest.newBuilder().setName(name).build();System.out.println("Sending deleteDataSource request");// Delete works for any datasource type.// If Type "Supplemental", delete will only work if it's not linked to any primary feed.// If a link exists and the Type is "Supplemental", you will need to remove the supplemental// feed from the default and/or custom rule(s) of any primary feed(s) that references it. Then// retry the delete.dataSourcesServiceClient.deleteDataSource(request);// No response returned on success.System.out.println("Delete successful, note that it may take a few minutes for the delete to update in"+" the system.");}catch(Exceptione){System.out.println(e);}}publicstaticvoidmain(String[]args)throwsException{Configconfig=Config.load();// An ID automatically assigned to the datasource after creation by Google.StringdataSourceId="1111111111";// Replace with your datasource ID.deleteDataSource(config,dataSourceId);}}
use Google\ApiCore\ApiException;use Google\Shopping\Merchant\DataSources\V1\Client\DataSourcesServiceClient;use Google\Shopping\Merchant\DataSources\V1\DeleteDataSourceRequest;/*** Class to demonstrate deleting a datasource.*/class DeleteDataSourceSample{// ENSURE you fill in the datasource ID for the sample to work.private const DATASOURCE_ID = 'INSERT_DATASOURCE_ID';/*** Deletes a DataSource.** @param int $merchantId The Merchant Center Account ID.* @param string $dataSourceId The data source ID.*/public function deleteDataSource(int $merchantId, string $dataSourceId): void{// Gets the OAuth credentials to make the request.$credentials = Authentication::useServiceAccountOrTokenFile();// Creates options config containing credentials for the client to use.$options = ['credentials' => $credentials];// Creates a client.$dataSourcesServiceClient = new DataSourcesServiceClient($options);// Creates the data source name.$name = sprintf('accounts/%s/dataSources/%s', $merchantId, $dataSourceId);// Creates the request.$request = (new DeleteDataSourceRequest())->setName($name);print('Sending deleteDataSource request' . PHP_EOL);// Calls the API and catches and prints any network failures/errors.try {$dataSourcesServiceClient->deleteDataSource($request);print('Delete successful, note that it may take a few minutes for the delete to update in the system.' . PHP_EOL);} catch (ApiException $ex) {print('Call failed with message: ' . $ex->getMessage() . PHP_EOL);}}// Helper to execute the sample.public function callSample(): void{$config = Config::generateConfig();// The Merchant Center Account ID.$merchantId = $config['accountId'];self::deleteDataSource($merchantId, self::DATASOURCE_ID);}}$sample = new DeleteDataSourceSample();$sample->callSample();
fromexamples.authenticationimportconfigurationfromexamples.authenticationimportgenerate_user_credentialsfromgoogle.shoppingimportmerchant_datasources_v1# ENSURE you fill in the datasource ID for the sample to# work._ACCOUNT=configuration.Configuration().read_merchant_info()# An ID automatically assigned to the datasource after creation by Google._DATASOURCE="[INSERT_DATASOURCE_HERE]"_NAME=f"accounts/{_ACCOUNT}/dataSources/{_DATASOURCE}"defdelete_data_source():"""Deletes the specified `DataSource` resource.Delete works for any datasource type.If Type "Supplemental", delete will only work if it's not linked to anyprimary feed. If a link exists and the Type is "Supplemental", you will needto remove the supplemental feed from the default and/or custom rule(s) of anyprimary feed(s) that references it. Then retry the delete."""# Gets OAuth Credentials.credentials=generate_user_credentials.main()# Creates a client.client=merchant_datasources_v1.DataSourcesServiceClient(credentials=credentials)# Creates the request.request=merchant_datasources_v1.DeleteDataSourceRequest(name=_NAME)# Makes the request and catches and prints any error messages.try:# No response is returned on request.client.delete_data_source(request=request)print("Deletion successful")exceptRuntimeErrorase:print("Deletion failed")print(e)if__name__=="__main__":delete_data_source()
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-12 UTC."],[],[],null,[]]