REST Resource: accounts.dataSources

リソース: DataSource

Merchant Center アカウントのデータソース。

JSON 表現 
{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "input": enum (Input),
  "fileInput": {
    object (FileInput)
  },

  // Union field Type can be only one of the following:
  "primaryProductDataSource": {
    object (PrimaryProductDataSource)
  },
  "supplementalProductDataSource": {
    object (SupplementalProductDataSource)
  },
  "localInventoryDataSource": {
    object (LocalInventoryDataSource)
  },
  "regionalInventoryDataSource": {
    object (RegionalInventoryDataSource)
  },
  "promotionDataSource": {
    object (PromotionDataSource)
  },
  "productReviewDataSource": {
    object (ProductReviewDataSource)
  },
  "merchantReviewDataSource": {
    object (MerchantReviewDataSource)
  }
  // End of list of possible types for union field Type.
}
フィールド
name

string

ID。データソースの名前。形式: {datasource.name=accounts/{account}/dataSources/{datasource}}
dataSourceId

string (int64 format)

出力専用。データソースの ID。
displayName

string

必須。Merchant Center の UI に表示されるデータソース名。
input

enum (Input)

出力専用。データソースへの入力のタイプを決定します。入力内容によっては、一部の設定が機能しない場合があります。API で作成できるのは、汎用データソースのみです。
fileInput

object (FileInput)

省略可。このフィールドは、データがファイルで管理されている場合にのみ使用されます。
共用体フィールド Type。データソースのタイプ。Type は次のいずれかになります。
primaryProductDataSource

object (PrimaryProductDataSource)

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

object (SupplementalProductDataSource)

必須。ローカル商品とオンライン商品の補足データソース。
localInventoryDataSource

object (LocalInventoryDataSource)

必須。ローカル在庫データソース。
regionalInventoryDataSource

object (RegionalInventoryDataSource)

必須。地域別在庫データソース。
promotionDataSource

object (PromotionDataSource)

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

object (ProductReviewDataSource)

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

object (MerchantReviewDataSource)

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

PrimaryProductDataSource

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

JSON 表現 
{
  "channel": enum (Channel),
  "countries": [
    string
  ],
  "defaultRule": {
    object (DefaultRule)
  },
  "feedLabel": string,
  "contentLanguage": string
}
フィールド
channel

enum (Channel)

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

string

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

object (DefaultRule)

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

string

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

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

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

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

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

string

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

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

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

チャンネル

データソース チャネル。

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

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

DefaultRule

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

JSON 表現 
{
  "takeFromDataSources": [
    {
      object (DataSourceReference)
    }
  ]
}
フィールド
takeFromDataSources[]

object (DataSourceReference)

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

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

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

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

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

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

DataSourceReference

データソース リファレンスを使用すると、データソース サービス内で関連するデータソースを管理できます。

JSON 表現 
{

  // Union field data_source_id can be only one of the following:
  "self": boolean,
  "primaryDataSourceName": string,
  "supplementalDataSourceName": string
  // End of list of possible types for union field data_source_id.
}
フィールド

共用体フィールド data_source_id。

data_source_id は次のいずれかになります。
self

boolean

メイン データソース自体を参照するには、self を使用します。
primaryDataSourceName

string

省略可。プライマリ データソースの名前。形式: accounts/{account}/dataSources/{datasource}
supplementalDataSourceName

string

省略可。補助データソースの名前。形式: accounts/{account}/dataSources/{datasource}

SupplementalProductDataSource

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

JSON 表現 
{
  "referencingPrimaryDataSources": [
    {
      object (DataSourceReference)
    }
  ],
  "feedLabel": string,
  "contentLanguage": string
}
フィールド
referencingPrimaryDataSources[]

object (DataSourceReference)

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

string

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

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

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

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

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

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

string

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

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

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

LocalInventoryDataSource

ローカル在庫データソース。

JSON 表現 
{
  "feedLabel": string,
  "contentLanguage": string
}
フィールド
feedLabel

string

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

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

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

string

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

RegionalInventoryDataSource

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

JSON 表現 
{
  "feedLabel": string,
  "contentLanguage": string
}
フィールド
feedLabel

string

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

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

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

string

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

PromotionDataSource

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

JSON 表現 
{
  "targetCountry": string,
  "contentLanguage": string
}
フィールド
targetCountry

string

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

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

string

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

ProductReviewDataSource

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

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

MerchantReviewDataSource

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

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

入力

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

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

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

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

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

FileInput

ファイル データソースに固有のデータ。他のデータソース入力では、このフィールドは空白です。

JSON 表現 
{
  "fetchSettings": {
    object (FetchSettings)
  },
  "fileName": string,
  "fileInputType": enum (FileInputType)
}
フィールド
fetchSettings

object (FetchSettings)

省略可。詳細を取得してデータソースを配信します。これには、FETCH ファイルと GOOGLE_SHEETS ファイルの入力タイプの設定が含まれています。必要なフィールドは、取得頻度によって異なります。
fileName

string

省略可。データソースのファイル名。UPLOAD ファイル入力タイプの場合は必須です。
fileInputType

enum (FileInputType)

出力専用。ファイル入力のタイプ。

FetchSettings

詳細を取得してデータソースを配信します。

JSON 表現 
{
  "enabled": boolean,
  "dayOfMonth": integer,
  "timeOfDay": {
    object (TimeOfDay)
  },
  "dayOfWeek": enum (DayOfWeek),
  "timeZone": string,
  "frequency": enum (Frequency),
  "fetchUri": string,
  "username": string,
  "password": string
}
フィールド
enabled

boolean

省略可。取得スケジュールを有効または一時停止します。
dayOfMonth

integer

省略可。データソース ファイルを取得する日付（1 ～ 31）。このフィールドは、月単位の頻度でのみ設定できます。
timeOfDay

object (TimeOfDay)

省略可。データソース ファイルを取得する時刻。分と秒はサポートされていないため、無視されます。
dayOfWeek

enum (DayOfWeek)

省略可。データソース ファイルを取得する曜日。このフィールドは、フリークエンシーが週単位の場合にのみ設定できます。
timeZone

string

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

enum (Frequency)

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

string

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

string

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

string

省略可。fetchUri のパスワード（省略可）。SFTP 経由でデータソースを送信する場合に使用します。

TimeOfDay

1 日のうちの時間を表します。日付とタイムゾーンは重要ではないか、他の場所で指定されています。API は、うるう秒を許可するようにできます。関連する型は、google.type.Date と google.protobuf.Timestamp です。

JSON 表現 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
フィールド
hours

integer

24 時間形式の時間。0 以上の値を指定してください。通常は 23 以下にする必要があります。API ではビジネスの終了時間などのシナリオにおいて、値 "24:00:00" を許可することもできます。
minutes

integer

分。0 以上 59 以下にする必要があります。
seconds

integer

1 分の秒数。0 以上で、通常は 59 以下にする必要があります。API がうるう秒を許可する場合、値 60 が許可されます。
nanos

integer

秒の小数部分（ナノ秒単位）。0 以上 999,999,999 以下にする必要があります。

DayOfWeek

曜日を表します。

列挙型
DAY_OF_WEEK_UNSPECIFIED 曜日は指定されていません。
MONDAY 月曜日
TUESDAY 火曜日
WEDNESDAY Wednesday
THURSDAY 木曜日
FRIDAY 金曜日
SATURDAY 土曜日
SUNDAY 日曜日

頻度

必要なフィールドは、取得頻度によって異なります。月次取得スケジュールの場合は、[日付][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 ファイルは、構成された fetchUri から取得されます。
GOOGLE_SHEETS ファイルは、fetchUri で指定された Google スプレッドシートから取得されます。

メソッド

create

 指定したアカウントの新しいデータソース構成を作成します。

delete

 Merchant Center アカウントからデータソースを削除します。

fetch

 Merchant Center アカウントのデータソースに対して、（取得スケジュール外でも）直ちにデータ取得を実行します。

get

 指定されたアカウントのデータソース構成を取得します。

list

 指定したアカウントのデータソースの構成を一覧表示します。

patch

 既存のデータソース構成を更新します。