- Resource: DataSource
- PrimaryProductDataSource
- Channel
- SupplementalProductDataSource
- LocalInventoryDataSource
- RegionalInventoryDataSource
- PromotionDataSource
- Input
- FileInput
- FetchSettings
- TimeOfDay
- DayOfWeek
- Frequency
- FileInputType
- Methods
Resource: DataSource
The data source for the Merchant Center account.
JSON representation |
---|
{ "name": string, "dataSourceId": string, "displayName": string, "input": enum ( |
Fields | |
---|---|
name |
Identifier. The name of the data source. Format: |
dataSourceId |
Output only. The data source id. |
displayName |
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. |
fileInput |
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: |
|
primaryProductDataSource |
Required. The primary data source for local and online products. |
supplementalProductDataSource |
Required. The supplemental data source for local and online products. |
localInventoryDataSource |
Required. The local inventory data source. |
regionalInventoryDataSource |
Required. The regional inventory data source. |
promotionDataSource |
Required. The promotion data source. |
PrimaryProductDataSource
The primary data source for local and online products.
JSON representation |
---|
{
"channel": enum ( |
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. |
feedLabel |
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. |
contentLanguage |
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. |
SupplementalProductDataSource
The supplemental data source for local and online products.
JSON representation |
---|
{ "feedLabel": string, "contentLanguage": string } |
Fields | |
---|---|
feedLabel |
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. |
contentLanguage |
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. |
LocalInventoryDataSource
The local inventory data source.
JSON representation |
---|
{ "feedLabel": string, "contentLanguage": string } |
Fields | |
---|---|
feedLabel |
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. |
contentLanguage |
Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. |
RegionalInventoryDataSource
The regional inventory data source.
JSON representation |
---|
{ "feedLabel": string, "contentLanguage": string } |
Fields | |
---|---|
feedLabel |
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. |
contentLanguage |
Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. |
PromotionDataSource
The promotion data source.
JSON representation |
---|
{ "targetCountry": string, "contentLanguage": string } |
Fields | |
---|---|
targetCountry |
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. |
contentLanguage |
Required. Immutable. The two-letter ISO 639-1 language of the items in the 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. |
FileInput
The data specific for file data sources. This field is empty for other data source inputs.
JSON representation |
---|
{ "fetchSettings": { object ( |
Fields | |
---|---|
fetchSettings |
Optional. Fetch details to deliver the data source. It contains settings for |
fileName |
Optional. The file name of the data source. Required for |
fileInputType |
Output only. The type of file input. |
FetchSettings
Fetch details to deliver the data source.
JSON representation |
---|
{ "enabled": boolean, "dayOfMonth": integer, "timeOfDay": { object ( |
Fields | |
---|---|
enabled |
Optional. Enables or pauses the fetch schedule. |
dayOfMonth |
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. |
timeOfDay |
Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored. |
dayOfWeek |
Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency. |
timeZone |
Optional. Time zone used for schedule. UTC by default. For example, "America/Los_Angeles". |
frequency |
Required. The frequency describing fetch schedule. |
fetchUri |
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. |
TimeOfDay
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date
and google.protobuf.Timestamp
.
JSON representation |
---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
Fields | |
---|---|
hours |
Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
minutes |
Minutes of hour of day. Must be from 0 to 59. |
seconds |
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
nanos |
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
DayOfWeek
Represents a day of the week.
Enums | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
The day of the week is unspecified. |
MONDAY |
Monday |
TUESDAY |
Tuesday |
WEDNESDAY |
Wednesday |
THURSDAY |
Thursday |
FRIDAY |
Friday |
SATURDAY |
Saturday |
SUNDAY |
Sunday |
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 [fetchUri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri]. |
GOOGLE_SHEETS |
The file is fetched from Google Sheets specified in the [fetchUri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri]. |
Methods |
|
---|---|
|
Creates the new data source configuration for the given account. |
|
Deletes a data source from your Merchant Center account. |
|
Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. |
|
Retrieves the data source configuration for the given account. |
|
Lists the configurations for data sources for the given account. |
|
Updates the existing data source configuration. |