feat(forms): update the api

yoshi-automation · yoshi-automation · commit ce44d0097f2e · 2025-03-18T07:11:07.000Z
#### forms:v1

The following keys were added:
- resources.forms.methods.create.parameters.unpublished (Total Keys: 2)
- resources.forms.methods.setPublishSettings (Total Keys: 11)
- schemas.Form.properties.publishSettings (Total Keys: 2)
- schemas.PublishSettings (Total Keys: 3)
- schemas.PublishState (Total Keys: 4)
- schemas.SetPublishSettingsRequest (Total Keys: 5)
- schemas.SetPublishSettingsResponse (Total Keys: 4)
diff --git a/docs/dyn/forms_v1.forms.html b/docs/dyn/forms_v1.forms.html
@@ -91,11 +91,14 @@ <h2>Instance Methods</h2>
   <code><a href="#close">close()</a></code></p>
 <p class="firstline">Close httplib2 connections.</p>
 <p class="toc_element">
-  <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
+  <code><a href="#create">create(body=None, unpublished=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Create a new form using the title given in the provided form message in the request. *Important:* Only the form.info.title and form.info.document_title fields are copied to the new form. All other fields including the form description, items and settings are disallowed. To create a new form and add items, you must first call forms.create to create an empty form with a title and (optional) document title, and then call forms.update to add the items.</p>
 <p class="toc_element">
   <code><a href="#get">get(formId, x__xgafv=None)</a></code></p>
 <p class="firstline">Get a form.</p>
+<p class="toc_element">
+  <code><a href="#setPublishSettings">setPublishSettings(formId, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the publish settings of a form. Legacy forms aren't supported because they don't have the `publish_settings` field.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="batchUpdate">batchUpdate(formId, body=None, x__xgafv=None)</code>
@@ -1078,6 +1081,12 @@ <h3>Method Details</h3>
       },
     ],
     &quot;linkedSheetId&quot;: &quot;A String&quot;, # Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists).
+    &quot;publishSettings&quot;: { # The publishing settings of a form. # Output only. The publishing settings for a form. This field isn&#x27;t set for legacy forms because they don&#x27;t have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form.
+      &quot;publishState&quot;: { # The publishing state of a form. # Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn&#x27;t supported and returns an error.
+        &quot;isAcceptingResponses&quot;: True or False, # Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.
+        &quot;isPublished&quot;: True or False, # Required. Whether the form is published and visible to others.
+      },
+    },
     &quot;responderUri&quot;: &quot;A String&quot;, # Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions.
     &quot;revisionId&quot;: &quot;A String&quot;, # Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes.
     &quot;settings&quot;: { # A form&#x27;s settings. # The form&#x27;s settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest.
@@ -1110,7 +1119,7 @@ <h3>Method Details</h3>
 </div>
 
 <div class="method">
-    <code class="details" id="create">create(body=None, x__xgafv=None)</code>
+    <code class="details" id="create">create(body=None, unpublished=None, x__xgafv=None)</code>
   <pre>Create a new form using the title given in the provided form message in the request. *Important:* Only the form.info.title and form.info.document_title fields are copied to the new form. All other fields including the form description, items and settings are disallowed. To create a new form and add items, you must first call forms.create to create an empty form with a title and (optional) document title, and then call forms.update to add the items.
 
 Args:
@@ -1427,6 +1436,12 @@ <h3>Method Details</h3>
     },
   ],
   &quot;linkedSheetId&quot;: &quot;A String&quot;, # Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists).
+  &quot;publishSettings&quot;: { # The publishing settings of a form. # Output only. The publishing settings for a form. This field isn&#x27;t set for legacy forms because they don&#x27;t have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form.
+    &quot;publishState&quot;: { # The publishing state of a form. # Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn&#x27;t supported and returns an error.
+      &quot;isAcceptingResponses&quot;: True or False, # Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.
+      &quot;isPublished&quot;: True or False, # Required. Whether the form is published and visible to others.
+    },
+  },
   &quot;responderUri&quot;: &quot;A String&quot;, # Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions.
   &quot;revisionId&quot;: &quot;A String&quot;, # Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes.
   &quot;settings&quot;: { # A form&#x27;s settings. # The form&#x27;s settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest.
@@ -1437,6 +1452,7 @@ <h3>Method Details</h3>
   },
 }
 
+  unpublished: boolean, Optional. Whether the form is unpublished. If set to `true`, the form doesn&#x27;t accept responses. If set to `false` or unset, the form is published and accepts responses.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1755,6 +1771,12 @@ <h3>Method Details</h3>
     },
   ],
   &quot;linkedSheetId&quot;: &quot;A String&quot;, # Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists).
+  &quot;publishSettings&quot;: { # The publishing settings of a form. # Output only. The publishing settings for a form. This field isn&#x27;t set for legacy forms because they don&#x27;t have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form.
+    &quot;publishState&quot;: { # The publishing state of a form. # Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn&#x27;t supported and returns an error.
+      &quot;isAcceptingResponses&quot;: True or False, # Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.
+      &quot;isPublished&quot;: True or False, # Required. Whether the form is published and visible to others.
+    },
+  },
   &quot;responderUri&quot;: &quot;A String&quot;, # Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions.
   &quot;revisionId&quot;: &quot;A String&quot;, # Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes.
   &quot;settings&quot;: { # A form&#x27;s settings. # The form&#x27;s settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest.
@@ -2090,6 +2112,12 @@ <h3>Method Details</h3>
     },
   ],
   &quot;linkedSheetId&quot;: &quot;A String&quot;, # Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists).
+  &quot;publishSettings&quot;: { # The publishing settings of a form. # Output only. The publishing settings for a form. This field isn&#x27;t set for legacy forms because they don&#x27;t have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form.
+    &quot;publishState&quot;: { # The publishing state of a form. # Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn&#x27;t supported and returns an error.
+      &quot;isAcceptingResponses&quot;: True or False, # Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.
+      &quot;isPublished&quot;: True or False, # Required. Whether the form is published and visible to others.
+    },
+  },
   &quot;responderUri&quot;: &quot;A String&quot;, # Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions.
   &quot;revisionId&quot;: &quot;A String&quot;, # Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes.
   &quot;settings&quot;: { # A form&#x27;s settings. # The form&#x27;s settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest.
@@ -2101,4 +2129,42 @@ <h3>Method Details</h3>
 }</pre>
 </div>
 
+<div class="method">
+    <code class="details" id="setPublishSettings">setPublishSettings(formId, body=None, x__xgafv=None)</code>
+  <pre>Updates the publish settings of a form. Legacy forms aren&#x27;t supported because they don&#x27;t have the `publish_settings` field.
+
+Args:
+  formId: string, Required. The ID of the form. You can get the id from `Form.form_id` field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Updates the publish settings of a Form.
+  &quot;publishSettings&quot;: { # The publishing settings of a form. # Required. The desired publish settings to apply to the form.
+    &quot;publishState&quot;: { # The publishing state of a form. # Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn&#x27;t supported and returns an error.
+      &quot;isAcceptingResponses&quot;: True or False, # Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.
+      &quot;isPublished&quot;: True or False, # Required. Whether the form is published and visible to others.
+    },
+  },
+  &quot;updateMask&quot;: &quot;A String&quot;, # Optional. The `publish_settings` fields to update. This field mask accepts the following values: * `publish_state`: Updates or replaces all `publish_state` settings. * `&quot;*&quot;`: Updates or replaces all `publish_settings` fields.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response of a `SetPublishSettings` request.
+  &quot;formId&quot;: &quot;A String&quot;, # Required. The ID of the Form. This is same as the `Form.form_id` field.
+  &quot;publishSettings&quot;: { # The publishing settings of a form. # The publish settings of the form.
+    &quot;publishState&quot;: { # The publishing state of a form. # Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn&#x27;t supported and returns an error.
+      &quot;isAcceptingResponses&quot;: True or False, # Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.
+      &quot;isPublished&quot;: True or False, # Required. Whether the form is published and visible to others.
+    },
+  },
+}</pre>
+</div>
+
 </body></html>
diff --git a/googleapiclient/discovery_cache/documents/forms.v1.json b/googleapiclient/discovery_cache/documents/forms.v1.json
@@ -157,7 +157,13 @@
 "httpMethod": "POST",
 "id": "forms.forms.create",
 "parameterOrder": [],
-"parameters": {},
+"parameters": {
+"unpublished": {
+"description": "Optional. Whether the form is unpublished. If set to `true`, the form doesn't accept responses. If set to `false` or unset, the form is published and accepts responses.",
+"location": "query",
+"type": "boolean"
+}
+},
 "path": "v1/forms",
 "request": {
 "$ref": "Form"
@@ -198,6 +204,35 @@
 "https://www.googleapis.com/auth/forms.body",
 "https://www.googleapis.com/auth/forms.body.readonly"
 ]
+},
+"setPublishSettings": {
+"description": "Updates the publish settings of a form. Legacy forms aren't supported because they don't have the `publish_settings` field.",
+"flatPath": "v1/forms/{formId}:setPublishSettings",
+"httpMethod": "POST",
+"id": "forms.forms.setPublishSettings",
+"parameterOrder": [
+"formId"
+],
+"parameters": {
+"formId": {
+"description": "Required. The ID of the form. You can get the id from `Form.form_id` field.",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/forms/{formId}:setPublishSettings",
+"request": {
+"$ref": "SetPublishSettingsRequest"
+},
+"response": {
+"$ref": "SetPublishSettingsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/drive",
+"https://www.googleapis.com/auth/drive.file",
+"https://www.googleapis.com/auth/forms.body"
+]
 }
 },
 "resources": {
@@ -423,7 +458,7 @@
 }
 }
 },
-"revision": "20250218",
+"revision": "20250304",
 "rootUrl": "https://forms.googleapis.com/",
 "schemas": {
 "Answer": {
@@ -794,6 +829,11 @@
 "readOnly": true,
 "type": "string"
 },
+"publishSettings": {
+"$ref": "PublishSettings",
+"description": "Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form.",
+"readOnly": true
+},
 "responderUri": {
 "description": "Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions.",
 "readOnly": true,
@@ -1182,6 +1222,32 @@
 "properties": {},
 "type": "object"
 },
+"PublishSettings": {
+"description": "The publishing settings of a form.",
+"id": "PublishSettings",
+"properties": {
+"publishState": {
+"$ref": "PublishState",
+"description": "Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn't supported and returns an error."
+}
+},
+"type": "object"
+},
+"PublishState": {
+"description": "The publishing state of a form.",
+"id": "PublishState",
+"properties": {
+"isAcceptingResponses": {
+"description": "Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.",
+"type": "boolean"
+},
+"isPublished": {
+"description": "Required. Whether the form is published and visible to others.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "Question": {
 "description": "Any question. The specific type of question is known by its `kind`.",
 "id": "Question",
@@ -1393,6 +1459,37 @@
 },
 "type": "object"
 },
+"SetPublishSettingsRequest": {
+"description": "Updates the publish settings of a Form.",
+"id": "SetPublishSettingsRequest",
+"properties": {
+"publishSettings": {
+"$ref": "PublishSettings",
+"description": "Required. The desired publish settings to apply to the form."
+},
+"updateMask": {
+"description": "Optional. The `publish_settings` fields to update. This field mask accepts the following values: * `publish_state`: Updates or replaces all `publish_state` settings. * `\"*\"`: Updates or replaces all `publish_settings` fields.",
+"format": "google-fieldmask",
+"type": "string"
+}
+},
+"type": "object"
+},
+"SetPublishSettingsResponse": {
+"description": "The response of a `SetPublishSettings` request.",
+"id": "SetPublishSettingsResponse",
+"properties": {
+"formId": {
+"description": "Required. The ID of the Form. This is same as the `Form.form_id` field.",
+"type": "string"
+},
+"publishSettings": {
+"$ref": "PublishSettings",
+"description": "The publish settings of the form."
+}
+},
+"type": "object"
+},
 "TextAnswer": {
 "description": "An answer to a question represented as text.",
 "id": "TextAnswer",
