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 總覽。

FileUploadsService

用於管理資料來源檔案上傳作業的服務。

GetFileUpload

rpc GetFileUpload(GetFileUploadRequest) returns (FileUpload)

取得最新上傳的資料來源檔案。檔案上傳作業僅接受 latest 別名。

授權範圍

需要下列 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 使用者介面中顯示的資料來源名稱。
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

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

ProductReviewDataSource

必要欄位。「產品評論」資料來源。
merchant_review_data_source

MerchantReviewDataSource

必要欄位。「商家評論」資料來源。

輸入

決定資料來源的輸入類型。系統可能無法支援部分輸入設定。

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

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

這類資料來源只能透過 Merchant Center 使用者介面建立或更新，無法透過這個 API 操作。

這類資料來源為唯讀。
AUTOFEED 這也稱為「自動動態饋給」，用於自動建立產品資料。您可以透過帳戶套件啟用或停用這類資料來源。

DataSourceReference

資料來源參照可用於管理資料來源服務中的相關資料來源。

欄位

聯集欄位 data_source_id。

data_source_id 只能是下列其中一項：
self

bool

應使用 Self 參照主要資料來源本身。
primary_data_source_name

string

選用設定。主要資料來源的名稱。格式：accounts/{account}/dataSources/{datasource}
supplemental_data_source_name

string

選用設定。補充資料來源的名稱。格式：accounts/{account}/dataSources/{datasource}

DeleteDataSourceRequest

DeleteDataSource 方法的要求訊息。

欄位
name

string

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

FetchDataSourceRequest

針對 FetchDataSource 方法的要求訊息。

欄位
name

string

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

FileInput

檔案資料來源專屬資料。其他資料來源輸入內容的這個欄位會留空。

欄位
fetch_settings

FetchSettings

選用設定。擷取詳細資料以提供資料來源。其中包含 FETCH 和 GOOGLE_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

選用設定。排程使用的時區。預設為世界標準時間 (UTC)。例如「America/Los_Angeles」。
frequency

Frequency

必要欄位。描述擷取排程的頻率。
fetch_uri

string

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

string

選用設定。fetch_uri 的選用使用者名稱。用於透過安全檔案傳輸通訊協定提交資料來源。
password

string

選用設定。fetch_uri 的選用密碼。用於透過安全檔案傳輸通訊協定提交資料來源。

頻率

必要欄位會因擷取頻率而異。如要使用每月擷取時間表，就必須提供 [日] ([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 檔案會透過安全檔案傳輸通訊協定、Google Cloud Storage 或 Merchant Center 手動上傳。
FETCH 系統會從已設定的 fetch_uri 擷取檔案。
GOOGLE_SHEETS 系統會從 fetch_uri 中指定的 Google 試算表擷取檔案。

FileUpload

特定資料來源的檔案上傳，也就是在資料來源處理完成後，以非同步方式計算的特定時間戳記的擷取結果。僅適用於檔案資料來源。

欄位
name

string

ID。資料來源檔案上傳作業的名稱。格式：{datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}
data_source_id

int64

僅供輸出。資料來源 ID。
processing_state

ProcessingState

僅供輸出。資料來源的處理狀態。
issues[]

Issue

僅供輸出。資料來源中發生的問題清單。
items_total

int64

僅供輸出。資料來源中已處理的項目數量。
items_created

int64

僅供輸出。已建立的資料來源項目數量。
items_updated

int64

僅供輸出。已更新的資料來源項目數量。
upload_time

Timestamp

僅供輸出。資料來源檔案的上傳日期。

問題

資料來源發生錯誤，例如「無效的價格」。

欄位
title

string

僅供輸出。問題的標題，例如「商品太大」。
description

string

僅供輸出。錯誤說明，例如「資料來源包含的項目屬性過多或過大，這些項目將會遭到捨棄」。
code

string

僅供輸出。錯誤代碼，例如「validation/invalid_value」。如果代碼不明，則傳回「?」。
count

int64

僅供輸出。檔案上傳時發生錯誤的次數。
severity

Severity

僅供輸出。問題的嚴重程度。
documentation_uri

string

僅供輸出。說明文件連結 (如有)，以便進一步說明問題。

嚴重性

問題的嚴重程度。

列舉
SEVERITY_UNSPECIFIED 未指定嚴重性。
WARNING 問題是警告。
ERROR 問題是錯誤。

ProcessingState

資料來源的處理狀態。

列舉
PROCESSING_STATE_UNSPECIFIED 未指定處理狀態。
FAILED 無法處理資料來源，或是所有項目都發生錯誤。
IN_PROGRESS 系統正在處理資料來源。
SUCCEEDED 資料來源已順利處理，但部分項目可能有錯誤。

GetDataSourceRequest

GetDataSource 方法的要求訊息。

欄位
name

string

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

GetFileUploadRequest

GetFileUploadRequest 方法的要求訊息。

欄位
name

string

必要欄位。要擷取的資料來源檔案上傳作業名稱。格式：accounts/{account}/dataSources/{datasource}/fileUploads/latest

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 語言。

MerchantReviewDataSource

這個類型沒有任何欄位。

商家評論資料來源。

PrimaryProductDataSource

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

欄位
channel

Channel

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

string

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

DefaultRule

選用設定。資料來源的預設規則管理。如果已設值，系統會取代已連結的資料來源。
feed_label

string

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

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

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

對於含有產品內容類型的資料來源，feedLabel 和 contentLanguage 必須同時設為或取消設定。必須為使用檔案輸入的資料來源設定這些屬性。

如果設定了這個值，資料來源只會接受符合此組合的產品。如果未設定，資料來源就會接受沒有這項限制的產品。
content_language

string

選用設定。不可變動。資料來源中商品的雙字母 ISO 639-1 語言代碼。

feedLabel 和 contentLanguage 必須同時設為或取消設定。只有沒有檔案輸入的資料來源才能取消設定這些欄位。

如果設定了這個值，資料來源只會接受符合此組合的產品。如果未設定，資料來源就會接受沒有這項限制的產品。

頻道

資料來源管道。

管道用於區分不同產品類別的資料來源。

列舉
CHANNEL_UNSPECIFIED 不指定。
ONLINE_PRODUCTS 線上產品。
LOCAL_PRODUCTS 店面產品。
PRODUCTS 統一資料來源，適用於店面和線上產品。注意：這個管道無法透過 API 管理產品。

預設規則

資料來源的預設規則管理。

欄位
take_from_data_sources[]

DataSourceReference

必要欄位。在預設規則中連結的資料來源清單。此清單會依據彙整資料的預設規則優先順序排序。可能會包含 self 和補充資料來源的零個或多個參照。

清單不得留空。

如要將資料來源連結至預設規則，您必須在這個清單中依序新增參照。

如要將資料來源與預設規則解除連結，您必須從這份清單中移除指定的參照。

變更這個清單的順序，會導致預設規則中資料來源的優先順序也跟著變更。

舉例來說，提供以下清單 [1001, self] 會採用額外資料來源 1001 的屬性值，如果屬性未在 1001 中設定，則會改用 self。

ProductReviewDataSource

這個類型沒有任何欄位。

產品評論資料來源。

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

店面和網路產品的補充資料來源。建立補充產品資料來源後，請務必將其連結至一或多個主要產品資料來源。

欄位
referencing_primary_data_sources[]

DataSourceReference

僅供輸出。在預設或自訂規則中，與這個資料來源連結的所有主要資料來源 (已排序且去重複) 清單。在移除所有連結之前，無法刪除輔助資料來源。
feed_label

string

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

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

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

如果資料來源的內容類型為產品，feedLabel 和 contentLanguage 必須同時設為或取消設定。

必須為含有 file input 的資料來源設定這些屬性。對於沒有 file input 的資料來源，必須取消設定這些欄位。

如果設定了這個值，資料來源只會接受符合此組合的產品。如果未設定，資料來源就會接受沒有限制的產品。
content_language

string

選用設定。不可變動。資料來源中商品的雙字母 ISO 639-1 語言代碼。

feedLabel 和 contentLanguage 必須同時設為或取消設定。只有沒有檔案輸入的資料來源才能取消設定這些欄位。

如果設定了這個值，資料來源只會接受符合此組合的產品。如果未設定，資料來源就會接受沒有限制的產品。

UpdateDataSourceRequest

針對 UpdateDataSource 方法的要求訊息。

欄位
data_source

DataSource

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

FieldMask

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

如果更新遮罩中指定的欄位未在資料主體中指定值，系統會從資料來源中刪除該欄位。

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