Method: forms.setPublishSettings

フォームの公開設定を更新します。

以前のフォームには publishSettings フィールドがないため、サポートされていません。

HTTP リクエスト

POST https://forms.googleapis.com/v1/forms/{formId}:setPublishSettings

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

パスパラメータ

パラメータ
formId

string

必須。フォームの ID。ID は Form.form_id フィールドから取得できます。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "publishSettings": {
    object (PublishSettings)
  },
  "updateMask": string
}
フィールド
publishSettings

object (PublishSettings)

必須。フォームに適用する公開設定。

updateMask

string (FieldMask format)

省略可。更新する publishSettings フィールド。このフィールドマスクは、次の値を受け入れます。

  • publishState: すべての publishState 設定を更新または置き換えます。
  • "*": すべての publishSettings フィールドを更新または置換します。

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

レスポンスの本文

forms.setPublishSettings リクエストのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "formId": string,
  "publishSettings": {
    object (PublishSettings)
  }
}
フィールド
formId

string

必須。フォームの ID。これは Form.form_id フィールドと同じです。

publishSettings

object (PublishSettings)

フォームの公開設定。

認可スコープ

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

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/forms.body

詳しくは、認可ガイドをご覧ください。