Method: projects.locations.products.patch

Product リソースを変更します。現時点で更新できるのは、displayName、description、labels フィールドのみです。

ラベルが更新されると、次のインデックス時間まで変更がクエリに反映されません。

発生する可能性があるエラー:

  • Product が存在しない場合は NOT_FOUND を返します。
  • displayName が updateMask に存在するものの、リクエストにないか、または 4,096 文字を超えている場合、INVALID_ARGUMENT を返します。
  • description が updateMask に存在するものの、4,096 文字を超えている場合、INVALID_ARGUMENT を返します。
  • productCategory が updateMask に存在している場合、INVALID_ARGUMENT を返します。

HTTP リクエスト

PATCH https://vision.googleapis.com/v1p3beta1/{product.name=projects/*/locations/*/products/*}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
product.name

string

商品のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

商品の作成では、このフィールドは無視されます。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

更新するフィールドを指定する FieldMask。updateMask が指定されていない場合、すべての変更可能なフィールドが更新されます。有効なマスクパスは productLabels、displayName、description です。

完全修飾された項目名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には Product のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には Product のインスタンスが含まれます。

認証スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

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