Package google.shopping.merchant.inventories.v1beta

インデックス

LocalInventoryService

商品のローカル在庫を管理するサービス

DeleteLocalInventory

rpc DeleteLocalInventory(DeleteLocalInventoryRequest) returns (Empty)

販売者のアカウントの指定した商品から指定した LocalInventory を削除します。特定の商品から LocalInventory が削除されるまでに、最長で 1 時間ほどかかることがあります。削除成功のレスポンスを受け取ったら、その期間を待ってから削除を再試行してください。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 Overview をご覧ください。
InsertLocalInventory

rpc InsertLocalInventory(InsertLocalInventoryRequest) returns (LocalInventory)

販売者のアカウントの商品に LocalInventory リソースを挿入します。

商品に同じ storeCode のエントリがすでに存在する場合、LocalInventory リソース全体を置き換えます。

新しい LocalInventory リソースまたは更新された LocalInventory リソースが商品に表示されるまで、最長で 30 分ほどかかることがあります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 Overview をご覧ください。
ListLocalInventories

rpc ListLocalInventories(ListLocalInventoriesRequest) returns (ListLocalInventoriesResponse)

販売者のアカウントで、指定された商品の LocalInventory リソースを一覧表示します。レスポンスには、pageSize で指定された項目よりも少ない項目が含まれる場合があります。前のリクエストで pageToken が返された場合は、それを使用して追加の結果を取得できます。

LocalInventory リソースは、特定のアカウントのプロダクトごとに一覧表示されます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 Overview をご覧ください。

RegionalInventoryService

商品の地域別の在庫を管理するサービス。リージョン定義を管理するための regions リソースと API も別に用意されています。

DeleteRegionalInventory

rpc DeleteRegionalInventory(DeleteRegionalInventoryRequest) returns (Empty)

販売者のアカウントの指定された商品から、指定された RegionalInventory リソースを削除します。特定の商品から RegionalInventory が削除されるまでに、最長で 1 時間ほどかかることがあります。削除成功のレスポンスを受け取ったら、その期間を待ってから削除を再試行してください。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 Overview をご覧ください。
InsertRegionalInventory

rpc InsertRegionalInventory(InsertRegionalInventoryRequest) returns (RegionalInventory)

販売者のアカウントの特定の商品に RegionalInventory を挿入します。

商品に同じ region のエントリがすでに存在する場合、RegionalInventory リソース全体を置き換えます。

新しい RegionalInventory リソースまたは更新された RegionalInventory リソースが商品に表示されるまで、最長で 30 分ほどかかることがあります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 Overview をご覧ください。
ListRegionalInventories

rpc ListRegionalInventories(ListRegionalInventoriesRequest) returns (ListRegionalInventoriesResponse)

販売者のアカウントで、指定された商品の RegionalInventory リソースを一覧表示します。レスポンスには、pageSize で指定された項目よりも少ない項目が含まれる場合があります。前のリクエストで pageToken が返された場合は、それを使用して追加の結果を取得できます。

RegionalInventory リソースは、特定のアカウントのプロダクトごとに一覧表示されます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 Overview をご覧ください。

DeleteLocalInventoryRequest

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

フィールド
name

string

必須。削除する商品のローカル在庫の名前。形式: accounts/{account}/products/{product}/localInventories/{store_code}

DeleteRegionalInventoryRequest

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

フィールド
name

string

必須。削除する RegionalInventory リソースの名前。形式: accounts/{account}/products/{product}/regionalInventories/{region}

InsertLocalInventoryRequest

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

フィールド
parent

string

必須。この広告枠が挿入されるアカウントとプロダクト。形式: accounts/{account}/products/{product}
local_inventory

LocalInventory

必須。商品のローカル在庫情報。商品に同じ storeCode の LocalInventory リソースがすでに存在する場合、LocalInventory リソースの完全な置換が行われます。

InsertRegionalInventoryRequest

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

フィールド
parent

string

必須。この広告枠が挿入されるアカウントとプロダクト。形式: accounts/{account}/products/{product}
regional_inventory

RegionalInventory

必須。商品に追加する地域別在庫情報。商品に同じ region の RegionalInventory リソースがすでに存在する場合、RegionalInventory リソースの完全な置換が行われます。

ListLocalInventoriesRequest

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

フィールド
parent

string

必須。ローカル在庫を表示する親商品の name。形式: accounts/{account}/products/{product}
page_size

int32

指定された商品が返す LocalInventory リソースの最大数。指定した商品の在庫数が pageSize より少ない場合、サービスは pageSize より少ない値を返します。デフォルト値は 25,000 です。最大値は 25, 000 です。最大値を超える値を指定すると、pageSize はデフォルトで最大値になります。
page_token

string

前回の ListLocalInventories 呼び出しから受け取ったページトークン。ページトークンを指定して、後続のページを取得します。

ページネーションを行う場合、ListLocalInventories に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。前のリクエストのレスポンスで nextPageToken として返されたトークン。

ListLocalInventoriesResponse

ListLocalInventories メソッドに対するレスポンス メッセージ。

フィールド
local_inventories[]

LocalInventory

指定したアカウントの特定のプロダクトの LocalInventory リソース。
next_page_token

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListRegionalInventoriesRequest

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

フィールド
parent

string

必須。RegionalInventory リソースを一覧表示する親プロダクトの name。形式: accounts/{account}/products/{product}
page_size

int32

指定された商品が返す RegionalInventory リソースの最大数。指定した商品の在庫数が pageSize より少ない場合、サービスは pageSize より少ない値を返します。デフォルト値は 25,000 です。最大値は 100, 000 です。最大値を超える値を指定すると、pageSize はデフォルトで最大値になります。
page_token

string

前回の ListRegionalInventories 呼び出しから受け取ったページトークン。ページトークンを指定して、後続のページを取得します。

ページネーションを行う場合、ListRegionalInventories に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。前のリクエストのレスポンスで nextPageToken として返されたトークン。

ListRegionalInventoriesResponse

ListRegionalInventories メソッドに対するレスポンス メッセージ。

フィールド
regional_inventories[]

RegionalInventory

指定したアカウントの特定のプロダクトの RegionalInventory リソース。
next_page_token

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

LocalInventory

商品のローカル在庫情報。storeCode で指定された店舗の特定の商品の店舗内情報を表します。使用できる属性値の一覧については、ローカル商品在庫データ仕様をご覧ください。

フィールド
name

string

出力専用。LocalInventory リソースの名前。形式: accounts/{account}/products/{product}/localInventories/{store_code}
account

int64

出力専用。商品を所有するアカウント。このフィールドは、クライアントによって設定されている場合、無視されます。
store_code

string

必須。変更不可。商品が販売されている実店舗の店舗コード（ビジネス プロフィールの店舗 ID）。詳しくは、ローカル商品在庫データ仕様をご覧ください。
price

Price

この店舗での商品の価格。
sale_price

Price

この店舗での商品の販売価格。salePriceEffectiveDate が定義されている場合は必須です。
sale_price_effective_date

Interval

この店舗のセールの TimePeriod。
custom_attributes[]

CustomAttribute

カスタム（販売者提供）属性のリスト。CustomAttribute を使用して、データ仕様の任意の属性を汎用形式で送信することもできます。
availability

string

この店舗での商品の在庫状況。使用できる属性値については、ローカル商品在庫データ仕様をご覧ください。
quantity

int64

この店舗で購入できる商品の数量。0 以上の値を指定してください。
pickup_method

string

この商品でサポートされている受け取り方法。値が "not supported" でない限り、このフィールドは pickupSla とともに送信する必要があります。使用できる属性値については、ローカル商品在庫データ仕様をご覧ください。
pickup_sla

string

この店舗でこの商品を注文してから受け取り可能になるまでの相対的な期間。pickupMethod を使用して送信する必要があります。使用できる属性値については、ローカル商品在庫データ仕様をご覧ください。
instore_product_location

string

店舗内の商品の場所。最大長は 20 バイトです。

RegionalInventory

商品の地域別の在庫情報。特定の region 内の特定の商品の価格や在庫状況などの特定の情報を表現します。使用できる属性値の一覧については、地域別商品在庫データ仕様をご覧ください。

フィールド
name

string

出力専用。RegionalInventory リソースの名前。形式: {regional_inventory.name=accounts/{account}/products/{product}/regionalInventories/{region}
account

int64

出力専用。商品を所有するアカウント。このフィールドは、クライアントによって設定されている場合、無視されます。
region

string

必須。変更不可。この RegionalInventory リソースのリージョンの ID。詳細については、地域別の在庫状況と価格をご覧ください。
price

Price

この地域の商品の価格。
sale_price

Price

この地域での商品の販売価格。salePriceEffectiveDate が定義されている場合は必須です。
sale_price_effective_date

Interval

この地域の販売価格の TimePeriod。
custom_attributes[]

CustomAttribute

カスタム（販売者提供）属性のリスト。CustomAttribute を使用して、データ仕様の任意の属性を汎用形式で送信することもできます。
availability

string

この地域での製品の提供状況。使用できる属性値については、地域別商品在庫データ仕様をご覧ください。