Method: projects.sites.customDomains.patch

指定されたCustomDomainを更新します。

HTTPリクエスト

PATCH https://firebasehosting.googleapis.com/v1beta1/{customDomain.name=projects/*/sites/*/customDomains/*}

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
customDomain.name

string

出力のみ。 CustomDomainの完全修飾名。

クエリパラメータ

パラメーター
updateMask

string ( FieldMask format)

更新するCustomDomainのフィールド名のセット。

フィールドはマスク内にある場合にのみ上書きされます。マスクを指定しない場合、Hosting はCustomDomain全体を更新します。

これは、フィールドの完全修飾名のカンマ区切りのリストです。例: "user.displayName,photo"

allowMissing

boolean

true の場合、Hosting はCustomDomainまだ存在しない場合に作成します。

validateOnly

boolean

true の場合、Hosting はリクエストを完了できることを検証しますが、実際にはCustomDomain作成または更新しません。

リクエストボディ

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

レスポンスボディ

成功した場合、応答本文にはOperationのインスタンスが含まれます。

認可範囲

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

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

詳細については、 「認証の概要」を参照してください。