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)
  }
  // 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)

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

PrimaryProductDataSource

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

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

enum (Channel)

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

string

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

string

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

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

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

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

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

string

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

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

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

チャンネル

データソース チャネル

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

列挙型
CHANNEL_UNSPECIFIED 指定されていません。
ONLINE_PRODUCTS オンライン商品。
LOCAL_PRODUCTS ローカル商品。
PRODUCTS ローカル商品とオンライン商品の両方に対応する統合データソース。

SupplementalProductDataSource

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

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

string

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

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

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

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

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

string

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

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

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

LocalInventoryDataSource

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

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

string

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

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

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

string

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

RegionalInventoryDataSource

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

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

string

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

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

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

string

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

PromotionDataSource

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

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

string

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

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

string

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

入力での

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

列挙型
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)

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

string

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

enum (Frequency)

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

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 経由でデータソースを送信する場合に使用します。

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

秒。通常、0～59 である必要があります。API がうるう秒を許可する場合、値 60 が許可されます。
nanos

integer

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

DayOfWeek

曜日を表します。

列挙型
DAY_OF_WEEK_UNSPECIFIED 曜日が指定されていません。
MONDAY 月曜日
TUESDAY 火曜日
WEDNESDAY 水曜日
THURSDAY 木曜日
FRIDAY Friday
SATURDAY Saturday
SUNDAY 日曜日

周波数

必須フィールドは、取得の頻度によって異なります。月単位の取得スケジュールの場合、[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] が必要です。毎日の取得スケジュールの場合、[hour 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.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] から取得されます。
GOOGLE_SHEETS ファイルは、[fetchUri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] で指定された Google スプレッドシートから取得されます。

メソッド

create

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

delete

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

fetch

 Merchant Center アカウントのデータソースでデータをすぐに（取得スケジュール外であっても）取得します。

get

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

list

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

patch

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