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 アカウントのデータソースでデータをすぐに（取得スケジュール外であっても）取得します。このメソッドを 1 日に 2 回以上呼び出す必要がある場合は、代わりに商品サービスを使用して商品データを更新してください。このメソッドは、ファイル入力が設定されているデータソースでのみ機能します。

認可スコープ

次の 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 で直接追加された商品のデータソース。

このタイプのデータソースは、この API では作成や更新ができず、Merchant Center の UI でのみ更新できます。

このタイプのデータソースは読み取り専用です。
AUTOFEED これは、商品データを自動的に作成するために使用される自動フィードとも呼ばれます。このタイプのデータソースは、アカウント バンドルで有効または無効にできます。

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

省略可。データソース ファイルを取得する曜日。このフィールドは 1 週間の頻度に対してのみ設定できます。
time_zone

string

省略可。スケジュールに使用されるタイムゾーン。デフォルトは UTC です。例: 「America/Los_Angeles」。
frequency

Frequency

必須。取得スケジュールを記述する頻度。
fetch_uri

string

省略可。データソース ファイルを取得できる URL。Google Merchant Center では、HTTP、HTTPS、SFTP の各プロトコルを使用した自動スケジュール設定されたアップロードがサポートされているため、値はこれら 3 つのプロトコルのいずれかを使用した有効なリンクである必要があります。Google スプレッドシート ファイルは変更できません。
username

string

省略可。[fetch url][google.shopping.content.bundles.DataSources.FileInput.fetch_url] のユーザー名（省略可）。SFTP 経由でデータソースを送信する場合に使用します。
password

string

省略可。[fetch url][google.shopping.content.bundles.DataSources.FileInput.fetch_url] のパスワード（省略可）。SFTP 経由でデータソースを送信する場合に使用します。

頻度

必須フィールドは、取得の頻度によって異なります。月単位の取得スケジュールの場合、[day of month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month] と [hour of day][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

省略可。返されるデータソースの最大数。サービスが返す値はこれよりも少ないことがあります。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。指定しない場合は、データソースの最大数が返されます。
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

必須。変更不可。ローカル在庫が指定されている商品アイテムの 2 文字の ISO 639-1 言語。

PrimaryProductDataSource

ローカル商品とオンライン商品のプライマリ データソース。

フィールド
channel

Channel

必須。変更不可。データソース チャネルのタイプを指定します。
countries[]

string

省略可。商品アイテムを表示できる国。CLDR テリトリー コードで表されます。
feed_label

string

省略可。変更不可。データソース レベルで指定されるフィードラベル。

20 文字以下の大文字（A ～ Z）、数字（0 ～ 9）、ダッシュ（-）を使用してください。

フィードラベルへの移行もご覧ください。

商品コンテンツ タイプのデータソースでは、feedLabel と contentLanguage の両方を設定するか、未設定にする必要があります。ファイル入力を使用するデータソースに対して設定する必要があります。

設定すると、この組み合わせに一致する商品のみがデータソースで受け入れられます。未設定のままにした場合、データソースは制限なしで商品を受け入れます。
content_language

string

省略可。変更不可。データソースに含まれる商品アイテムの 2 文字の ISO 639-1 言語。

feedLabel と contentLanguage は、どちらも設定するか未設定のままにする必要があります。ファイル入力がないデータソースでのみ、フィールドの設定を解除できます。

設定すると、この組み合わせに一致する商品のみがデータソースで受け入れられます。未設定のままにした場合、データソースはその制限なしで商品を受け入れます。

チャンネル

データソース チャネル

チャネルは、さまざまなサービス カテゴリのデータソースを区別するために使用します。

列挙型
CHANNEL_UNSPECIFIED 指定されていません。
ONLINE_PRODUCTS オンライン商品。
LOCAL_PRODUCTS ローカル商品。
PRODUCTS ローカル商品とオンライン商品の両方に対応する統合データソース。注: このチャンネルでは、API を使用した商品管理は行えません。

PromotionDataSource

プロモーションのデータソース。

フィールド
target_country

string

必須。変更不可。固有 ID の一部として使用される対象国。CLDR テリトリー コードで表されます。

プロモーションは特定の国でのみご利用いただけます。
content_language

string

必須。変更不可。データソースに含まれる商品アイテムの 2 文字の ISO 639-1 言語。

RegionalInventoryDataSource

地域別の在庫データソースです。

フィールド
feed_label

string

必須。変更不可。地域別の在庫を提供する商品のフィードラベル。

20 文字以下の大文字（A ～ Z）、数字（0 ～ 9）、ダッシュ（-）を使用してください。

フィードラベルへの移行もご覧ください。
content_language

string

必須。変更不可。地域別の在庫が指定されている商品アイテムの 2 文字の ISO 639-1 言語。

SupplementalProductDataSource

ローカル商品とオンライン商品の補助データソース。

フィールド
feed_label

string

省略可。変更不可。データソース レベルで指定されるフィードラベル。

20 文字以下の大文字（A ～ Z）、数字（0 ～ 9）、ダッシュ（-）を使用してください。

フィードラベルへの移行もご覧ください。

商品コンテンツ タイプのデータソースでは、feedLabel と contentLanguage の両方を設定するか、未設定にする必要があります。ファイル入力を使用するデータソースに対して設定する必要があります。

設定すると、この組み合わせに一致する商品のみがデータソースで受け入れられます。未設定のままにした場合、データソースは制限なしでプロダクトを受け入れます。
content_language

string

省略可。変更不可。データソースに含まれる商品アイテムの 2 文字の ISO 639-1 言語。

feedLabel と contentLanguage は、どちらも設定するか未設定のままにする必要があります。ファイル入力がないデータソースでのみ、フィールドの設定を解除できます。

設定すると、この組み合わせに一致する商品のみがデータソースで受け入れられます。未設定のままにした場合、データソースは制限なしでプロダクトを受け入れます。

UpdateDataSourceRequest

UpdateDataSource メソッドに対するリクエスト メッセージ。

フィールド
data_source

DataSource

必須。更新するデータソース リソース。
update_mask

FieldMask

必須。更新するデータソース フィールドのリスト。

更新マスクで指定されたフィールドのうち、本文に値が指定されていないフィールドは、データソースから削除されます。

特殊文字（*）を使用する値はサポートされていません。