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 の概要をご覧ください。
InsertLocalInventory

rpc InsertLocalInventory(InsertLocalInventoryRequest) returns (LocalInventory)

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

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

新規または更新された LocalInventory リソースがサービスに表示されるまで、最長で 30 分ほどかかる場合があります。

認可スコープ

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

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

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

rpc ListLocalInventories(ListLocalInventoriesRequest) returns (ListLocalInventoriesResponse)

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

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

認可スコープ

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

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

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

RegionalInventoryService

地域別の商品の在庫を管理するサービス。リージョンの定義を管理するための個別の regions リソースと API もあります。

DeleteRegionalInventory

rpc DeleteRegionalInventory(DeleteRegionalInventoryRequest) returns (Empty)

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

認可スコープ

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

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

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

rpc InsertRegionalInventory(InsertRegionalInventoryRequest) returns (RegionalInventory)

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

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

新規または更新された RegionalInventory リソースがサービスに表示されるまで、最長で 30 分ほどかかる場合があります。

認可スコープ

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

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

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

rpc ListRegionalInventories(ListRegionalInventoriesRequest) returns (ListRegionalInventoriesResponse)

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

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

認可スコープ

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

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

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

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 より少ない場合、サービスはこの値より小さい数を返します。デフォルト値は 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 より少ない場合、サービスはこの値より小さい数を返します。デフォルト値は 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

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