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 日に複数回呼び出す必要がある場合は、代わりに商品サービスを使用して商品データを更新する必要があります。この方法は、ファイル入力が設定されているデータソースでのみ機能します。

認可スコープ

次の 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 の 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

必須。プロモーション データソース。
product_review_data_source

ProductReviewDataSource

必須。商品レビューのデータソース。
merchant_review_data_source

MerchantReviewDataSource

必須。販売者レビューのデータソース。

入力

データソースへの入力のタイプを決定します。入力内容によっては、一部の設定がサポートされない場合があります。

列挙型
INPUT_UNSPECIFIED 入力が指定されていません。
API データが主に API を介して提供されるデータソースを表します。
FILE データが主にファイル入力によって提供されるデータソースを表します。データは引き続き API を介して提供できます。
UI

Merchant Center で直接追加した商品のデータソース。

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

このタイプのデータソースは読み取り専用です。
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

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

string

省略可。fetch_uri のユーザー名（省略可）。SFTP 経由でデータソースを送信する場合に使用します。
password

string

省略可。fetch_uri のパスワード（省略可）。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_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

省略可。返されるデータソースの最大数。サービスが返す値はこれよりも少ないことがあります。最大値は 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

必須。変更不可。ローカル在庫が提供される商品アイテムのフィードラベル。

大文字（A ～ Z）、数字（0 ～ 9）、ダッシュ（-）で構成し、20 文字以下にしてください。

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

string

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

MerchantReviewDataSource

この型にはフィールドがありません。

販売者レビューのデータソース。

PrimaryProductDataSource

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

フィールド
channel

Channel

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

string

省略可。商品アイテムが表示される可能性がある国。CLDR 地域コードで表されます。
default_rule

DefaultRule

省略可。データソースのデフォルト ルール管理。設定すると、リンクされたデータソースが置き換えられます。
feed_label

string

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

大文字（A ～ Z）、数字（0 ～ 9）、ダッシュ（-）で構成し、20 文字以下にしてください。

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

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

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

string

省略可。変更不可。データソース内のアイテムの 2 文字の ISO 639-1 言語。

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

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

チャンネル

データソース チャネル。

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

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

DefaultRule

データソースのデフォルト ルール管理。

フィールド
take_from_data_sources[]

DataSourceReference

必須。デフォルト ルールでリンクされているデータソースのリスト。このリストは、データ結合のデフォルトのルール優先度で並べ替えられています。self と補足データソースへの参照は、何も含まれないか、複数含まれる場合があります。

リストを空にすることはできません。

データソースをデフォルト ルールにリンクするには、このリストに新しい参照を追加する必要があります（順番に）。

データソースとデフォルト ルールのリンクを解除するには、このリストから該当する参照を削除する必要があります。

このリストの順序を変更すると、デフォルト ルール内のデータソースの優先度が変更されます。

たとえば、リスト [1001, self] を指定すると、補足データソース 1001 から属性値が取得され、1001 で属性が設定されていない場合は self にフォールバックされます。

ProductReviewDataSource

この型にはフィールドがありません。

商品レビューのデータソース。

PromotionDataSource

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

フィールド
target_country

string

必須。変更不可。一意の識別子の一部として使用されるターゲット国。CLDR 地域コードで表されます。

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

string

必須。変更不可。データソース内のアイテムの 2 文字の ISO 639-1 言語。

RegionalInventoryDataSource

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

フィールド
feed_label

string

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

大文字（A ～ Z）、数字（0 ～ 9）、ダッシュ（-）で構成し、20 文字以下にしてください。

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

string

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

SupplementalProductDataSource

ローカル商品とオンライン商品の補助データソース。作成後、補助の商品データソースを 1 つ以上のメインの商品データソースにリンクする必要があります。

フィールド
referencing_primary_data_sources[]

DataSourceReference

出力専用。デフォルト ルールまたはカスタム ルールでこのデータソースにリンクされているすべてのメイン データソースのリスト（順序なし、重複除去済み）。すべてのリンクが削除されるまで、補足データソースを削除することはできません。
feed_label

string

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

大文字（A ～ Z）、数字（0 ～ 9）、ダッシュ（-）で構成し、20 文字以下にしてください。

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

商品コンテンツ タイプのデータソースの場合、feedLabel と contentLanguage は両方設定するか、両方設定解除する必要があります。

file input を持つデータソースに設定する必要があります。file input のないデータソースの場合は、フィールドを未設定にする必要があります。

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

string

省略可。変更不可。データソース内のアイテムの 2 文字の ISO 639-1 言語。

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

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

UpdateDataSourceRequest

UpdateDataSource メソッドのリクエスト メッセージ。

フィールド
data_source

DataSource

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

FieldMask

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

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

データソース全体の置換に特別な「*」値を指定することはできません。