Types

Index

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 sub-API.

FetchSettings

Fetch details to deliver the data source.

Fields
enabled

bool

Optional. Enables or pauses the fetch schedule.

day_of_month

int32

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

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.

day_of_week

DayOfWeek

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

string

Optional. Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".

frequency

Frequency

Required. The frequency describing fetch schedule.

fetch_uri

string

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

string

Optional. An optional user name for fetch_uri. Used for submitting data sources through SFTP.

password

string

Optional. An optional password for fetch_uri. 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 and time_of_day are required. For a weekly fetch schedule, day_of_week and time_of_day are required. For a daily fetch schedule, only 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_SHEETS The file is fetched from Google Sheets specified in the fetch_uri. However, you can't set up GOOGLE_SHEETS as a data source through the API. To add GOOGLE_SHEETS as a data source through the Merchant Center, see Add products to Merchant Center.

Issue

An error occurring in the data source, like "invalid price".

Fields
title

string

Output only. The title of the issue, for example, "Item too big".

description

string

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

string

Output only. The code of the error, for example, "validation/invalid_value". Returns "?" if the code is unknown.

count

int64

Output only. The number of occurrences of the error in the file upload.

severity

Severity

Output only. The severity of the issue.

documentation_uri

string

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.

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[]

DataSourceReference

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 self and supplemental data sources.

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: [1001, self] will take attribute values from supplemental data source 1001, and fallback to self if the attribute is not set in 1001.

Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If self is missing from the list of take_from_data_sources, the API will ignore attributes from the primary data source itself.

Destination

Destinations also known as Marketing methods selections.

Fields
destination

DestinationEnum

Marketing methods (also known as destination) selections.

state

State

The state of the destination.

State

The state of the destination.

Enums
STATE_UNSPECIFIED Not specified.
ENABLED Indicates that the destination is enabled.
DISABLED Indicates that the destination is disabled.