Index
DataSourcesService
(interface)FileUploadsService
(interface)CreateDataSourceRequest
(message)DataSource
(message)DataSource.Input
(enum)DataSourceReference
(message)DeleteDataSourceRequest
(message)FetchDataSourceRequest
(message)FileInput
(message)FileInput.FetchSettings
(message)FileInput.FetchSettings.Frequency
(enum)FileInput.FileInputType
(enum)FileUpload
(message)FileUpload.Issue
(message)FileUpload.Issue.Severity
(enum)FileUpload.ProcessingState
(enum)GetDataSourceRequest
(message)GetFileUploadRequest
(message)ListDataSourcesRequest
(message)ListDataSourcesResponse
(message)LocalInventoryDataSource
(message)PrimaryProductDataSource
(message)PrimaryProductDataSource.Channel
(enum)PrimaryProductDataSource.DefaultRule
(message)PromotionDataSource
(message)RegionalInventoryDataSource
(message)SupplementalProductDataSource
(message)UpdateDataSourceRequest
(message)
DataSourcesService
Service to manage primary, supplemental, inventory and other data sources. See more in the Merchant Center help article.
CreateDataSource |
---|
Creates the new data source configuration for the given account.
|
DeleteDataSource |
---|
Deletes a data source from your Merchant Center account.
|
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.
|
GetDataSource |
---|
Retrieves the data source configuration for the given account.
|
ListDataSources |
---|
Lists the configurations for data sources for the given account.
|
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.
|
FileUploadsService
Service to manage data source file uploads.
GetFileUpload |
---|
Gets the latest data source file upload. Only the
|
CreateDataSourceRequest
Request message for the CreateDataSource method.
Fields | |
---|---|
parent |
Required. The account where this data source will be created. Format: |
data_source |
Required. The data source to create. |
DataSource
The data source for the Merchant Center account.
Fields | |
---|---|
name |
Identifier. The name of the data source. Format: |
data_source_id |
Output only. The data source id. |
display_name |
Required. The displayed data source name in the Merchant Center UI. |
input |
Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. |
file_input |
Optional. The field is used only when data is managed through a file. |
Union field Type . The data source type. Type can be only one of the following: |
|
primary_product_data_source |
Required. The primary data source for local and online products. |
supplemental_product_data_source |
Required. The supplemental data source for local and online products. |
local_inventory_data_source |
Required. The local inventory data source. |
regional_inventory_data_source |
Required. The regional inventory data source. |
promotion_data_source |
Required. The promotion data source. |
Input
Determines the type of input to the data source. Based on the input some settings might not be supported.
Enums | |
---|---|
INPUT_UNSPECIFIED |
Input unspecified. |
API |
Represents data sources for which the data is primarily provided through the API. |
FILE |
Represents data sources for which the data is primarily provided through file input. Data can still be provided through the API. |
UI |
The data source for products added directly in Merchant Center. This type of data source can not be created or updated through this API, only by Merchant Center UI. This type of data source is read only. |
AUTOFEED |
This is also known as Automated feeds used to automatically build your product data. This type of data source can be enabled or disabled through the Accounts bundle. |
DataSourceReference
Data source reference can be used to manage related data sources within the data source service.
Fields | |
---|---|
Union field
|
|
self |
Self should be used to reference the primary data source itself. |
primary_data_source_name |
Optional. The name of the primary data source. Format: |
supplemental_data_source_name |
Optional. The name of the supplemental data source. Format: |
DeleteDataSourceRequest
Request message for the DeleteDataSource method.
Fields | |
---|---|
name |
Required. The name of the data source to delete. Format: |
FetchDataSourceRequest
Request message for the FetchDataSource method.
Fields | |
---|---|
name |
Required. The name of the data source resource to fetch. Format: |
FileInput
The data specific for file data sources. This field is empty for other data source inputs.
Fields | |
---|---|
fetch_settings |
Optional. Fetch details to deliver the data source. It contains settings for |
file_name |
Optional. The file name of the data source. Required for |
file_input_type |
Output only. The type of file input. |
FetchSettings
Fetch details to deliver the data source.
Fields | |
---|---|
enabled |
Optional. Enables or pauses the fetch schedule. |
day_of_month |
Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency. |
time_of_day |
Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored. |
day_of_week |
Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency. |
time_zone |
Optional. Time zone used for schedule. UTC by default. For example, "America/Los_Angeles". |
frequency |
Required. The frequency describing fetch schedule. |
fetch_uri |
Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files. |
username |
Optional. An optional user name for [fetch url][google.shopping.content.bundles.DataSources.FileInput.fetch_url]. Used for submitting data sources through SFTP. |
password |
Optional. An optional password for [fetch url][google.shopping.content.bundles.DataSources.FileInput.fetch_url]. Used for submitting data sources through SFTP. |
Frequency
The required fields vary based on the frequency of fetching. For a monthly fetch schedule, [day of month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month] and [hour of day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] are required. For a weekly fetch schedule, [day of week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week] and [hour of day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] are required. For a daily fetch schedule, only an [hour of day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] is required.
Enums | |
---|---|
FREQUENCY_UNSPECIFIED |
Frequency unspecified. |
FREQUENCY_DAILY |
The fetch happens every day. |
FREQUENCY_WEEKLY |
The fetch happens every week. |
FREQUENCY_MONTHLY |
The fetch happens every month. |
FileInputType
The method of file delivery.
Enums | |
---|---|
FILE_INPUT_TYPE_UNSPECIFIED |
File input type unspecified. |
UPLOAD |
The file is uploaded through SFTP, Google Cloud Storage or manually in the Merchant Center. |
FETCH |
The file is fetched from the configured [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri]. |
GOOGLE_SHEETS |
The file is fetched from Google Sheets specified in the [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri]. |
FileUpload
The file upload of a specific data source, that is, the result of the retrieval of the data source at a certain timestamp computed asynchronously when the data source processing is finished. Only applicable to file data sources.
Fields | |
---|---|
name |
Identifier. The name of the data source file upload. Format: |
data_source_id |
Output only. The data source id. |
processing_state |
Output only. The processing state of the data source. |
issues[] |
Output only. The list of issues occurring in the data source. |
items_total |
Output only. The number of items in the data source that were processed. |
items_created |
Output only. The number of items in the data source that were created. |
items_updated |
Output only. The number of items in the data source that were updated. |
upload_time |
Output only. The date at which the file of the data source was uploaded. |
Issue
An error occurring in the data source, like "invalid price".
Fields | |
---|---|
title |
Output only. The title of the issue, for example, "Item too big". |
description |
Output only. The error description, for example, "Your data source contains items which have too many attributes, or are too big. These items will be dropped". |
code |
Output only. The code of the error, for example, "validation/invalid_value". Returns "?" if the code is unknown. |
count |
Output only. The number of occurrences of the error in the file upload. |
severity |
Output only. The severity of the issue. |
documentation_uri |
Output only. Link to the documentation explaining the issue in more details, if available. |
Severity
The severity of the issue.
Enums | |
---|---|
SEVERITY_UNSPECIFIED |
Severity unspecified. |
WARNING |
The issue is the warning. |
ERROR |
The issue is an error. |
ProcessingState
The processing state of the data source.
Enums | |
---|---|
PROCESSING_STATE_UNSPECIFIED |
Processing state unspecified. |
FAILED |
The data source could not be processed or all the items had errors. |
IN_PROGRESS |
The data source is being processed. |
SUCCEEDED |
The data source was processed successfully, though some items might have had errors. |
GetDataSourceRequest
Request message for the GetDataSource method.
Fields | |
---|---|
name |
Required. The name of the data source to retrieve. Format: |
GetFileUploadRequest
Request message for the GetFileUploadRequest method.
Fields | |
---|---|
name |
Required. The name of the data source file upload to retrieve. Format: |
ListDataSourcesRequest
Request message for the ListDataSources method.
Fields | |
---|---|
parent |
Required. The account to list data sources for. Format: |
page_size |
Optional. The maximum number of data sources to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of data sources will be returned. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListDataSourcesResponse
Response message for the ListDataSources method.
Fields | |
---|---|
data_sources[] |
The data sources from the specified account. |
next_page_token |
A token, which can be sent as |
LocalInventoryDataSource
The local inventory data source.
Fields | |
---|---|
feed_label |
Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also migration to feed labels. |
content_language |
Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. |
PrimaryProductDataSource
The primary data source for local and online products.
Fields | |
---|---|
channel |
Required. Immutable. Specifies the type of data source channel. |
countries[] |
Optional. The countries where the items may be displayed. Represented as a CLDR territory code. |
default_rule |
Optional. Default rule management of the data source. If set, the linked data sources will be replaced. |
feed_label |
Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also migration to feed labels.
If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. |
content_language |
Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source.
If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. |
Channel
Data Source Channel.
Channel is used to distinguish between data sources for different product verticals.
Enums | |
---|---|
CHANNEL_UNSPECIFIED |
Not specified. |
ONLINE_PRODUCTS |
Online product. |
LOCAL_PRODUCTS |
Local product. |
PRODUCTS |
Unified data source for both local and online products. Note: Products management through the API is not possible for this channel. |
DefaultRule
Default rule management of the data source.
Fields | |
---|---|
take_from_data_sources[] |
Required. The list of data sources linked in the default rule. This list is ordered by the default rule priority of joining the data. It might include none or multiple references to The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [ |
PromotionDataSource
The promotion data source.
Fields | |
---|---|
target_country |
Required. Immutable. The target country used as part of the unique identifier. Represented as a CLDR territory code. Promotions are only available in selected countries. |
content_language |
Required. Immutable. The two-letter ISO 639-1 language of the items in the data source. |
RegionalInventoryDataSource
The regional inventory data source.
Fields | |
---|---|
feed_label |
Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also migration to feed labels. |
content_language |
Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. |
SupplementalProductDataSource
The supplemental data source for local and online products.
Fields | |
---|---|
referencing_primary_data_sources[] |
Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. |
feed_label |
Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also migration to feed labels.
If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. |
content_language |
Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source.
If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. |
UpdateDataSourceRequest
Request message for the UpdateDataSource method.
Fields | |
---|---|
data_source |
Required. The data source resource to update. |
update_mask |
Required. The list of data source fields to be updated. Fields specified in the update mask without a value specified in the body will be deleted from the data source. Providing special "*" value for full data source replacement is not supported. |