Package google.shopping.merchant.datasources.v1beta

索引

DataSourcesService

用來管理主要、補充、庫存和其他資料來源的服務。詳情請參閱 Merchant Center 說明文章。

CreateDataSource

rpc CreateDataSource(CreateDataSourceRequest) returns (DataSource)

為指定帳戶建立新的資料來源設定。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 總覽

DeleteDataSource

rpc DeleteDataSource(DeleteDataSourceRequest) returns (Empty)

從 Merchant Center 帳戶中刪除資料來源。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 總覽

FetchDataSource

rpc FetchDataSource(FetchDataSourceRequest) returns (Empty)

這個外掛程式能立即對 Merchant Center 帳戶中的資料來源執行資料擷取作業 (即使是擷取時間表以外)。如果您每天必須呼叫此方法一次以上,請改用「產品」服務更新產品資料。這個方法僅適用於含有檔案輸入集的資料來源。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 總覽

GetDataSource

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

擷取指定帳戶的資料來源設定。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 總覽

ListDataSources

rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse)

列出指定帳戶的資料來源設定。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 總覽

UpdateDataSource

rpc UpdateDataSource(UpdateDataSourceRequest) returns (DataSource)

更新現有的資料來源設定。如果您在更新遮罩中設定的欄位,但未在資源中提供,這些欄位將會遭到刪除。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 總覽

CreateDataSourceRequest

CreateDataSource 方法的要求訊息。

欄位
parent

string

必要欄位。用來建立這個資料來源的帳戶。格式:accounts/{account}

data_source

DataSource

必要欄位。要建立的資料來源。

DataSource

Merchant Center 帳戶的資料來源

欄位
name

string

ID。資料來源的名稱。格式:{datasource.name=accounts/{account}/dataSources/{datasource}}

data_source_id

int64

僅供輸出。資料來源 ID。

display_name

string

必要欄位。Merchant Center UI 中顯示的資料來源名稱。

input

Input

僅供輸出。決定資料來源的輸入類型。視輸入方式而定,某些設定可能無法運作。只有一般資料來源可透過 API 建立。

file_input

FileInput

選用設定。只有在資料透過檔案管理時才能使用這個欄位。

聯集欄位 Type。資料來源類型。Type 只能是下列其中一項:
primary_product_data_source

PrimaryProductDataSource

必要欄位。本地和線上產品的主要資料來源

supplemental_product_data_source

SupplementalProductDataSource

必要欄位。店面和線上產品的補充資料來源

local_inventory_data_source

LocalInventoryDataSource

必要欄位。店面商品目錄資料的資料來源。

regional_inventory_data_source

RegionalInventoryDataSource

必要欄位。區域性商品目錄資料來源。

promotion_data_source

PromotionDataSource

必要欄位。促銷活動資料來源。

輸入內容

決定資料來源的輸入類型。部分輸入設定可能不支援某些設定。

列舉
INPUT_UNSPECIFIED 未指定輸入內容。
API 代表主要透過 API 提供資料的資料來源。
FILE 代表主要透過檔案輸入提供資料的資料來源。您仍可透過 API 提供資料。
UI

在 Merchant Center 中直接新增產品的資料來源。

您只能透過 Merchant Center UI 建立或更新這類資料來源。

這類資料來源為唯讀。

AUTOFEED 這個又稱為自動動態饋給,可自動建立產品資料。您可以透過「帳戶」組合啟用或停用這類資料來源。

DeleteDataSourceRequest

DeleteDataSource 方法的要求訊息。

欄位
name

string

必要欄位。要刪除的資料來源名稱。格式:accounts/{account}/dataSources/{datasource}

FetchDataSourceRequest

FetchDataSource 方法的要求訊息。

欄位
name

string

必要欄位。要擷取的資料來源資源名稱,格式:accounts/{account}/dataSources/{datasource}

FileInput

檔案資料來源專屬資料。其他資料來源輸入的這個欄位為空白。

欄位
fetch_settings

FetchSettings

選用設定。擷取詳細資料以提供資料來源。其中包含 FETCHGOOGLE_SHEETS 檔案輸入類型的設定。必填欄位會因擷取頻率而有所不同。

file_name

string

選用設定。資料來源的檔案名稱。對 UPLOAD 檔案輸入類型而言為必要欄位。

file_input_type

FileInputType

僅供輸出。檔案輸入類型。

FetchSettings

擷取詳細資料以提供資料來源。

欄位
enabled

bool

選用設定。啟用或暫停擷取時間表。

day_of_month

int32

選用設定。要擷取資料來源檔案的日期 (1-31)。這個欄位只能設定為每月頻率。

time_of_day

TimeOfDay

選用設定。要擷取資料來源檔案的時段。系統不支援分鐘數和秒數,因此會予以忽略。

day_of_week

DayOfWeek

選用設定。要擷取資料來源檔案星期幾。這個欄位只能設定每週頻率。

time_zone

string

選用設定。排程使用的時區。根據預設,世界標準時間。例如「America/Los_Angeles」。

frequency

Frequency

必要欄位。說明擷取時間表的頻率。

fetch_uri

string

選用設定。可擷取資料來源檔案的網址。Google Merchant Center 支援使用 HTTP、HTTPS 或 SFTP 通訊協定進行自動排程上傳,因此值必須是使用這三種通訊協定之一的有效連結。Google 試算表檔案不可變動。

username

string

選用設定。[擷取網址][google.shopping.content.bundles.DataSources.FileInput.fetch_url] 的使用者名稱 (選用)。用於透過 SFTP 提交資料來源

password

string

選用設定。[擷取網址][google.shopping.content.bundles.DataSources.FileInput.fetch_url] 的選用密碼。用於透過 SFTP 提交資料來源

頻率

必填欄位會因擷取頻率而有所不同。每月擷取時間表為 [<日期>][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month] 和 [小時][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]。每週擷取時間表須輸入 [星期幾][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week] 和 [小時][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]。每日擷取時間表只需要一個 [小時][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]。

列舉
FREQUENCY_UNSPECIFIED 未指定頻率。
FREQUENCY_DAILY 擷取作業每天都會進行。
FREQUENCY_WEEKLY 擷取作業每週進行。
FREQUENCY_MONTHLY 系統每個月都會執行擷取作業。

FileInputType

檔案傳送方式。

列舉
FILE_INPUT_TYPE_UNSPECIFIED 未指定檔案輸入類型。
UPLOAD 檔案是透過 SFTP、Google Cloud Storage 上傳,或是在 Merchant Center 中手動上傳。
FETCH 系統會從已設定的 [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] 中擷取這個檔案。
GOOGLE_SHEETS 系統會從 [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] 中指定的 Google 試算表擷取此檔案。

GetDataSourceRequest

GetDataSource 方法的要求訊息。

欄位
name

string

必要欄位。要擷取的資料來源名稱。格式:accounts/{account}/dataSources/{datasource}

ListDataSourcesRequest

ListDataSources 方法的要求訊息。

欄位
parent

string

必要欄位。要列出其資料來源的帳戶。格式:accounts/{account}

page_size

int32

選用設定。要傳回的資料來源數量上限。服務傳回的產品數量可能會少於這個值。許可的最大值為 1000;超出的數值將一律指定為 1000。如未指定,則系統傳回的資料來源數量已達上限。

page_token

string

選用設定。屬於接收自前一個 ListDataSources 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListDataSources 的所有其他參數須與提供網頁權杖的呼叫相符。

ListDataSourcesResponse

ListDataSources 方法的回應訊息。

欄位
data_sources[]

DataSource

指定帳戶的資料來源。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

LocalInventoryDataSource

店面商品目錄資料來源。

欄位
feed_label

string

必要欄位。不可變動。店面商品目錄資料的商品動態饋給標籤。

必須小於或等於 20 個大寫英文字母 (A-Z)、數字 (0-9) 和破折號 (-)。

另請參閱「遷移至動態饋給標籤」。

content_language

string

必要欄位。不可變動。店面商品目錄資料所屬商品的雙字母 ISO 639-1 語言。

PrimaryProductDataSource

店面和線上產品的主要資料來源。

欄位
channel

Channel

必要欄位。不可變動。指定資料來源管道的類型。

countries[]

string

選用設定。商品可能顯示的國家/地區。以 CLDR 地域代碼表示。

feed_label

string

選用設定。不可變動。在資料來源層級指定的動態饋給標籤。

必須小於或等於 20 個大寫英文字母 (A-Z)、數字 (0-9) 和破折號 (-)。

另請參閱「遷移至動態饋給標籤」。

對於含有產品內容類型的資料來源,您必須同時設定 feedLabelcontentLanguage 或未設定。必須為含有檔案輸入的資料來源進行設定。

如果設定,資料來源只會接受與這個組合相符的產品。如未設定,資料來源將接受沒有該限制的產品。

content_language

string

選用設定。不可變動。資料來源中項目的 ISO 639-1 語言 (雙字母)。

feedLabelcontentLanguage 必須同時設定或取消設定。只有未輸入檔案的資料來源才能取消設定欄位欄位。

如果設定,資料來源只會接受與這個組合相符的產品。如未設定,資料來源將接受沒有該限制的產品。

頻道

資料來源頻道。

管道可用來區分不同產業的資料來源。

列舉
CHANNEL_UNSPECIFIED 未指定。
ONLINE_PRODUCTS 線上產品。
LOCAL_PRODUCTS 店面產品。
PRODUCTS 店面和線上產品的整合式資料來源。

PromotionDataSource

促銷活動資料來源。

欄位
target_country

string

必要欄位。不可變動。專屬 ID 中所用的指定國家/地區。以 CLDR 地域代碼表示。

促銷活動僅適用於特定國家/地區

content_language

string

必要欄位。不可變動。資料來源中項目的 ISO 639-1 語言 (雙字母)。

RegionalInventoryDataSource

區域商品目錄資料來源。

欄位
feed_label

string

必要欄位。不可變動。提供區域商品目錄的商品的動態饋給標籤。

必須小於或等於 20 個大寫英文字母 (A-Z)、數字 (0-9) 和破折號 (-)。

另請參閱「遷移至動態饋給標籤」。

content_language

string

必要欄位。不可變動。提供區域商品目錄資料的商品的雙字母 ISO 639-1 語言。

SupplementalProductDataSource

店面和線上產品的補充資料來源。

欄位
feed_label

string

選用設定。不可變動。在資料來源層級指定的動態饋給標籤。

必須小於或等於 20 個大寫英文字母 (A-Z)、數字 (0-9) 和破折號 (-)。

另請參閱「遷移至動態饋給標籤」。

對於含有產品內容類型的資料來源,您必須同時設定 feedLabelcontentLanguage 或未設定。必須為含有檔案輸入的資料來源進行設定。

如果設定,資料來源只會接受與這個組合相符的產品。如未設定,資料來源將接受不受該限制影響的產品。

content_language

string

選用設定。不可變動。資料來源中項目的 ISO 639-1 語言 (雙字母)。

feedLabelcontentLanguage 必須同時設定或取消設定。只有未輸入檔案的資料來源才能取消設定欄位欄位。

如果設定,資料來源只會接受與這個組合相符的產品。如未設定,資料來源將接受不受該限制影響的產品。

UpdateDataSourceRequest

UpdateDataSource 方法的要求訊息。

欄位
data_source

DataSource

必要欄位。要更新的資料來源資源。

update_mask

FieldMask

必要欄位。要更新的資料來源欄位清單。

如果在更新遮罩中指定的欄位未指定值,系統會從資料來源刪除這些欄位。

系統不支援為完整資料來源替換提供特殊的「*」值。