From 76ccae7efe4a5f6c1453c11d52079302b6d68729 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Thu, 23 Jan 2025 00:34:48 -0800 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#2976) --- calendar/v3/calendar-api.json | 171 +++++++++++++++--- calendar/v3/calendar-gen.go | 57 +++++- chat/v1/chat-api.json | 122 ++++++------- chat/v1/chat-gen.go | 130 ++++++------- dataportability/v1/dataportability-api.json | 9 +- dataportability/v1/dataportability-gen.go | 4 + .../v1beta/dataportability-api.json | 9 +- dataportability/v1beta/dataportability-gen.go | 4 + discoveryengine/v1/discoveryengine-api.json | 77 +++++++- discoveryengine/v1/discoveryengine-gen.go | 110 ++++++++++- .../v1alpha/discoveryengine-api.json | 116 +++++++++++- .../v1alpha/discoveryengine-gen.go | 146 ++++++++++++++- .../v1beta/discoveryengine-api.json | 116 +++++++++++- discoveryengine/v1beta/discoveryengine-gen.go | 147 ++++++++++++++- firebaseml/v2beta/firebaseml-api.json | 17 +- firebaseml/v2beta/firebaseml-gen.go | 27 +++ healthcare/v1beta1/healthcare-api.json | 5 +- healthcare/v1beta1/healthcare-gen.go | 4 +- orgpolicy/v2/orgpolicy-api.json | 58 +++--- orgpolicy/v2/orgpolicy-gen.go | 109 +++++------ retail/v2/retail-api.json | 5 +- retail/v2/retail-gen.go | 3 +- retail/v2alpha/retail-api.json | 5 +- retail/v2alpha/retail-gen.go | 3 +- retail/v2beta/retail-api.json | 5 +- retail/v2beta/retail-gen.go | 3 +- vmmigration/v1alpha1/vmmigration-api.json | 8 +- vmmigration/v1alpha1/vmmigration-gen.go | 2 + webfonts/v1/webfonts-api.json | 7 +- webfonts/v1/webfonts-gen.go | 8 + 30 files changed, 1198 insertions(+), 289 deletions(-) diff --git a/calendar/v3/calendar-api.json b/calendar/v3/calendar-api.json index c5abdfa9841..65fcc38a17a 100644 --- a/calendar/v3/calendar-api.json +++ b/calendar/v3/calendar-api.json @@ -5,12 +5,48 @@ "https://www.googleapis.com/auth/calendar": { "description": "See, edit, share, and permanently delete all the calendars you can access using Google Calendar" }, + "https://www.googleapis.com/auth/calendar.acls": { + "description": "See and change the sharing permissions of Google calendars you own" + }, + "https://www.googleapis.com/auth/calendar.acls.readonly": { + "description": "See the sharing permissions of Google calendars you own" + }, + "https://www.googleapis.com/auth/calendar.app.created": { + "description": "Make secondary Google calendars, and see, create, change, and delete events on them" + }, + "https://www.googleapis.com/auth/calendar.calendarlist": { + "description": "See, add, and remove Google calendars you’re subscribed to" + }, + "https://www.googleapis.com/auth/calendar.calendarlist.readonly": { + "description": "See the list of Google calendars you’re subscribed to" + }, + "https://www.googleapis.com/auth/calendar.calendars": { + "description": "See and change the properties of Google calendars you have access to, and create secondary calendars" + }, + "https://www.googleapis.com/auth/calendar.calendars.readonly": { + "description": "See the title, description, default time zone, and other properties of Google calendars you have access to" + }, "https://www.googleapis.com/auth/calendar.events": { "description": "View and edit events on all your calendars" }, + "https://www.googleapis.com/auth/calendar.events.freebusy": { + "description": "See the availability on Google calendars you have access to" + }, + "https://www.googleapis.com/auth/calendar.events.owned": { + "description": "See, create, change, and delete events on Google calendars you own" + }, + "https://www.googleapis.com/auth/calendar.events.owned.readonly": { + "description": "See the events on Google calendars you own" + }, + "https://www.googleapis.com/auth/calendar.events.public.readonly": { + "description": "See the events on public calendars" + }, "https://www.googleapis.com/auth/calendar.events.readonly": { "description": "View events on all your calendars" }, + "https://www.googleapis.com/auth/calendar.freebusy": { + "description": "View your availability in your calendars" + }, "https://www.googleapis.com/auth/calendar.readonly": { "description": "See and download any calendar you can access using your Google Calendar" }, @@ -108,7 +144,8 @@ }, "path": "calendars/{calendarId}/acl/{ruleId}", "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.acls" ] }, "get": { @@ -139,6 +176,8 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.acls", + "https://www.googleapis.com/auth/calendar.acls.readonly", "https://www.googleapis.com/auth/calendar.readonly" ] }, @@ -170,7 +209,8 @@ "$ref": "AclRule" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.acls" ] }, "list": { @@ -215,7 +255,9 @@ "$ref": "Acl" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.acls", + "https://www.googleapis.com/auth/calendar.acls.readonly" ], "supportsSubscription": true }, @@ -254,7 +296,8 @@ "$ref": "AclRule" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.acls" ] }, "update": { @@ -292,7 +335,8 @@ "$ref": "AclRule" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.acls" ] }, "watch": { @@ -341,7 +385,9 @@ "$ref": "Channel" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.acls", + "https://www.googleapis.com/auth/calendar.acls.readonly" ], "supportsSubscription": true } @@ -366,7 +412,9 @@ }, "path": "users/me/calendarList/{calendarId}", "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendarlist" ] }, "get": { @@ -390,6 +438,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendarlist", + "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.readonly" ] }, @@ -412,7 +463,8 @@ "$ref": "CalendarListEntry" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.calendarlist" ] }, "list": { @@ -471,6 +523,8 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.calendarlist", + "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], "supportsSubscription": true @@ -503,7 +557,9 @@ "$ref": "CalendarListEntry" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendarlist" ] }, "update": { @@ -534,7 +590,9 @@ "$ref": "CalendarListEntry" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendarlist" ] }, "watch": { @@ -597,6 +655,8 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.calendarlist", + "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], "supportsSubscription": true @@ -622,7 +682,8 @@ }, "path": "calendars/{calendarId}/clear", "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.calendars" ] }, "delete": { @@ -642,7 +703,9 @@ }, "path": "calendars/{calendarId}", "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendars" ] }, "get": { @@ -666,6 +729,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendars", + "https://www.googleapis.com/auth/calendar.calendars.readonly", "https://www.googleapis.com/auth/calendar.readonly" ] }, @@ -681,7 +747,9 @@ "$ref": "Calendar" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendars" ] }, "patch": { @@ -707,7 +775,9 @@ "$ref": "Calendar" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendars" ] }, "update": { @@ -733,7 +803,9 @@ "$ref": "Calendar" }, "scopes": [ - "https://www.googleapis.com/auth/calendar" + "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendars" ] } } @@ -751,7 +823,16 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.acls", + "https://www.googleapis.com/auth/calendar.acls.readonly", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendarlist", + "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.freebusy", + "https://www.googleapis.com/auth/calendar.events.owned", + "https://www.googleapis.com/auth/calendar.events.owned.readonly", + "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly", "https://www.googleapis.com/auth/calendar.settings.readonly" @@ -771,6 +852,13 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendarlist", + "https://www.googleapis.com/auth/calendar.calendarlist.readonly", + "https://www.googleapis.com/auth/calendar.events.freebusy", + "https://www.googleapis.com/auth/calendar.events.owned", + "https://www.googleapis.com/auth/calendar.events.owned.readonly", + "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.readonly" ] } @@ -823,7 +911,9 @@ "path": "calendars/{calendarId}/events/{eventId}", "scopes": [ "https://www.googleapis.com/auth/calendar", - "https://www.googleapis.com/auth/calendar.events" + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.owned" ] }, "get": { @@ -871,7 +961,12 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.freebusy", + "https://www.googleapis.com/auth/calendar.events.owned", + "https://www.googleapis.com/auth/calendar.events.owned.readonly", + "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly" ] @@ -913,7 +1008,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", - "https://www.googleapis.com/auth/calendar.events" + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.owned" ] }, "insert": { @@ -980,7 +1077,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", - "https://www.googleapis.com/auth/calendar.events" + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.owned" ] }, "instances": { @@ -1062,7 +1161,12 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.freebusy", + "https://www.googleapis.com/auth/calendar.events.owned", + "https://www.googleapis.com/auth/calendar.events.owned.readonly", + "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], @@ -1214,7 +1318,12 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.freebusy", + "https://www.googleapis.com/auth/calendar.events.owned", + "https://www.googleapis.com/auth/calendar.events.owned.readonly", + "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], @@ -1275,7 +1384,8 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", - "https://www.googleapis.com/auth/calendar.events" + "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.owned" ] }, "patch": { @@ -1354,7 +1464,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", - "https://www.googleapis.com/auth/calendar.events" + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.owned" ] }, "quickAdd": { @@ -1405,7 +1517,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", - "https://www.googleapis.com/auth/calendar.events" + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.owned" ] }, "update": { @@ -1484,7 +1598,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", - "https://www.googleapis.com/auth/calendar.events" + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.owned" ] }, "watch": { @@ -1637,7 +1753,12 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.freebusy", + "https://www.googleapis.com/auth/calendar.events.owned", + "https://www.googleapis.com/auth/calendar.events.owned.readonly", + "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], @@ -1660,6 +1781,8 @@ }, "scopes": [ "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.events.freebusy", + "https://www.googleapis.com/auth/calendar.freebusy", "https://www.googleapis.com/auth/calendar.readonly" ] } @@ -1767,7 +1890,7 @@ } } }, - "revision": "20241101", + "revision": "20250115", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -1822,7 +1945,7 @@ "calendar.acl.insert" ] }, - "description": "The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.", + "description": "The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. \n- \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs.", "type": "string" }, "scope": { diff --git a/calendar/v3/calendar-gen.go b/calendar/v3/calendar-gen.go index 04e806a590c..4081446917c 100644 --- a/calendar/v3/calendar-gen.go +++ b/calendar/v3/calendar-gen.go @@ -106,12 +106,51 @@ const ( // using Google Calendar CalendarScope = "https://www.googleapis.com/auth/calendar" + // See and change the sharing permissions of Google calendars you own + CalendarAclsScope = "https://www.googleapis.com/auth/calendar.acls" + + // See the sharing permissions of Google calendars you own + CalendarAclsReadonlyScope = "https://www.googleapis.com/auth/calendar.acls.readonly" + + // Make secondary Google calendars, and see, create, change, and delete events + // on them + CalendarAppCreatedScope = "https://www.googleapis.com/auth/calendar.app.created" + + // See, add, and remove Google calendars you’re subscribed to + CalendarCalendarlistScope = "https://www.googleapis.com/auth/calendar.calendarlist" + + // See the list of Google calendars you’re subscribed to + CalendarCalendarlistReadonlyScope = "https://www.googleapis.com/auth/calendar.calendarlist.readonly" + + // See and change the properties of Google calendars you have access to, and + // create secondary calendars + CalendarCalendarsScope = "https://www.googleapis.com/auth/calendar.calendars" + + // See the title, description, default time zone, and other properties of + // Google calendars you have access to + CalendarCalendarsReadonlyScope = "https://www.googleapis.com/auth/calendar.calendars.readonly" + // View and edit events on all your calendars CalendarEventsScope = "https://www.googleapis.com/auth/calendar.events" + // See the availability on Google calendars you have access to + CalendarEventsFreebusyScope = "https://www.googleapis.com/auth/calendar.events.freebusy" + + // See, create, change, and delete events on Google calendars you own + CalendarEventsOwnedScope = "https://www.googleapis.com/auth/calendar.events.owned" + + // See the events on Google calendars you own + CalendarEventsOwnedReadonlyScope = "https://www.googleapis.com/auth/calendar.events.owned.readonly" + + // See the events on public calendars + CalendarEventsPublicReadonlyScope = "https://www.googleapis.com/auth/calendar.events.public.readonly" + // View events on all your calendars CalendarEventsReadonlyScope = "https://www.googleapis.com/auth/calendar.events.readonly" + // View your availability in your calendars + CalendarFreebusyScope = "https://www.googleapis.com/auth/calendar.freebusy" + // See and download any calendar you can access using your Google Calendar CalendarReadonlyScope = "https://www.googleapis.com/auth/calendar.readonly" @@ -123,8 +162,20 @@ const ( func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) { scopesOption := internaloption.WithDefaultScopes( "https://www.googleapis.com/auth/calendar", + "https://www.googleapis.com/auth/calendar.acls", + "https://www.googleapis.com/auth/calendar.acls.readonly", + "https://www.googleapis.com/auth/calendar.app.created", + "https://www.googleapis.com/auth/calendar.calendarlist", + "https://www.googleapis.com/auth/calendar.calendarlist.readonly", + "https://www.googleapis.com/auth/calendar.calendars", + "https://www.googleapis.com/auth/calendar.calendars.readonly", "https://www.googleapis.com/auth/calendar.events", + "https://www.googleapis.com/auth/calendar.events.freebusy", + "https://www.googleapis.com/auth/calendar.events.owned", + "https://www.googleapis.com/auth/calendar.events.owned.readonly", + "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", + "https://www.googleapis.com/auth/calendar.freebusy", "https://www.googleapis.com/auth/calendar.readonly", "https://www.googleapis.com/auth/calendar.settings.readonly", ) @@ -318,10 +369,10 @@ type AclRule struct { // appear to users with reader access, but event details will be hidden. // - "writer" - Provides read and write access to the calendar. Private events // will appear to users with writer access, and event details will be visible. - // + // Provides read access to the calendar's ACLs. // - "owner" - Provides ownership of the calendar. This role has all of the - // permissions of the writer role with the additional ability to see and - // manipulate ACLs. + // permissions of the writer role with the additional ability to manipulate + // ACLs. Role string `json:"role,omitempty"` // Scope: The extent to which calendar access is granted by this ACL rule. Scope *AclRuleScope `json:"scope,omitempty"` diff --git a/chat/v1/chat-api.json b/chat/v1/chat-api.json index 584fe7e7298..5cf3be9d5ad 100644 --- a/chat/v1/chat-api.json +++ b/chat/v1/chat-api.json @@ -1344,7 +1344,7 @@ } } }, - "revision": "20250114", + "revision": "20250116", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2166,11 +2166,11 @@ "type": "object" }, "GoogleAppsCardV1Action": { - "description": "An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Action", "properties": { "allWidgetsAreRequired": { - "description": "Optional. If this is true, then all widgets are considered required by this action. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "boolean" }, "function": { @@ -2213,7 +2213,7 @@ "type": "boolean" }, "requiredWidgets": { - "description": "Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "items": { "type": "string" }, @@ -2223,7 +2223,7 @@ "type": "object" }, "GoogleAppsCardV1ActionParameter": { - "description": "List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1ActionParameter", "properties": { "key": { @@ -2238,7 +2238,7 @@ "type": "object" }, "GoogleAppsCardV1BorderStyle": { - "description": "The style options for the border of a card or widget, including the border type and color. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "The style options for the border of a card or widget, including the border type and color. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1BorderStyle", "properties": { "cornerRadius": { @@ -2268,7 +2268,7 @@ "type": "object" }, "GoogleAppsCardV1Button": { - "description": "A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). To make an image a clickable button, specify an `Image` (not an `ImageComponent`) and set an `onClick` action. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). To make an image a clickable button, specify an `Image` (not an `ImageComponent`) and set an `onClick` action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Button", "properties": { "altText": { @@ -2317,7 +2317,7 @@ "type": "object" }, "GoogleAppsCardV1ButtonList": { - "description": "A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1ButtonList", "properties": { "buttons": { @@ -2331,18 +2331,18 @@ "type": "object" }, "GoogleAppsCardV1Card": { - "description": "A card interface displayed in a Google Chat message or Google Workspace Add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace Add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace Add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\", \"imageType\": \"CIRCLE\", \"imageAltText\": \"Avatar for Sasha\" }, \"sections\": [ { \"header\": \"Contact Info\", \"collapsible\": true, \"uncollapsibleWidgetsCount\": 1, \"widgets\": [ { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\" }, \"text\": \"sasha@example.com\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PERSON\" }, \"text\": \"Online\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PHONE\" }, \"text\": \"+1 (555) 555-1234\" } }, { \"buttonList\": { \"buttons\": [ { \"text\": \"Share\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/share\" } } }, { \"text\": \"Edit\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"EDIT\" } ] } } } ] } } ] } ] } } ] } ```", + "description": "A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\", \"imageType\": \"CIRCLE\", \"imageAltText\": \"Avatar for Sasha\" }, \"sections\": [ { \"header\": \"Contact Info\", \"collapsible\": true, \"uncollapsibleWidgetsCount\": 1, \"widgets\": [ { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\" }, \"text\": \"sasha@example.com\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PERSON\" }, \"text\": \"Online\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PHONE\" }, \"text\": \"+1 (555) 555-1234\" } }, { \"buttonList\": { \"buttons\": [ { \"text\": \"Share\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/share\" } } }, { \"text\": \"Edit\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"EDIT\" } ] } } } ] } } ] } ] } } ] } ```", "id": "GoogleAppsCardV1Card", "properties": { "cardActions": { - "description": "The card's actions. Actions are added to the card's toolbar menu. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` \"card_actions\": [ { \"actionLabel\": \"Settings\", \"onClick\": { \"action\": { \"functionName\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"SETTING\" } ], \"loadIndicator\": \"LoadIndicator.SPINNER\" } } }, { \"actionLabel\": \"Send Feedback\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/feedback\" } } } ] ```", + "description": "The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` \"card_actions\": [ { \"actionLabel\": \"Settings\", \"onClick\": { \"action\": { \"functionName\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"SETTING\" } ], \"loadIndicator\": \"LoadIndicator.SPINNER\" } } }, { \"actionLabel\": \"Send Feedback\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/feedback\" } } } ] ```", "items": { "$ref": "GoogleAppsCardV1CardAction" }, "type": "array" }, "displayStyle": { - "description": "In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):", + "description": "In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):", "enum": [ "DISPLAY_STYLE_UNSPECIFIED", "PEEK", @@ -2357,19 +2357,19 @@ }, "fixedFooter": { "$ref": "GoogleAppsCardV1CardFixedFooter", - "description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):" + "description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "header": { "$ref": "GoogleAppsCardV1CardHeader", "description": "The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card." }, "name": { - "description": "Name of the card. Used as a card identifier in card navigation. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):", + "description": "Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):", "type": "string" }, "peekCardHeader": { "$ref": "GoogleAppsCardV1CardHeader", - "description": "When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):" + "description": "When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "sectionDividerStyle": { "description": "The divider style between the header, sections and footer.", @@ -2396,7 +2396,7 @@ "type": "object" }, "GoogleAppsCardV1CardAction": { - "description": "A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):", + "description": "A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):", "id": "GoogleAppsCardV1CardAction", "properties": { "actionLabel": { @@ -2411,7 +2411,7 @@ "type": "object" }, "GoogleAppsCardV1CardFixedFooter": { - "description": "A persistent (sticky) footer that that appears at the bottom of the card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). For an example in Google Chat apps, see [Add a persistent footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A persistent (sticky) footer that that appears at the bottom of the card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). For an example in Google Chat apps, see [Add a persistent footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1CardFixedFooter", "properties": { "primaryButton": { @@ -2426,7 +2426,7 @@ "type": "object" }, "GoogleAppsCardV1CardHeader": { - "description": "Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1CardHeader", "properties": { "imageAltText": { @@ -2434,7 +2434,7 @@ "type": "string" }, "imageType": { - "description": "The shape used to crop the image. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "enum": [ "SQUARE", "CIRCLE" @@ -2496,7 +2496,7 @@ "type": "object" }, "GoogleAppsCardV1Chip": { - "description": "A text, icon, or text and icon chip that users can click. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A text, icon, or text and icon chip that users can click. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Chip", "properties": { "altText": { @@ -2528,7 +2528,7 @@ "type": "object" }, "GoogleAppsCardV1ChipList": { - "description": "A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1ChipList", "properties": { "chips": { @@ -2556,7 +2556,7 @@ "type": "object" }, "GoogleAppsCardV1CollapseControl": { - "description": "Represent an expand and collapse control. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Represent an expand and collapse control. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1CollapseControl", "properties": { "collapseButton": { @@ -2587,7 +2587,7 @@ "type": "object" }, "GoogleAppsCardV1Column": { - "description": "A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend)", + "description": "A column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)", "id": "GoogleAppsCardV1Column", "properties": { "horizontalAlignment": { @@ -2647,7 +2647,7 @@ "type": "object" }, "GoogleAppsCardV1Columns": { - "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event.", + "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event.", "id": "GoogleAppsCardV1Columns", "properties": { "columnItems": { @@ -2661,7 +2661,7 @@ "type": "object" }, "GoogleAppsCardV1DateTimePicker": { - "description": "Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1DateTimePicker", "properties": { "label": { @@ -2704,7 +2704,7 @@ "type": "object" }, "GoogleAppsCardV1DecoratedText": { - "description": "A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1DecoratedText", "properties": { "bottomLabel": { @@ -2737,7 +2737,7 @@ "description": "A switch widget that a user can click to change its state and trigger an action." }, "text": { - "description": "Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", + "description": "Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "topLabel": { @@ -2752,13 +2752,13 @@ "type": "object" }, "GoogleAppsCardV1Divider": { - "description": "Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` \"divider\": {} ```", + "description": "Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` \"divider\": {} ```", "id": "GoogleAppsCardV1Divider", "properties": {}, "type": "object" }, "GoogleAppsCardV1Grid": { - "description": "Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use `Columns`. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` \"grid\": { \"title\": \"A fine collection of items\", \"columnCount\": 2, \"borderStyle\": { \"type\": \"STROKE\", \"cornerRadius\": 4 }, \"items\": [ { \"image\": { \"imageUri\": \"https://www.example.com/image.png\", \"cropStyle\": { \"type\": \"SQUARE\" }, \"borderStyle\": { \"type\": \"STROKE\" } }, \"title\": \"An item\", \"textAlignment\": \"CENTER\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```", + "description": "Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use `Columns`. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` \"grid\": { \"title\": \"A fine collection of items\", \"columnCount\": 2, \"borderStyle\": { \"type\": \"STROKE\", \"cornerRadius\": 4 }, \"items\": [ { \"image\": { \"imageUri\": \"https://www.example.com/image.png\", \"cropStyle\": { \"type\": \"SQUARE\" }, \"borderStyle\": { \"type\": \"STROKE\" } }, \"title\": \"An item\", \"textAlignment\": \"CENTER\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```", "id": "GoogleAppsCardV1Grid", "properties": { "borderStyle": { @@ -2789,7 +2789,7 @@ "type": "object" }, "GoogleAppsCardV1GridItem": { - "description": "Represents an item in a grid layout. Items can contain text, an image, or both text and an image. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Represents an item in a grid layout. Items can contain text, an image, or both text and an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1GridItem", "properties": { "id": { @@ -2826,7 +2826,7 @@ "type": "object" }, "GoogleAppsCardV1Icon": { - "description": "An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Icon", "properties": { "altText": { @@ -2861,7 +2861,7 @@ "type": "object" }, "GoogleAppsCardV1Image": { - "description": "An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Image", "properties": { "altText": { @@ -2880,7 +2880,7 @@ "type": "object" }, "GoogleAppsCardV1ImageComponent": { - "description": "Represents an image. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Represents an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1ImageComponent", "properties": { "altText": { @@ -2903,7 +2903,7 @@ "type": "object" }, "GoogleAppsCardV1ImageCropStyle": { - "description": "Represents the crop style applied to an image. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```", + "description": "Represents the crop style applied to an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```", "id": "GoogleAppsCardV1ImageCropStyle", "properties": { "aspectRatio": { @@ -2977,7 +2977,7 @@ "type": "object" }, "GoogleAppsCardV1OnClick": { - "description": "Represents how to respond when users click an interactive element on a card, such as a button. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Represents how to respond when users click an interactive element on a card, such as a button. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1OnClick", "properties": { "action": { @@ -2986,11 +2986,11 @@ }, "card": { "$ref": "GoogleAppsCardV1Card", - "description": "A new card is pushed to the card stack after clicking if specified. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):" + "description": "A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "openDynamicLinkAction": { "$ref": "GoogleAppsCardV1Action", - "description": "An add-on triggers this action when the action needs to open a link. This differs from the `open_link` above in that this needs to talk to server to get the link. Thus some preparation work is required for web client to do before the open link action response comes back. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):" + "description": "An add-on triggers this action when the action needs to open a link. This differs from the `open_link` above in that this needs to talk to server to get the link. Thus some preparation work is required for web client to do before the open link action response comes back. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "openLink": { "$ref": "GoogleAppsCardV1OpenLink", @@ -3004,11 +3004,11 @@ "type": "object" }, "GoogleAppsCardV1OpenLink": { - "description": "Represents an `onClick` event that opens a hyperlink. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Represents an `onClick` event that opens a hyperlink. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1OpenLink", "properties": { "onClose": { - "description": "Whether the client forgets about a link after opening it, or observes it until the window closes. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):", + "description": "Whether the client forgets about a link after opening it, or observes it until the window closes. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):", "enum": [ "NOTHING", "RELOAD" @@ -3020,7 +3020,7 @@ "type": "string" }, "openAs": { - "description": "How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):", + "description": "How to open a link. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):", "enum": [ "FULL_SIZE", "OVERLAY" @@ -3039,7 +3039,7 @@ "type": "object" }, "GoogleAppsCardV1OverflowMenu": { - "description": "A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1OverflowMenu", "properties": { "items": { @@ -3053,7 +3053,7 @@ "type": "object" }, "GoogleAppsCardV1OverflowMenuItem": { - "description": "An option that users can invoke in an overflow menu. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "An option that users can invoke in an overflow menu. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1OverflowMenuItem", "properties": { "disabled": { @@ -3099,7 +3099,7 @@ "type": "object" }, "GoogleAppsCardV1Section": { - "description": "A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Section", "properties": { "collapseControl": { @@ -3111,7 +3111,7 @@ "type": "boolean" }, "header": { - "description": "Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", + "description": "Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "uncollapsibleWidgetsCount": { @@ -3130,7 +3130,7 @@ "type": "object" }, "GoogleAppsCardV1SelectionInput": { - "description": "A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1SelectionInput", "properties": { "externalDataSource": { @@ -3184,7 +3184,7 @@ "A set of radio buttons. Users can select one radio button.", "A set of switches. Users can turn on one or more switches.", "A dropdown menu. Users can select one item from the menu.", - "A menu with a text box. Users can type and select one or more items. For Google Workspace Add-ons, you must populate items using a static array of `SelectionItem` objects. For Google Chat apps, you can also populate items using a dynamic data source and autosuggest items as users type in the menu. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To dynamically populate items for a multiselect menu, use one of the following types of data sources: * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus for Chat apps, see [Add a multiselect menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):" + "A menu with a text box. Users can type and select one or more items. For Google Workspace add-ons, you must populate items using a static array of `SelectionItem` objects. For Google Chat apps, you can also populate items using a dynamic data source and autosuggest items as users type in the menu. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To dynamically populate items for a multiselect menu, use one of the following types of data sources: * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus for Chat apps, see [Add a multiselect menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" ], "type": "string" } @@ -3192,7 +3192,7 @@ "type": "object" }, "GoogleAppsCardV1SelectionItem": { - "description": "An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1SelectionItem", "properties": { "bottomText": { @@ -3219,7 +3219,7 @@ "type": "object" }, "GoogleAppsCardV1SuggestionItem": { - "description": "One suggested value that users can enter in a text input field. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "One suggested value that users can enter in a text input field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1SuggestionItem", "properties": { "text": { @@ -3230,7 +3230,7 @@ "type": "object" }, "GoogleAppsCardV1Suggestions": { - "description": "Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Suggestions", "properties": { "items": { @@ -3244,11 +3244,11 @@ "type": "object" }, "GoogleAppsCardV1SwitchControl": { - "description": "Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget.", + "description": "Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget.", "id": "GoogleAppsCardV1SwitchControl", "properties": { "controlType": { - "description": "How the switch appears in the user interface. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "enum": [ "SWITCH", "CHECKBOX", @@ -3281,12 +3281,12 @@ "type": "object" }, "GoogleAppsCardV1TextInput": { - "description": "A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1TextInput", "properties": { "autoCompleteAction": { "$ref": "GoogleAppsCardV1Action", - "description": "Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):" + "description": "Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "hintText": { "description": "Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional.", @@ -3294,7 +3294,7 @@ }, "initialSuggestions": { "$ref": "GoogleAppsCardV1Suggestions", - "description": "Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show just `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):" + "description": "Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show just `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "label": { "description": "The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.", @@ -3326,7 +3326,7 @@ }, "validation": { "$ref": "GoogleAppsCardV1Validation", - "description": "Specify the input format validation necessary for this text field. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):" + "description": "Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "value": { "description": "The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).", @@ -3336,7 +3336,7 @@ "type": "object" }, "GoogleAppsCardV1TextParagraph": { - "description": "A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1TextParagraph", "properties": { "maxLines": { @@ -3352,16 +3352,16 @@ "type": "object" }, "GoogleAppsCardV1Validation": { - "description": "Represents the necessary data for validating the widget it's attached to. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Represents the necessary data for validating the widget it's attached to. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Validation", "properties": { "characterLimit": { - "description": "Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "format": "int32", "type": "integer" }, "inputType": { - "description": "Specify the type of the input widgets. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "enum": [ "INPUT_TYPE_UNSPECIFIED", "TEXT", @@ -3417,7 +3417,7 @@ }, "grid": { "$ref": "GoogleAppsCardV1Grid", - "description": "Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` \"grid\": { \"title\": \"A fine collection of items\", \"columnCount\": 2, \"borderStyle\": { \"type\": \"STROKE\", \"cornerRadius\": 4 }, \"items\": [ { \"image\": { \"imageUri\": \"https://www.example.com/image.png\", \"cropStyle\": { \"type\": \"SQUARE\" }, \"borderStyle\": { \"type\": \"STROKE\" } }, \"title\": \"An item\", \"textAlignment\": \"CENTER\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```" + "description": "Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` \"grid\": { \"title\": \"A fine collection of items\", \"columnCount\": 2, \"borderStyle\": { \"type\": \"STROKE\", \"cornerRadius\": 4 }, \"items\": [ { \"image\": { \"imageUri\": \"https://www.example.com/image.png\", \"cropStyle\": { \"type\": \"SQUARE\" }, \"borderStyle\": { \"type\": \"STROKE\" } }, \"title\": \"An item\", \"textAlignment\": \"CENTER\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```" }, "horizontalAlignment": { "description": "Specifies whether widgets align to the left, right, or center of a column.", @@ -3449,13 +3449,13 @@ }, "textParagraph": { "$ref": "GoogleAppsCardV1TextParagraph", - "description": "Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```" + "description": "Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```" } }, "type": "object" }, "GoogleAppsCardV1Widgets": { - "description": "The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend)", + "description": "The supported widgets that you can include in a column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)", "id": "GoogleAppsCardV1Widgets", "properties": { "buttonList": { diff --git a/chat/v1/chat-gen.go b/chat/v1/chat-gen.go index f4e99963ef2..7d1f994b5ad 100644 --- a/chat/v1/chat-gen.go +++ b/chat/v1/chat-gen.go @@ -1663,11 +1663,11 @@ func (s FormAction) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1Action: An action that describes the behavior when the form // is submitted. For example, you can invoke an Apps Script script to handle // the form. If the action is triggered, the form values are sent to the -// server. Google Workspace Add-ons and Chat apps +// server. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1Action struct { // AllWidgetsAreRequired: Optional. If this is true, then all widgets are - // considered required by this action. Google Workspace Add-ons and Chat apps + // considered required by this action. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): AllWidgetsAreRequired bool `json:"allWidgetsAreRequired,omitempty"` // Function: A custom function to invoke when the containing element is clicked @@ -1726,7 +1726,7 @@ type GoogleAppsCardV1Action struct { // RequiredWidgets: Optional. Fill this list with the names of widgets that // this Action needs for a valid submission. If the widgets listed here don't // have a value when this Action is invoked, the form submission is aborted. - // Google Workspace Add-ons and Chat apps + // Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): RequiredWidgets []string `json:"requiredWidgets,omitempty"` // ForceSendFields is a list of field names (e.g. "AllWidgetsAreRequired") to @@ -1753,7 +1753,7 @@ func (s GoogleAppsCardV1Action) MarshalJSON() ([]byte, error) { // method = snooze()`, passing the snooze type and snooze time in the list of // string parameters. To learn more, see `CommonEventObject` // (https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). -// Google Workspace Add-ons and Chat apps +// Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1ActionParameter struct { // Key: The name of the parameter for the action script. @@ -1779,7 +1779,7 @@ func (s GoogleAppsCardV1ActionParameter) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1BorderStyle: The style options for the border of a card or -// widget, including the border type and color. Google Workspace Add-ons and +// widget, including the border type and color. Google Workspace add-ons and // Chat apps (https://developers.google.com/workspace/extend): type GoogleAppsCardV1BorderStyle struct { // CornerRadius: The corner radius for the border. @@ -1822,7 +1822,7 @@ func (s GoogleAppsCardV1BorderStyle) MarshalJSON() ([]byte, error) { // click. For an example in Google Chat apps, see Add a button // (https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). // To make an image a clickable button, specify an `Image` (not an -// `ImageComponent`) and set an `onClick` action. Google Workspace Add-ons and +// `ImageComponent`) and set an `onClick` action. Google Workspace add-ons and // Chat apps (https://developers.google.com/workspace/extend): type GoogleAppsCardV1Button struct { // AltText: The alternative text that's used for accessibility. Set descriptive @@ -1895,7 +1895,7 @@ func (s GoogleAppsCardV1Button) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1ButtonList: A list of buttons layed out horizontally. For an // example in Google Chat apps, see Add a button // (https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). -// Google Workspace Add-ons and Chat apps +// Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1ButtonList struct { // Buttons: An array of buttons. @@ -1919,18 +1919,18 @@ func (s GoogleAppsCardV1ButtonList) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1Card: A card interface displayed in a Google Chat message or -// Google Workspace Add-on. Cards support a defined layout, interactive UI +// Google Workspace add-on. Cards support a defined layout, interactive UI // elements like buttons, and rich media like images. Use cards to present // detailed information, gather information from users, and guide users to take // a next step. Card builder (https://addons.gsuite.google.com/uikit/builder) // To learn how to build cards, see the following documentation: * For Google // Chat apps, see Design the components of a card or dialog // (https://developers.google.com/workspace/chat/design-components-card-dialog). -// * For Google Workspace Add-ons, see Card-based interfaces +// * For Google Workspace add-ons, see Card-based interfaces // (https://developers.google.com/apps-script/add-ons/concepts/cards). Note: // You can add up to 100 widgets per card. Any widgets beyond this limit are // ignored. This limit applies to both card messages and dialogs in Google Chat -// apps, and to cards in Google Workspace Add-ons. **Example: Card message for +// apps, and to cards in Google Workspace add-ons. **Example: Card message for // a Google Chat app** !Example contact card // (https://developers.google.com/workspace/chat/images/card_api_reference.png) // To create the sample card message in Google Chat, use the following JSON: @@ -1950,7 +1950,7 @@ func (s GoogleAppsCardV1ButtonList) MarshalJSON() ([]byte, error) { // } ] } ``` type GoogleAppsCardV1Card struct { // CardActions: The card's actions. Actions are added to the card's toolbar - // menu. Google Workspace Add-ons + // menu. Google Workspace add-ons // (https://developers.google.com/workspace/add-ons): For example, the // following JSON constructs a card action menu with `Settings` and `Send // Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", @@ -1959,8 +1959,8 @@ type GoogleAppsCardV1Card struct { // "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": // { "openLink": { "url": "https://example.com/feedback" } } } ] ``` CardActions []*GoogleAppsCardV1CardAction `json:"cardActions,omitempty"` - // DisplayStyle: In Google Workspace Add-ons, sets the display properties of - // the `peekCardHeader`. Google Workspace Add-ons + // DisplayStyle: In Google Workspace add-ons, sets the display properties of + // the `peekCardHeader`. Google Workspace add-ons // (https://developers.google.com/workspace/add-ons): // // Possible values: @@ -1978,18 +1978,18 @@ type GoogleAppsCardV1Card struct { // (https://developers.google.com/workspace/chat/dialogs), but not card // messages // (https://developers.google.com/workspace/chat/create-messages#create). - // Google Workspace Add-ons and Chat apps + // Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): FixedFooter *GoogleAppsCardV1CardFixedFooter `json:"fixedFooter,omitempty"` // Header: The header of the card. A header usually contains a leading image // and a title. Headers always appear at the top of a card. Header *GoogleAppsCardV1CardHeader `json:"header,omitempty"` // Name: Name of the card. Used as a card identifier in card navigation. Google - // Workspace Add-ons (https://developers.google.com/workspace/add-ons): + // Workspace add-ons (https://developers.google.com/workspace/add-ons): Name string `json:"name,omitempty"` // PeekCardHeader: When displaying contextual content, the peek card header // acts as a placeholder so that the user can navigate forward between the - // homepage cards and the contextual cards. Google Workspace Add-ons + // homepage cards and the contextual cards. Google Workspace add-ons // (https://developers.google.com/workspace/add-ons): PeekCardHeader *GoogleAppsCardV1CardHeader `json:"peekCardHeader,omitempty"` // SectionDividerStyle: The divider style between the header, sections and @@ -2028,7 +2028,7 @@ func (s GoogleAppsCardV1Card) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1CardAction: A card action is the action associated with the // card. For example, an invoice card might include actions such as delete // invoice, email invoice, or open the invoice in a browser. Google Workspace -// Add-ons (https://developers.google.com/workspace/add-ons): +// add-ons (https://developers.google.com/workspace/add-ons): type GoogleAppsCardV1CardAction struct { // ActionLabel: The label that displays as the action menu item. ActionLabel string `json:"actionLabel,omitempty"` @@ -2061,7 +2061,7 @@ func (s GoogleAppsCardV1CardAction) MarshalJSON() ([]byte, error) { // (https://developers.google.com/workspace/chat/create-messages#create). For // an example in Google Chat apps, see Add a persistent footer // (https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer). -// Google Workspace Add-ons and Chat apps +// Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1CardFixedFooter struct { // PrimaryButton: The primary button of the fixed footer. The button must be a @@ -2092,13 +2092,13 @@ func (s GoogleAppsCardV1CardFixedFooter) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1CardHeader: Represents a card header. For an example in // Google Chat apps, see Add a header // (https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). -// Google Workspace Add-ons and Chat apps +// Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1CardHeader struct { // ImageAltText: The alternative text of this image that's used for // accessibility. ImageAltText string `json:"imageAltText,omitempty"` - // ImageType: The shape used to crop the image. Google Workspace Add-ons and + // ImageType: The shape used to crop the image. Google Workspace add-ons and // Chat apps (https://developers.google.com/workspace/extend): // // Possible values: @@ -2196,7 +2196,7 @@ func (s GoogleAppsCardV1CarouselCard) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1Chip: A text, icon, or text and icon chip that users can -// click. Google Workspace Add-ons and Chat apps +// click. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1Chip struct { // AltText: The alternative text that's used for accessibility. Set descriptive @@ -2238,7 +2238,7 @@ func (s GoogleAppsCardV1Chip) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1ChipList: A list of chips layed out horizontally, which can // either scroll horizontally or wrap to the next line. Google Workspace -// Add-ons and Chat apps (https://developers.google.com/workspace/extend): +// add-ons and Chat apps (https://developers.google.com/workspace/extend): type GoogleAppsCardV1ChipList struct { // Chips: An array of chips. Chips []*GoogleAppsCardV1Chip `json:"chips,omitempty"` @@ -2270,7 +2270,7 @@ func (s GoogleAppsCardV1ChipList) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1CollapseControl: Represent an expand and collapse control. -// Google Workspace Add-ons and Chat apps +// Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1CollapseControl struct { // CollapseButton: Optional. Define a customizable button to collapse the @@ -2314,7 +2314,7 @@ func (s GoogleAppsCardV1CollapseControl) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleAppsCardV1Column: A column. Google Workspace Add-ons and Chat apps +// GoogleAppsCardV1Column: A column. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend) type GoogleAppsCardV1Column struct { // HorizontalAlignment: Specifies whether widgets align to the left, right, or @@ -2386,7 +2386,7 @@ func (s GoogleAppsCardV1Column) MarshalJSON() ([]byte, error) { // * On iOS devices, the second column wraps if the screen width is less than // or equal to 300 pt. * On Android devices, the second column wraps if the // screen width is less than or equal to 320 dp. To include more than two -// columns, or to use rows, use the `Grid` widget. Google Workspace Add-ons and +// columns, or to use rows, use the `Grid` widget. Google Workspace add-ons and // Chat apps (https://developers.google.com/workspace/extend): The add-on UIs // that support columns include: * The dialog displayed when users open the // add-on from an email draft. * The dialog displayed when users open the @@ -2422,7 +2422,7 @@ func (s GoogleAppsCardV1Columns) MarshalJSON() ([]byte, error) { // (https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). // Users can input text or use the picker to select dates and times. If users // input an invalid date or time, the picker shows an error that prompts users -// to input the information correctly. Google Workspace Add-ons and Chat apps +// to input the information correctly. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1DateTimePicker struct { // Label: The text that prompts users to input a date, a time, or a date and @@ -2480,7 +2480,7 @@ func (s GoogleAppsCardV1DateTimePicker) MarshalJSON() ([]byte, error) { // text, a selection widget, or a button after the text. For an example in // Google Chat apps, see Display text with decorative text // (https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). -// Google Workspace Add-ons and Chat apps +// Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1DecoratedText struct { // BottomLabel: The text that appears below `text`. Always wraps. @@ -2506,7 +2506,7 @@ type GoogleAppsCardV1DecoratedText struct { // Text: Required. The primary text. Supports simple formatting. For more // information about formatting text, see Formatting text in Google Chat apps // (https://developers.google.com/workspace/chat/format-messages#card-formatting) - // and Formatting text in Google Workspace Add-ons + // and Formatting text in Google Workspace add-ons // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). Text string `json:"text,omitempty"` // TopLabel: The text that appears above `text`. Always truncates. @@ -2537,7 +2537,7 @@ func (s GoogleAppsCardV1DecoratedText) MarshalJSON() ([]byte, error) { // line. For an example in Google Chat apps, see Add a horizontal divider // between widgets // (https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). -// Google Workspace Add-ons and Chat apps +// Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): For example, the following // JSON creates a divider: ``` "divider": {} ``` type GoogleAppsCardV1Divider struct { @@ -2551,7 +2551,7 @@ type GoogleAppsCardV1Divider struct { // A grid supports any number of columns and items. The number of rows is // determined by items divided by columns. A grid with 10 items and 2 columns // has 5 rows. A grid with 11 items and 2 columns has 6 rows. Google Workspace -// Add-ons and Chat apps (https://developers.google.com/workspace/extend): For +// add-ons and Chat apps (https://developers.google.com/workspace/extend): For // example, the following JSON creates a 2 column grid with a single item: ``` // "grid": { "title": "A fine collection of items", "columnCount": 2, // "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { @@ -2593,7 +2593,7 @@ func (s GoogleAppsCardV1Grid) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1GridItem: Represents an item in a grid layout. Items can -// contain text, an image, or both text and an image. Google Workspace Add-ons +// contain text, an image, or both text and an image. Google Workspace add-ons // and Chat apps (https://developers.google.com/workspace/extend): type GoogleAppsCardV1GridItem struct { // Id: A user-specified identifier for this grid item. This identifier is @@ -2639,7 +2639,7 @@ func (s GoogleAppsCardV1GridItem) MarshalJSON() ([]byte, error) { // (https://developers.google.com/workspace/chat/format-messages#builtinicons) // and custom // (https://developers.google.com/workspace/chat/format-messages#customicons) -// icons. Google Workspace Add-ons and Chat apps +// icons. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1Icon struct { // AltText: Optional. A description of the icon used for accessibility. If @@ -2698,7 +2698,7 @@ func (s GoogleAppsCardV1Icon) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1Image: An image that is specified by a URL and can have an // `onClick` action. For an example, see Add an image // (https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). -// Google Workspace Add-ons and Chat apps +// Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1Image struct { // AltText: The alternative text of this image that's used for accessibility. @@ -2728,7 +2728,7 @@ func (s GoogleAppsCardV1Image) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1ImageComponent: Represents an image. Google Workspace -// Add-ons and Chat apps (https://developers.google.com/workspace/extend): +// add-ons and Chat apps (https://developers.google.com/workspace/extend): type GoogleAppsCardV1ImageComponent struct { // AltText: The accessibility label for the image. AltText string `json:"altText,omitempty"` @@ -2757,7 +2757,7 @@ func (s GoogleAppsCardV1ImageComponent) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1ImageCropStyle: Represents the crop style applied to an -// image. Google Workspace Add-ons and Chat apps +// image. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): For example, here's how to // apply a 16:9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", // "aspectRatio": 16/9 } ``` @@ -2888,19 +2888,19 @@ func (s GoogleAppsCardV1NestedWidget) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1OnClick: Represents how to respond when users click an -// interactive element on a card, such as a button. Google Workspace Add-ons +// interactive element on a card, such as a button. Google Workspace add-ons // and Chat apps (https://developers.google.com/workspace/extend): type GoogleAppsCardV1OnClick struct { // Action: If specified, an action is triggered by this `onClick`. Action *GoogleAppsCardV1Action `json:"action,omitempty"` // Card: A new card is pushed to the card stack after clicking if specified. - // Google Workspace Add-ons (https://developers.google.com/workspace/add-ons): + // Google Workspace add-ons (https://developers.google.com/workspace/add-ons): Card *GoogleAppsCardV1Card `json:"card,omitempty"` // OpenDynamicLinkAction: An add-on triggers this action when the action needs // to open a link. This differs from the `open_link` above in that this needs // to talk to server to get the link. Thus some preparation work is required // for web client to do before the open link action response comes back. Google - // Workspace Add-ons (https://developers.google.com/workspace/add-ons): + // Workspace add-ons (https://developers.google.com/workspace/add-ons): OpenDynamicLinkAction *GoogleAppsCardV1Action `json:"openDynamicLinkAction,omitempty"` // OpenLink: If specified, this `onClick` triggers an open link action. OpenLink *GoogleAppsCardV1OpenLink `json:"openLink,omitempty"` @@ -2925,11 +2925,11 @@ func (s GoogleAppsCardV1OnClick) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1OpenLink: Represents an `onClick` event that opens a -// hyperlink. Google Workspace Add-ons and Chat apps +// hyperlink. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1OpenLink struct { // OnClose: Whether the client forgets about a link after opening it, or - // observes it until the window closes. Google Workspace Add-ons + // observes it until the window closes. Google Workspace add-ons // (https://developers.google.com/workspace/add-ons): // // Possible values: @@ -2940,7 +2940,7 @@ type GoogleAppsCardV1OpenLink struct { // rpc/google.apps.card.v1#openas), the child window acts as a modal dialog and // the parent card is blocked until the child window closes. OnClose string `json:"onClose,omitempty"` - // OpenAs: How to open a link. Google Workspace Add-ons + // OpenAs: How to open a link. Google Workspace add-ons // (https://developers.google.com/workspace/add-ons): // // Possible values: @@ -2973,7 +2973,7 @@ func (s GoogleAppsCardV1OpenLink) MarshalJSON() ([]byte, error) { // actions in a card. You can use this widget when actions don't fit in the // available space. To use, specify this widget in the `OnClick` action of // widgets that support it. For example, in a `Button`. Google Workspace -// Add-ons and Chat apps (https://developers.google.com/workspace/extend): +// add-ons and Chat apps (https://developers.google.com/workspace/extend): type GoogleAppsCardV1OverflowMenu struct { // Items: Required. The list of menu options. Items []*GoogleAppsCardV1OverflowMenuItem `json:"items,omitempty"` @@ -2996,7 +2996,7 @@ func (s GoogleAppsCardV1OverflowMenu) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1OverflowMenuItem: An option that users can invoke in an -// overflow menu. Google Workspace Add-ons and Chat apps +// overflow menu. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1OverflowMenuItem struct { // Disabled: Whether the menu option is disabled. Defaults to false. @@ -3066,7 +3066,7 @@ func (s GoogleAppsCardV1PlatformDataSource) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1Section: A section contains a collection of widgets that are // rendered vertically in the order that they're specified. Google Workspace -// Add-ons and Chat apps (https://developers.google.com/workspace/extend): +// add-ons and Chat apps (https://developers.google.com/workspace/extend): type GoogleAppsCardV1Section struct { // CollapseControl: Optional. Define the expand and collapse button of the // section. This button will be shown only if the section is collapsible. If @@ -3082,7 +3082,7 @@ type GoogleAppsCardV1Section struct { // formatted text. For more information about formatting text, see Formatting // text in Google Chat apps // (https://developers.google.com/workspace/chat/format-messages#card-formatting) - // and Formatting text in Google Workspace Add-ons + // and Formatting text in Google Workspace add-ons // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). Header string `json:"header,omitempty"` // UncollapsibleWidgetsCount: The number of uncollapsible widgets which remain @@ -3125,7 +3125,7 @@ func (s GoogleAppsCardV1Section) MarshalJSON() ([]byte, error) { // details about working with form inputs, see Receive form data // (https://developers.google.com/workspace/chat/read-form-data). To collect // undefined or abstract data from users, use the TextInput widget. Google -// Workspace Add-ons and Chat apps +// Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1SelectionInput struct { // ExternalDataSource: An external data source, such as a relational database. @@ -3174,7 +3174,7 @@ type GoogleAppsCardV1SelectionInput struct { // "SWITCH" - A set of switches. Users can turn on one or more switches. // "DROPDOWN" - A dropdown menu. Users can select one item from the menu. // "MULTI_SELECT" - A menu with a text box. Users can type and select one or - // more items. For Google Workspace Add-ons, you must populate items using a + // more items. For Google Workspace add-ons, you must populate items using a // static array of `SelectionItem` objects. For Google Chat apps, you can also // populate items using a dynamic data source and autosuggest items as users // type in the menu. For example, users can start typing the name of a Google @@ -3186,7 +3186,7 @@ type GoogleAppsCardV1SelectionInput struct { // Workspace. For examples of how to implement multiselect menus for Chat apps, // see [Add a multiselect // menu](https://developers.google.com/workspace/chat/design-interactive-card-di - // alog#multiselect-menu). [Google Workspace Add-ons and Chat + // alog#multiselect-menu). [Google Workspace add-ons and Chat // apps](https://developers.google.com/workspace/extend): Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "ExternalDataSource") to @@ -3209,7 +3209,7 @@ func (s GoogleAppsCardV1SelectionInput) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1SelectionItem: An item that users can select in a selection // input, such as a checkbox or switch. Supports up to 100 items. Google -// Workspace Add-ons and Chat apps +// Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1SelectionItem struct { // BottomText: For multiselect menus, a text description or label that's @@ -3250,7 +3250,7 @@ func (s GoogleAppsCardV1SelectionItem) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1SuggestionItem: One suggested value that users can enter in -// a text input field. Google Workspace Add-ons and Chat apps +// a text input field. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1SuggestionItem struct { // Text: The value of a suggested input to a text input field. This is @@ -3284,7 +3284,7 @@ func (s GoogleAppsCardV1SuggestionItem) MarshalJSON() ([]byte, error) { // to JavaScript, some users might enter `javascript` and others `java script`. // Suggesting `JavaScript` can standardize how users interact with your app. // When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set -// to `MULTIPLE_LINE`. Google Workspace Add-ons and Chat apps +// to `MULTIPLE_LINE`. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1Suggestions struct { // Items: A list of suggestions used for autocomplete recommendations in text @@ -3309,12 +3309,12 @@ func (s GoogleAppsCardV1Suggestions) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1SwitchControl: Either a toggle-style switch or a checkbox -// inside a `decoratedText` widget. Google Workspace Add-ons and Chat apps +// inside a `decoratedText` widget. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): Only supported in the // `decoratedText` widget. type GoogleAppsCardV1SwitchControl struct { // ControlType: How the switch appears in the user interface. Google Workspace - // Add-ons and Chat apps (https://developers.google.com/workspace/extend): + // add-ons and Chat apps (https://developers.google.com/workspace/extend): // // Possible values: // "SWITCH" - A toggle-style switch. @@ -3364,14 +3364,14 @@ func (s GoogleAppsCardV1SwitchControl) MarshalJSON() ([]byte, error) { // data (https://developers.google.com/workspace/chat/read-form-data). When you // need to collect undefined or abstract data from users, use a text input. To // collect defined or enumerated data from users, use the SelectionInput -// widget. Google Workspace Add-ons and Chat apps +// widget. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1TextInput struct { // AutoCompleteAction: Optional. Specify what action to take when the text // input field provides suggestions to users who interact with it. If // unspecified, the suggestions are set by `initialSuggestions` and are // processed by the client. If specified, the app takes the action specified - // here, such as running a custom function. Google Workspace Add-ons + // here, such as running a custom function. Google Workspace add-ons // (https://developers.google.com/workspace/add-ons): AutoCompleteAction *GoogleAppsCardV1Action `json:"autoCompleteAction,omitempty"` // HintText: Text that appears below the text input field meant to assist users @@ -3388,7 +3388,7 @@ type GoogleAppsCardV1TextInput struct { // referring to JavaScript, some users might enter `javascript` and others // `java script`. Suggesting `JavaScript` can standardize how users interact // with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, - // even if it's set to `MULTIPLE_LINE`. Google Workspace Add-ons and Chat apps + // even if it's set to `MULTIPLE_LINE`. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): InitialSuggestions *GoogleAppsCardV1Suggestions `json:"initialSuggestions,omitempty"` // Label: The text that appears above the text input field in the user @@ -3420,7 +3420,7 @@ type GoogleAppsCardV1TextInput struct { // lines. Type string `json:"type,omitempty"` // Validation: Specify the input format validation necessary for this text - // field. Google Workspace Add-ons and Chat apps + // field. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): Validation *GoogleAppsCardV1Validation `json:"validation,omitempty"` // Value: The value entered by a user, returned as part of a form input event. @@ -3451,9 +3451,9 @@ func (s GoogleAppsCardV1TextInput) MarshalJSON() ([]byte, error) { // For more information about formatting text, see Formatting text in Google // Chat apps // (https://developers.google.com/workspace/chat/format-messages#card-formatting) -// and Formatting text in Google Workspace Add-ons +// and Formatting text in Google Workspace add-ons // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). -// Google Workspace Add-ons and Chat apps +// Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1TextParagraph struct { // MaxLines: The maximum number of lines of text that are displayed in the @@ -3484,15 +3484,15 @@ func (s GoogleAppsCardV1TextParagraph) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1Validation: Represents the necessary data for validating the -// widget it's attached to. Google Workspace Add-ons and Chat apps +// widget it's attached to. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): type GoogleAppsCardV1Validation struct { // CharacterLimit: Specify the character limit for text input widgets. Note // that this is only used for text input and is ignored for other widgets. - // Google Workspace Add-ons and Chat apps + // Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): CharacterLimit int64 `json:"characterLimit,omitempty"` - // InputType: Specify the type of the input widgets. Google Workspace Add-ons + // InputType: Specify the type of the input widgets. Google Workspace add-ons // and Chat apps (https://developers.google.com/workspace/extend): // // Possible values: @@ -3574,7 +3574,7 @@ type GoogleAppsCardV1Widget struct { // of columns and items. The number of rows is determined by the upper bounds // of the number items divided by the number of columns. A grid with 10 items // and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. - // Google Workspace Add-ons and Chat apps + // Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend): For example, the following // JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A // fine collection of items", "columnCount": 2, "borderStyle": { "type": @@ -3624,7 +3624,7 @@ type GoogleAppsCardV1Widget struct { // text. For more information about formatting text, see Formatting text in // Google Chat apps // (https://developers.google.com/workspace/chat/format-messages#card-formatting) - // and Formatting text in Google Workspace Add-ons + // and Formatting text in Google Workspace add-ons // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). // For example, the following JSON creates a bolded text: ``` "textParagraph": // { "text": " *bold text*" } ``` @@ -3648,7 +3648,7 @@ func (s GoogleAppsCardV1Widget) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1Widgets: The supported widgets that you can include in a -// column. Google Workspace Add-ons and Chat apps +// column. Google Workspace add-ons and Chat apps // (https://developers.google.com/workspace/extend) type GoogleAppsCardV1Widgets struct { // ButtonList: ButtonList widget. diff --git a/dataportability/v1/dataportability-api.json b/dataportability/v1/dataportability-api.json index 142839b16c9..31398c94cbd 100644 --- a/dataportability/v1/dataportability-api.json +++ b/dataportability/v1/dataportability-api.json @@ -125,6 +125,9 @@ "https://www.googleapis.com/auth/dataportability.saved.collections": { "description": "Move a copy of your saved links, images, places, and collections from your use of Google services" }, + "https://www.googleapis.com/auth/dataportability.search_ugc.comments": { + "description": "Move a copy of your comments on Google Search" + }, "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars": { "description": "Move a copy of your media reviews on Google Search" }, @@ -362,6 +365,7 @@ "https://www.googleapis.com/auth/dataportability.play.subscriptions", "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", @@ -454,6 +458,7 @@ "https://www.googleapis.com/auth/dataportability.play.subscriptions", "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", @@ -540,6 +545,7 @@ "https://www.googleapis.com/auth/dataportability.play.subscriptions", "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", @@ -626,6 +632,7 @@ "https://www.googleapis.com/auth/dataportability.play.subscriptions", "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", @@ -655,7 +662,7 @@ } } }, - "revision": "20250114", + "revision": "20250120", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/dataportability/v1/dataportability-gen.go b/dataportability/v1/dataportability-gen.go index 1909fe44abe..7bc590b8c39 100644 --- a/dataportability/v1/dataportability-gen.go +++ b/dataportability/v1/dataportability-gen.go @@ -231,6 +231,9 @@ const ( // use of Google services DataportabilitySavedCollectionsScope = "https://www.googleapis.com/auth/dataportability.saved.collections" + // Move a copy of your comments on Google Search + DataportabilitySearchUgcCommentsScope = "https://www.googleapis.com/auth/dataportability.search_ugc.comments" + // Move a copy of your media reviews on Google Search DataportabilitySearchUgcMediaReviewsAndStarsScope = "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars" @@ -353,6 +356,7 @@ func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, err "https://www.googleapis.com/auth/dataportability.play.subscriptions", "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", diff --git a/dataportability/v1beta/dataportability-api.json b/dataportability/v1beta/dataportability-api.json index 653d07f0eb6..31ef1fdce95 100644 --- a/dataportability/v1beta/dataportability-api.json +++ b/dataportability/v1beta/dataportability-api.json @@ -125,6 +125,9 @@ "https://www.googleapis.com/auth/dataportability.saved.collections": { "description": "Move a copy of your saved links, images, places, and collections from your use of Google services" }, + "https://www.googleapis.com/auth/dataportability.search_ugc.comments": { + "description": "Move a copy of your comments on Google Search" + }, "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars": { "description": "Move a copy of your media reviews on Google Search" }, @@ -362,6 +365,7 @@ "https://www.googleapis.com/auth/dataportability.play.subscriptions", "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", @@ -454,6 +458,7 @@ "https://www.googleapis.com/auth/dataportability.play.subscriptions", "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", @@ -540,6 +545,7 @@ "https://www.googleapis.com/auth/dataportability.play.subscriptions", "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", @@ -626,6 +632,7 @@ "https://www.googleapis.com/auth/dataportability.play.subscriptions", "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", @@ -655,7 +662,7 @@ } } }, - "revision": "20250114", + "revision": "20250120", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/dataportability/v1beta/dataportability-gen.go b/dataportability/v1beta/dataportability-gen.go index 35a473ea2bb..d9077e954ba 100644 --- a/dataportability/v1beta/dataportability-gen.go +++ b/dataportability/v1beta/dataportability-gen.go @@ -231,6 +231,9 @@ const ( // use of Google services DataportabilitySavedCollectionsScope = "https://www.googleapis.com/auth/dataportability.saved.collections" + // Move a copy of your comments on Google Search + DataportabilitySearchUgcCommentsScope = "https://www.googleapis.com/auth/dataportability.search_ugc.comments" + // Move a copy of your media reviews on Google Search DataportabilitySearchUgcMediaReviewsAndStarsScope = "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars" @@ -353,6 +356,7 @@ func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, err "https://www.googleapis.com/auth/dataportability.play.subscriptions", "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", diff --git a/discoveryengine/v1/discoveryengine-api.json b/discoveryengine/v1/discoveryengine-api.json index 62123a3e3ed..d056539838a 100644 --- a/discoveryengine/v1/discoveryengine-api.json +++ b/discoveryengine/v1/discoveryengine-api.json @@ -6371,7 +6371,7 @@ } } }, - "revision": "20250114", + "revision": "20250121", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -7000,6 +7000,10 @@ "description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", "type": "boolean" }, + "endUserSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec", + "description": "Optional. End user specification." + }, "groundingSpec": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec", "description": "Optional. Grounding specification." @@ -7103,6 +7107,57 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec": { + "description": "End user specification.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec", + "properties": { + "endUserMetadata": { + "description": "Optional. End user metadata.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData": { + "description": "End user metadata.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData", + "properties": { + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", + "description": "Chunk information." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", + "properties": { + "content": { + "description": "Chunk textual content. It is limited to 8000 characters.", + "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", + "description": "Metadata of the document from the current chunk." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", + "properties": { + "title": { + "description": "Title of the document.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec": { "description": "Grounding specification.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec", @@ -13439,7 +13494,8 @@ "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", - "GOOGLE_KEEP" + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -13449,7 +13505,8 @@ "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data" + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" ], "type": "string" } @@ -14772,7 +14829,7 @@ }, "nextSyncTime": { "$ref": "GoogleTypeDateTime", - "description": "The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day." + "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." }, "params": { "additionalProperties": { @@ -18333,7 +18390,8 @@ "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", - "GOOGLE_KEEP" + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -18343,7 +18401,8 @@ "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data" + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" ], "type": "string" } @@ -21102,7 +21161,8 @@ "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", - "GOOGLE_KEEP" + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -21112,7 +21172,8 @@ "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data" + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" ], "type": "string" } diff --git a/discoveryengine/v1/discoveryengine-gen.go b/discoveryengine/v1/discoveryengine-gen.go index 830d277e576..4846b7be9bb 100644 --- a/discoveryengine/v1/discoveryengine-gen.go +++ b/discoveryengine/v1/discoveryengine-gen.go @@ -1834,6 +1834,8 @@ type GoogleCloudDiscoveryengineV1AnswerQueryRequest struct { // calling ConversationalSearchService.GetAnswer or // ConversationalSearchService.GetSession method. AsynchronousMode bool `json:"asynchronousMode,omitempty"` + // EndUserSpec: Optional. End user specification. + EndUserSpec *GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec `json:"endUserSpec,omitempty"` // GroundingSpec: Optional. Grounding specification. GroundingSpec *GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec `json:"groundingSpec,omitempty"` // Query: Required. Current user query. @@ -2001,6 +2003,101 @@ func (s GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPrompt return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec: End user +// specification. +type GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec struct { + // EndUserMetadata: Optional. End user metadata. + EndUserMetadata []*GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData `json:"endUserMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "EndUserMetadata") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "EndUserMetadata") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData: +// End user metadata. +type GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData struct { + // ChunkInfo: Chunk information. + ChunkInfo *GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo `json:"chunkInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkInfo") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkInfo") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunk +// Info: Chunk information. +type GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo struct { + // Content: Chunk textual content. It is limited to 8000 characters. + Content string `json:"content,omitempty"` + // DocumentMetadata: Metadata of the document from the current chunk. + DocumentMetadata *GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata `json:"documentMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "Content") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Content") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunk +// InfoDocumentMetadata: Document metadata contains the information of the +// document of the current chunk. +type GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata struct { + // Title: Title of the document. + Title string `json:"title,omitempty"` + // ForceSendFields is a list of field names (e.g. "Title") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Title") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec: Grounding // specification. type GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec struct { @@ -11093,6 +11190,7 @@ type GoogleCloudDiscoveryengineV1WorkspaceConfig struct { // "GOOGLE_CHAT" - Workspace Data Store contains Chat data // "GOOGLE_GROUPS" - Workspace Data Store contains Groups data // "GOOGLE_KEEP" - Workspace Data Store contains Keep data + // "GOOGLE_PEOPLE" - Workspace Data Store contains People data Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DasherCustomerId") to // unconditionally include in API requests. By default, fields with empty or @@ -12709,10 +12807,12 @@ type GoogleCloudDiscoveryengineV1alphaDataConnector struct { // Name: Output only. The full resource name of the Data Connector. Format: // `projects/*/locations/*/collections/*/dataConnector`. Name string `json:"name,omitempty"` - // NextSyncTime: The UTC time when the next data sync is expected to start for - // the Data Connector. Customers are only able to specify the hour and minute - // to schedule the data sync. This is utilized when the data connector has a - // refresh interval greater than 1 day. + // NextSyncTime: Defines the scheduled time for the next data synchronization. + // This field requires hour , minute, and time_zone from the IANA Time Zone + // Database (https://www.iana.org/time-zones). This is utilized when the data + // connector has a refresh interval greater than 1 day. When the hours or + // minutes are not specified, we will assume a sync time of 0:00. The user must + // provide a time zone to avoid ambiguity. NextSyncTime *GoogleTypeDateTime `json:"nextSyncTime,omitempty"` // Params: Required. Params needed to access the source in the format of (Key, // Value) pairs. Required parameters for all data sources: * Key: @@ -17655,6 +17755,7 @@ type GoogleCloudDiscoveryengineV1alphaWorkspaceConfig struct { // "GOOGLE_CHAT" - Workspace Data Store contains Chat data // "GOOGLE_GROUPS" - Workspace Data Store contains Groups data // "GOOGLE_KEEP" - Workspace Data Store contains Keep data + // "GOOGLE_PEOPLE" - Workspace Data Store contains People data Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DasherCustomerId") to // unconditionally include in API requests. By default, fields with empty or @@ -21609,6 +21710,7 @@ type GoogleCloudDiscoveryengineV1betaWorkspaceConfig struct { // "GOOGLE_CHAT" - Workspace Data Store contains Chat data // "GOOGLE_GROUPS" - Workspace Data Store contains Groups data // "GOOGLE_KEEP" - Workspace Data Store contains Keep data + // "GOOGLE_PEOPLE" - Workspace Data Store contains People data Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DasherCustomerId") to // unconditionally include in API requests. By default, fields with empty or diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index e845fd2a7ed..3fba8bfb368 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -8552,7 +8552,7 @@ } } }, - "revision": "20250114", + "revision": "20250121", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -10979,7 +10979,8 @@ "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", - "GOOGLE_KEEP" + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -10989,7 +10990,8 @@ "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data" + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" ], "type": "string" } @@ -11051,6 +11053,13 @@ "description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration \u003e Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "type": "string" }, + "suggestionTypeSpecs": { + "description": "Optional. Specification of each suggestion type.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec" + }, + "type": "array" + }, "suggestionTypes": { "description": "Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.", "items": { @@ -11115,6 +11124,38 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec": { + "description": "Specification of each suggestion type.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec", + "properties": { + "maxSuggestions": { + "description": "Optional. Maximum number of suggestions to return for each suggestion type.", + "format": "int32", + "type": "integer" + }, + "suggestionType": { + "description": "Optional. Suggestion type.", + "enum": [ + "SUGGESTION_TYPE_UNSPECIFIED", + "QUERY", + "PEOPLE", + "CONTENT", + "RECENT_SEARCH", + "GOOGLE_WORKSPACE" + ], + "enumDescriptions": [ + "Default value.", + "Returns query suggestions.", + "Returns people suggestions.", + "Returns content suggestions.", + "Returns recent search suggestions.", + "Returns Google Workspace suggestions." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse": { "description": "Response message for CompletionService.AdvancedCompleteQuery method.", "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse", @@ -11515,6 +11556,10 @@ "description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", "type": "boolean" }, + "endUserSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec", + "description": "Optional. End user specification." + }, "groundingSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec", "description": "Optional. Grounding specification." @@ -11618,6 +11663,57 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec": { + "description": "End user specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec", + "properties": { + "endUserMetadata": { + "description": "Optional. End user metadata.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData": { + "description": "End user metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData", + "properties": { + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", + "description": "Chunk information." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", + "properties": { + "content": { + "description": "Chunk textual content. It is limited to 8000 characters.", + "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", + "description": "Metadata of the document from the current chunk." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", + "properties": { + "title": { + "description": "Title of the document.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec": { "description": "Grounding specification.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec", @@ -14066,7 +14162,7 @@ }, "nextSyncTime": { "$ref": "GoogleTypeDateTime", - "description": "The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day." + "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." }, "params": { "additionalProperties": { @@ -21006,7 +21102,8 @@ "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", - "GOOGLE_KEEP" + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -21016,7 +21113,8 @@ "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data" + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" ], "type": "string" } @@ -23775,7 +23873,8 @@ "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", - "GOOGLE_KEEP" + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -23785,7 +23884,8 @@ "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data" + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" ], "type": "string" } diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index e64dcbe6010..0787bb331ee 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -4526,6 +4526,7 @@ type GoogleCloudDiscoveryengineV1WorkspaceConfig struct { // "GOOGLE_CHAT" - Workspace Data Store contains Chat data // "GOOGLE_GROUPS" - Workspace Data Store contains Groups data // "GOOGLE_KEEP" - Workspace Data Store contains Keep data + // "GOOGLE_PEOPLE" - Workspace Data Store contains People data Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DasherCustomerId") to // unconditionally include in API requests. By default, fields with empty or @@ -4637,6 +4638,8 @@ type GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest struct { // dataStores. * `search-history` is the default model for site search // dataStores. QueryModel string `json:"queryModel,omitempty"` + // SuggestionTypeSpecs: Optional. Specification of each suggestion type. + SuggestionTypeSpecs []*GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec `json:"suggestionTypeSpecs,omitempty"` // SuggestionTypes: Optional. Suggestion types to return. If empty or // unspecified, query suggestions are returned. Only one suggestion type is // supported at the moment. @@ -4754,6 +4757,40 @@ func (s *GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecC return nil } +// GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSp +// ec: Specification of each suggestion type. +type GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec struct { + // MaxSuggestions: Optional. Maximum number of suggestions to return for each + // suggestion type. + MaxSuggestions int64 `json:"maxSuggestions,omitempty"` + // SuggestionType: Optional. Suggestion type. + // + // Possible values: + // "SUGGESTION_TYPE_UNSPECIFIED" - Default value. + // "QUERY" - Returns query suggestions. + // "PEOPLE" - Returns people suggestions. + // "CONTENT" - Returns content suggestions. + // "RECENT_SEARCH" - Returns recent search suggestions. + // "GOOGLE_WORKSPACE" - Returns Google Workspace suggestions. + SuggestionType string `json:"suggestionType,omitempty"` + // ForceSendFields is a list of field names (e.g. "MaxSuggestions") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "MaxSuggestions") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse: Response // message for CompletionService.AdvancedCompleteQuery method. type GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse struct { @@ -5204,6 +5241,8 @@ type GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest struct { // calling ConversationalSearchService.GetAnswer or // ConversationalSearchService.GetSession method. AsynchronousMode bool `json:"asynchronousMode,omitempty"` + // EndUserSpec: Optional. End user specification. + EndUserSpec *GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec `json:"endUserSpec,omitempty"` // GroundingSpec: Optional. Grounding specification. GroundingSpec *GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec `json:"groundingSpec,omitempty"` // Query: Required. Current user query. @@ -5370,6 +5409,101 @@ func (s GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecP return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec: End user +// specification. +type GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec struct { + // EndUserMetadata: Optional. End user metadata. + EndUserMetadata []*GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData `json:"endUserMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "EndUserMetadata") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "EndUserMetadata") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData +// : End user metadata. +type GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData struct { + // ChunkInfo: Chunk information. + ChunkInfo *GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo `json:"chunkInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkInfo") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkInfo") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData +// ChunkInfo: Chunk information. +type GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo struct { + // Content: Chunk textual content. It is limited to 8000 characters. + Content string `json:"content,omitempty"` + // DocumentMetadata: Metadata of the document from the current chunk. + DocumentMetadata *GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata `json:"documentMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "Content") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Content") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData +// ChunkInfoDocumentMetadata: Document metadata contains the information of the +// document of the current chunk. +type GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata struct { + // Title: Title of the document. + Title string `json:"title,omitempty"` + // ForceSendFields is a list of field names (e.g. "Title") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Title") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec: Grounding // specification. type GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec struct { @@ -8592,10 +8726,12 @@ type GoogleCloudDiscoveryengineV1alphaDataConnector struct { // Name: Output only. The full resource name of the Data Connector. Format: // `projects/*/locations/*/collections/*/dataConnector`. Name string `json:"name,omitempty"` - // NextSyncTime: The UTC time when the next data sync is expected to start for - // the Data Connector. Customers are only able to specify the hour and minute - // to schedule the data sync. This is utilized when the data connector has a - // refresh interval greater than 1 day. + // NextSyncTime: Defines the scheduled time for the next data synchronization. + // This field requires hour , minute, and time_zone from the IANA Time Zone + // Database (https://www.iana.org/time-zones). This is utilized when the data + // connector has a refresh interval greater than 1 day. When the hours or + // minutes are not specified, we will assume a sync time of 0:00. The user must + // provide a time zone to avoid ambiguity. NextSyncTime *GoogleTypeDateTime `json:"nextSyncTime,omitempty"` // Params: Required. Params needed to access the source in the format of (Key, // Value) pairs. Required parameters for all data sources: * Key: @@ -18666,6 +18802,7 @@ type GoogleCloudDiscoveryengineV1alphaWorkspaceConfig struct { // "GOOGLE_CHAT" - Workspace Data Store contains Chat data // "GOOGLE_GROUPS" - Workspace Data Store contains Groups data // "GOOGLE_KEEP" - Workspace Data Store contains Keep data + // "GOOGLE_PEOPLE" - Workspace Data Store contains People data Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DasherCustomerId") to // unconditionally include in API requests. By default, fields with empty or @@ -22620,6 +22757,7 @@ type GoogleCloudDiscoveryengineV1betaWorkspaceConfig struct { // "GOOGLE_CHAT" - Workspace Data Store contains Chat data // "GOOGLE_GROUPS" - Workspace Data Store contains Groups data // "GOOGLE_KEEP" - Workspace Data Store contains Keep data + // "GOOGLE_PEOPLE" - Workspace Data Store contains People data Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DasherCustomerId") to // unconditionally include in API requests. By default, fields with empty or diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index 3589964df6a..e246cfd4915 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -7384,7 +7384,7 @@ } } }, - "revision": "20250114", + "revision": "20250121", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -9811,7 +9811,8 @@ "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", - "GOOGLE_KEEP" + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -9821,7 +9822,8 @@ "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data" + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" ], "type": "string" } @@ -11144,7 +11146,7 @@ }, "nextSyncTime": { "$ref": "GoogleTypeDateTime", - "description": "The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day." + "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." }, "params": { "additionalProperties": { @@ -14705,7 +14707,8 @@ "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", - "GOOGLE_KEEP" + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -14715,7 +14718,8 @@ "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data" + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" ], "type": "string" } @@ -14742,6 +14746,13 @@ "description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration \u003e Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "type": "string" }, + "suggestionTypeSpecs": { + "description": "Optional. Specification of each suggestion type.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec" + }, + "type": "array" + }, "suggestionTypes": { "description": "Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.", "items": { @@ -14806,6 +14817,38 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec": { + "description": "Specification of each suggestion type.", + "id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec", + "properties": { + "maxSuggestions": { + "description": "Optional. Maximum number of suggestions to return for each suggestion type.", + "format": "int32", + "type": "integer" + }, + "suggestionType": { + "description": "Optional. Suggestion type.", + "enum": [ + "SUGGESTION_TYPE_UNSPECIFIED", + "QUERY", + "PEOPLE", + "CONTENT", + "RECENT_SEARCH", + "GOOGLE_WORKSPACE" + ], + "enumDescriptions": [ + "Default value.", + "Returns query suggestions.", + "Returns people suggestions.", + "Returns content suggestions.", + "Returns recent search suggestions.", + "Returns Google Workspace suggestions." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse": { "description": "Response message for CompletionService.AdvancedCompleteQuery method.", "id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse", @@ -15206,6 +15249,10 @@ "description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", "type": "boolean" }, + "endUserSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec", + "description": "Optional. End user specification." + }, "groundingSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec", "description": "Optional. Grounding specification." @@ -15309,6 +15356,57 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec": { + "description": "End user specification.", + "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec", + "properties": { + "endUserMetadata": { + "description": "Optional. End user metadata.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData": { + "description": "End user metadata.", + "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData", + "properties": { + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", + "description": "Chunk information." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", + "properties": { + "content": { + "description": "Chunk textual content. It is limited to 8000 characters.", + "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", + "description": "Metadata of the document from the current chunk." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", + "properties": { + "title": { + "description": "Title of the document.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec": { "description": "Grounding specification.", "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec", @@ -22718,7 +22816,8 @@ "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", - "GOOGLE_KEEP" + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -22728,7 +22827,8 @@ "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data" + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" ], "type": "string" } diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index c31e68a0710..911fe92395c 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -4442,6 +4442,7 @@ type GoogleCloudDiscoveryengineV1WorkspaceConfig struct { // "GOOGLE_CHAT" - Workspace Data Store contains Chat data // "GOOGLE_GROUPS" - Workspace Data Store contains Groups data // "GOOGLE_KEEP" - Workspace Data Store contains Keep data + // "GOOGLE_PEOPLE" - Workspace Data Store contains People data Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DasherCustomerId") to // unconditionally include in API requests. By default, fields with empty or @@ -6058,10 +6059,12 @@ type GoogleCloudDiscoveryengineV1alphaDataConnector struct { // Name: Output only. The full resource name of the Data Connector. Format: // `projects/*/locations/*/collections/*/dataConnector`. Name string `json:"name,omitempty"` - // NextSyncTime: The UTC time when the next data sync is expected to start for - // the Data Connector. Customers are only able to specify the hour and minute - // to schedule the data sync. This is utilized when the data connector has a - // refresh interval greater than 1 day. + // NextSyncTime: Defines the scheduled time for the next data synchronization. + // This field requires hour , minute, and time_zone from the IANA Time Zone + // Database (https://www.iana.org/time-zones). This is utilized when the data + // connector has a refresh interval greater than 1 day. When the hours or + // minutes are not specified, we will assume a sync time of 0:00. The user must + // provide a time zone to avoid ambiguity. NextSyncTime *GoogleTypeDateTime `json:"nextSyncTime,omitempty"` // Params: Required. Params needed to access the source in the format of (Key, // Value) pairs. Required parameters for all data sources: * Key: @@ -11004,6 +11007,7 @@ type GoogleCloudDiscoveryengineV1alphaWorkspaceConfig struct { // "GOOGLE_CHAT" - Workspace Data Store contains Chat data // "GOOGLE_GROUPS" - Workspace Data Store contains Groups data // "GOOGLE_KEEP" - Workspace Data Store contains Keep data + // "GOOGLE_PEOPLE" - Workspace Data Store contains People data Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DasherCustomerId") to // unconditionally include in API requests. By default, fields with empty or @@ -11054,6 +11058,8 @@ type GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest struct { // dataStores. * `search-history` is the default model for site search // dataStores. QueryModel string `json:"queryModel,omitempty"` + // SuggestionTypeSpecs: Optional. Specification of each suggestion type. + SuggestionTypeSpecs []*GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec `json:"suggestionTypeSpecs,omitempty"` // SuggestionTypes: Optional. Suggestion types to return. If empty or // unspecified, query suggestions are returned. Only one suggestion type is // supported at the moment. @@ -11171,6 +11177,40 @@ func (s *GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpecCo return nil } +// GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpe +// c: Specification of each suggestion type. +type GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec struct { + // MaxSuggestions: Optional. Maximum number of suggestions to return for each + // suggestion type. + MaxSuggestions int64 `json:"maxSuggestions,omitempty"` + // SuggestionType: Optional. Suggestion type. + // + // Possible values: + // "SUGGESTION_TYPE_UNSPECIFIED" - Default value. + // "QUERY" - Returns query suggestions. + // "PEOPLE" - Returns people suggestions. + // "CONTENT" - Returns content suggestions. + // "RECENT_SEARCH" - Returns recent search suggestions. + // "GOOGLE_WORKSPACE" - Returns Google Workspace suggestions. + SuggestionType string `json:"suggestionType,omitempty"` + // ForceSendFields is a list of field names (e.g. "MaxSuggestions") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "MaxSuggestions") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse: Response // message for CompletionService.AdvancedCompleteQuery method. type GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse struct { @@ -11621,6 +11661,8 @@ type GoogleCloudDiscoveryengineV1betaAnswerQueryRequest struct { // calling ConversationalSearchService.GetAnswer or // ConversationalSearchService.GetSession method. AsynchronousMode bool `json:"asynchronousMode,omitempty"` + // EndUserSpec: Optional. End user specification. + EndUserSpec *GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec `json:"endUserSpec,omitempty"` // GroundingSpec: Optional. Grounding specification. GroundingSpec *GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec `json:"groundingSpec,omitempty"` // Query: Required. Current user query. @@ -11787,6 +11829,102 @@ func (s GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPr return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec: End user +// specification. +type GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec struct { + // EndUserMetadata: Optional. End user metadata. + EndUserMetadata []*GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData `json:"endUserMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "EndUserMetadata") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "EndUserMetadata") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData: +// +// End user metadata. +type GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData struct { + // ChunkInfo: Chunk information. + ChunkInfo *GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo `json:"chunkInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkInfo") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkInfo") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataC +// hunkInfo: Chunk information. +type GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo struct { + // Content: Chunk textual content. It is limited to 8000 characters. + Content string `json:"content,omitempty"` + // DocumentMetadata: Metadata of the document from the current chunk. + DocumentMetadata *GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata `json:"documentMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "Content") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Content") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataC +// hunkInfoDocumentMetadata: Document metadata contains the information of the +// document of the current chunk. +type GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata struct { + // Title: Title of the document. + Title string `json:"title,omitempty"` + // ForceSendFields is a list of field names (e.g. "Title") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Title") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec: Grounding // specification. type GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec struct { @@ -22437,6 +22575,7 @@ type GoogleCloudDiscoveryengineV1betaWorkspaceConfig struct { // "GOOGLE_CHAT" - Workspace Data Store contains Chat data // "GOOGLE_GROUPS" - Workspace Data Store contains Groups data // "GOOGLE_KEEP" - Workspace Data Store contains Keep data + // "GOOGLE_PEOPLE" - Workspace Data Store contains People data Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DasherCustomerId") to // unconditionally include in API requests. By default, fields with empty or diff --git a/firebaseml/v2beta/firebaseml-api.json b/firebaseml/v2beta/firebaseml-api.json index 5a64aacc587..134994fc547 100644 --- a/firebaseml/v2beta/firebaseml-api.json +++ b/firebaseml/v2beta/firebaseml-api.json @@ -206,7 +206,7 @@ } } }, - "revision": "20250119", + "revision": "20250120", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -908,6 +908,10 @@ "format": "float", "type": "number" }, + "thinkingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", + "description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking." + }, "topK": { "description": "Optional. If specified, top-k sampling will be used.", "format": "float", @@ -970,6 +974,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": { + "description": "Config for thinking features.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", + "properties": { + "includeThoughts": { + "description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", diff --git a/firebaseml/v2beta/firebaseml-gen.go b/firebaseml/v2beta/firebaseml-gen.go index d0ce5887378..d4476a9b13c 100644 --- a/firebaseml/v2beta/firebaseml-gen.go +++ b/firebaseml/v2beta/firebaseml-gen.go @@ -1012,6 +1012,9 @@ type GoogleCloudAiplatformV1beta1GenerationConfig struct { StopSequences []string `json:"stopSequences,omitempty"` // Temperature: Optional. Controls the randomness of predictions. Temperature float64 `json:"temperature,omitempty"` + // ThinkingConfig: Optional. Config for thinking features. An error will be + // returned if this field is set for models that don't support thinking. + ThinkingConfig *GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig `json:"thinkingConfig,omitempty"` // TopK: Optional. If specified, top-k sampling will be used. TopK float64 `json:"topK,omitempty"` // TopP: Optional. If specified, nucleus sampling will be used. @@ -1135,6 +1138,30 @@ func (s GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMo return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig: Config for +// thinking features. +type GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig struct { + // IncludeThoughts: Optional. Indicates whether to include thoughts in the + // response. If true, thoughts are returned only when available. + IncludeThoughts bool `json:"includeThoughts,omitempty"` + // ForceSendFields is a list of field names (e.g. "IncludeThoughts") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "IncludeThoughts") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudAiplatformV1beta1GoogleSearchRetrieval: Tool to retrieve public // web data for grounding, powered by Google. type GoogleCloudAiplatformV1beta1GoogleSearchRetrieval struct { diff --git a/healthcare/v1beta1/healthcare-api.json b/healthcare/v1beta1/healthcare-api.json index be8f0e1ec53..c62cdb752a4 100644 --- a/healthcare/v1beta1/healthcare-api.json +++ b/healthcare/v1beta1/healthcare-api.json @@ -5858,7 +5858,7 @@ } } }, - "revision": "20241226", + "revision": "20250116", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6735,10 +6735,11 @@ "description": "Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header." }, "enforcedAdminConsents": { - "description": "The versioned names of the enforced admin Consent resource(s), in the format `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`. This field can only be updated using ApplyAdminConsents.", + "description": "Output only. The versioned names of the enforced admin Consent resource(s), in the format `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`. This field can only be updated using ApplyAdminConsents.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "version": { diff --git a/healthcare/v1beta1/healthcare-gen.go b/healthcare/v1beta1/healthcare-gen.go index 4283d1eca15..13ec72f6e44 100644 --- a/healthcare/v1beta1/healthcare-gen.go +++ b/healthcare/v1beta1/healthcare-gen.go @@ -1802,8 +1802,8 @@ type ConsentConfig struct { // ConsentHeaderHandling: Optional. Different options to configure the // behaviour of the server when handling the `X-Consent-Scope` header. ConsentHeaderHandling *ConsentHeaderHandling `json:"consentHeaderHandling,omitempty"` - // EnforcedAdminConsents: The versioned names of the enforced admin Consent - // resource(s), in the format + // EnforcedAdminConsents: Output only. The versioned names of the enforced + // admin Consent resource(s), in the format // `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/ // {fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. For FHIR // stores with `disable_resource_versioning=true`, the format is diff --git a/orgpolicy/v2/orgpolicy-api.json b/orgpolicy/v2/orgpolicy-api.json index 589882cb0f7..6ff13b85908 100644 --- a/orgpolicy/v2/orgpolicy-api.json +++ b/orgpolicy/v2/orgpolicy-api.json @@ -429,7 +429,7 @@ ] }, "get": { - "description": "Gets a custom constraint. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the custom constraint does not exist.", + "description": "Gets a custom or managed constraint. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the custom or managed constraint does not exist.", "flatPath": "v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}", "httpMethod": "GET", "id": "orgpolicy.organizations.customConstraints.get", @@ -438,7 +438,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the custom constraint. See the custom constraint entry for naming requirements.", + "description": "Required. Resource name of the custom or managed constraint. See the custom constraint entry for naming requirements.", "location": "path", "pattern": "^organizations/[^/]+/customConstraints/[^/]+$", "required": true, @@ -930,11 +930,11 @@ } } }, - "revision": "20241129", + "revision": "20250117", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { - "description": "Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run/darklaunch.", + "description": "Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run.", "id": "GoogleCloudOrgpolicyV2AlternatePolicySpec", "properties": { "launch": { @@ -949,12 +949,12 @@ "type": "object" }, "GoogleCloudOrgpolicyV2Constraint": { - "description": "A constraint describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which Google Cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. Constraints can be configured by the organization policy administrator to fit the needs of the organization by setting a policy that includes constraints at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about `policies`. Constraints have a default behavior determined by the `constraint_default` field, which is the enforcement behavior that is used in the absence of a policy being defined or inherited for the resource in question.", + "description": "A constraint describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which Google Cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. Constraints can be configured by the organization policy administrator to fit the needs of the organization by setting a policy that includes constraints at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules, see `Policy`. Constraints have a default behavior determined by the `constraint_default` field, which is the enforcement behavior that is used in the absence of a policy being defined or inherited for the resource in question.", "id": "GoogleCloudOrgpolicyV2Constraint", "properties": { "booleanConstraint": { "$ref": "GoogleCloudOrgpolicyV2ConstraintBooleanConstraint", - "description": "Defines this constraint as being a BooleanConstraint." + "description": "Defines this constraint as being a boolean constraint." }, "constraintDefault": { "description": "The evaluation behavior of this constraint in the absence of a policy.", @@ -964,7 +964,7 @@ "DENY" ], "enumDescriptions": [ - "This is only used for distinguishing unset values and should never be used.", + "This is only used for distinguishing unset values and should never be used. Results in an error.", "Indicate that all values are allowed for list constraints. Indicate that enforcement is off for boolean constraints.", "Indicate that all values are denied for list constraints. Indicate that enforcement is on for boolean constraints." ], @@ -980,7 +980,7 @@ }, "listConstraint": { "$ref": "GoogleCloudOrgpolicyV2ConstraintListConstraint", - "description": "Defines this constraint as being a ListConstraint." + "description": "Defines this constraint as being a list constraint." }, "name": { "description": "Immutable. The resource name of the constraint. Must be in one of the following forms: * `projects/{project_number}/constraints/{constraint_name}` * `folders/{folder_id}/constraints/{constraint_name}` * `organizations/{organization_id}/constraints/{constraint_name}` For example, \"/projects/123/constraints/compute.disableSerialPortAccess\".", @@ -998,18 +998,18 @@ "type": "object" }, "GoogleCloudOrgpolicyV2ConstraintBooleanConstraint": { - "description": "A constraint that is either enforced or not. For example, a constraint `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM instance, serial port connections will not be opened to that instance.", + "description": "A constraint type is enforced or not enforced, which is configured in the `PolicyRule`. If `customConstraintDefinition` is defined, this constraint is a managed constraint.", "id": "GoogleCloudOrgpolicyV2ConstraintBooleanConstraint", "properties": { "customConstraintDefinition": { "$ref": "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition", - "description": "Custom constraint definition. This is set only for Managed Constraints" + "description": "Custom constraint definition. Defines this as a managed constraint." } }, "type": "object" }, "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition": { - "description": "Currently used for Managed Constraints. This represents a subset of fields missing from Constraint proto that are required to describe CustomConstraint", + "description": "Custom constraint definition. Defines this as a managed constraint.", "id": "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition", "properties": { "actionType": { @@ -1020,7 +1020,7 @@ "DENY" ], "enumDescriptions": [ - "Unspecified. Results in an error.", + "This is only used for distinguishing unset values and should never be used. Results in an error.", "Allowed action type.", "Deny action type." ], @@ -1042,10 +1042,10 @@ "GOVERN_TAGS" ], "enumDescriptions": [ - "Unspecified. Results in an error.", + "This is only used for distinguishing unset values and should never be used. Results in an error.", "Constraint applied when creating the resource.", "Constraint applied when updating the resource.", - "Constraint applied when deleting the resource. Not supported yet.", + "Constraint applied when deleting the resource. Not currently supported.", "Constraint applied when removing an IAM grant.", "Constraint applied when enforcing forced tagging." ], @@ -1057,7 +1057,7 @@ "additionalProperties": { "$ref": "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter" }, - "description": "Stores Structure of parameters used by Constraint condition. Key of map represents name of the parameter.", + "description": "Stores the structure of `Parameters` used by the constraint condition. The key of `map` represents the name of the parameter.", "type": "object" }, "resourceTypes": { @@ -1079,7 +1079,7 @@ "type": "any" }, "item": { - "description": "Determines the parameter’s value structure. For example, LIST can be specified by defining type : LIST, and item type as : STRING.", + "description": "Determines the parameter's value structure. For example, `LIST` can be specified by defining `type: LIST`, and `item: STRING`.", "enum": [ "TYPE_UNSPECIFIED", "LIST", @@ -1087,7 +1087,7 @@ "BOOLEAN" ], "enumDescriptions": [ - "Unspecified. Results in an error.", + "This is only used for distinguishing unset values and should never be used. Results in an error.", "List parameter type.", "String parameter type.", "Boolean parameter type." @@ -1107,7 +1107,7 @@ "BOOLEAN" ], "enumDescriptions": [ - "Unspecified. Results in an error.", + "This is only used for distinguishing unset values and should never be used. Results in an error.", "List parameter type.", "String parameter type.", "Boolean parameter type." @@ -1122,7 +1122,7 @@ "type": "object" }, "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata": { - "description": "Defines Medata structure.", + "description": "Defines Metadata structure.", "id": "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata", "properties": { "description": { @@ -1133,7 +1133,7 @@ "type": "object" }, "GoogleCloudOrgpolicyV2ConstraintListConstraint": { - "description": "A constraint that allows or disallows a list of string values, which are configured by an Organization Policy administrator with a policy.", + "description": "A constraint type that allows or disallows a list of string values, which are configured in the `PolicyRule`.", "id": "GoogleCloudOrgpolicyV2ConstraintListConstraint", "properties": { "supportsIn": { @@ -1159,14 +1159,14 @@ "DENY" ], "enumDescriptions": [ - "Unspecified. Results in an error.", + "This is only used for distinguishing unset values and should never be used. Results in an error.", "Allowed action type.", "Deny action type." ], "type": "string" }, "condition": { - "description": "Org policy condition/expression. For example: `resource.instanceName.matches(\"[production|test]_.*_(\\d)+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.", + "description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"[production|test]_.*_(\\d)+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.", "type": "string" }, "description": { @@ -1189,10 +1189,10 @@ "GOVERN_TAGS" ], "enumDescriptions": [ - "Unspecified. Results in an error.", + "This is only used for distinguishing unset values and should never be used. Results in an error.", "Constraint applied when creating the resource.", "Constraint applied when updating the resource.", - "Constraint applied when deleting the resource. Not supported yet.", + "Constraint applied when deleting the resource. Not currently supported.", "Constraint applied when removing an IAM grant.", "Constraint applied when enforcing forced tagging." ], @@ -1212,7 +1212,7 @@ "type": "array" }, "updateTime": { - "description": "Output only. The last time this custom constraint was updated. This represents the last time that the `CreateCustomConstraint` or `UpdateCustomConstraint` RPC was called", + "description": "Output only. The last time this custom constraint was updated. This represents the last time that the `CreateCustomConstraint` or `UpdateCustomConstraint` methods were called.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -1239,11 +1239,11 @@ "type": "object" }, "GoogleCloudOrgpolicyV2ListCustomConstraintsResponse": { - "description": "The response returned from the ListCustomConstraints method. It will be empty if no custom constraints are set on the organization resource.", + "description": "The response returned from the ListCustomConstraints method. It will be empty if no custom or managed constraints are set on the organization resource.", "id": "GoogleCloudOrgpolicyV2ListCustomConstraintsResponse", "properties": { "customConstraints": { - "description": "All custom constraints that exist on the organization resource. It will be empty if no custom constraints are set.", + "description": "All custom and managed constraints that exist on the organization resource. It will be empty if no custom constraints are set.", "items": { "$ref": "GoogleCloudOrgpolicyV2CustomConstraint" }, @@ -1297,7 +1297,7 @@ }, "spec": { "$ref": "GoogleCloudOrgpolicyV2PolicySpec", - "description": "Basic information about the Organization Policy." + "description": "Basic information about the organization policy." } }, "type": "object" @@ -1359,7 +1359,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. Required for GMCs if parameters defined in constraints. Pass parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { \"allowedLocations\" : [\"us-east1\", \"us-west1\"], \"allowAll\" : true }", + "description": "Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { \"allowedLocations\" : [\"us-east1\", \"us-west1\"], \"allowAll\" : true }", "type": "object" }, "values": { diff --git a/orgpolicy/v2/orgpolicy-gen.go b/orgpolicy/v2/orgpolicy-gen.go index 21d86319957..46962aaaeb1 100644 --- a/orgpolicy/v2/orgpolicy-gen.go +++ b/orgpolicy/v2/orgpolicy-gen.go @@ -276,7 +276,7 @@ type ProjectsPoliciesService struct { // GoogleCloudOrgpolicyV2AlternatePolicySpec: Similar to PolicySpec but with an // extra 'launch' field for launch reference. The PolicySpec here is specific -// for dry-run/darklaunch. +// for dry-run. type GoogleCloudOrgpolicyV2AlternatePolicySpec struct { // Launch: Reference to the launch that will be used while audit logging and to // control the launch. Should be set only in the alternate policy. @@ -310,19 +310,19 @@ func (s GoogleCloudOrgpolicyV2AlternatePolicySpec) MarshalJSON() ([]byte, error) // policy that includes constraints at different locations in the // organization's resource hierarchy. Policies are inherited down the resource // hierarchy from higher levels, but can also be overridden. For details about -// the inheritance rules please read about `policies`. Constraints have a -// default behavior determined by the `constraint_default` field, which is the -// enforcement behavior that is used in the absence of a policy being defined -// or inherited for the resource in question. +// the inheritance rules, see `Policy`. Constraints have a default behavior +// determined by the `constraint_default` field, which is the enforcement +// behavior that is used in the absence of a policy being defined or inherited +// for the resource in question. type GoogleCloudOrgpolicyV2Constraint struct { - // BooleanConstraint: Defines this constraint as being a BooleanConstraint. + // BooleanConstraint: Defines this constraint as being a boolean constraint. BooleanConstraint *GoogleCloudOrgpolicyV2ConstraintBooleanConstraint `json:"booleanConstraint,omitempty"` // ConstraintDefault: The evaluation behavior of this constraint in the absence // of a policy. // // Possible values: // "CONSTRAINT_DEFAULT_UNSPECIFIED" - This is only used for distinguishing - // unset values and should never be used. + // unset values and should never be used. Results in an error. // "ALLOW" - Indicate that all values are allowed for list constraints. // Indicate that enforcement is off for boolean constraints. // "DENY" - Indicate that all values are denied for list constraints. @@ -333,7 +333,7 @@ type GoogleCloudOrgpolicyV2Constraint struct { Description string `json:"description,omitempty"` // DisplayName: The human readable name. Mutable. DisplayName string `json:"displayName,omitempty"` - // ListConstraint: Defines this constraint as being a ListConstraint. + // ListConstraint: Defines this constraint as being a list constraint. ListConstraint *GoogleCloudOrgpolicyV2ConstraintListConstraint `json:"listConstraint,omitempty"` // Name: Immutable. The resource name of the constraint. Must be in one of the // following forms: * `projects/{project_number}/constraints/{constraint_name}` @@ -364,13 +364,13 @@ func (s GoogleCloudOrgpolicyV2Constraint) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: A constraint that is -// either enforced or not. For example, a constraint -// `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM -// instance, serial port connections will not be opened to that instance. +// GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: A constraint type is +// enforced or not enforced, which is configured in the `PolicyRule`. If +// `customConstraintDefinition` is defined, this constraint is a managed +// constraint. type GoogleCloudOrgpolicyV2ConstraintBooleanConstraint struct { - // CustomConstraintDefinition: Custom constraint definition. This is set only - // for Managed Constraints + // CustomConstraintDefinition: Custom constraint definition. Defines this as a + // managed constraint. CustomConstraintDefinition *GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition `json:"customConstraintDefinition,omitempty"` // ForceSendFields is a list of field names (e.g. "CustomConstraintDefinition") // to unconditionally include in API requests. By default, fields with empty or @@ -390,14 +390,14 @@ func (s GoogleCloudOrgpolicyV2ConstraintBooleanConstraint) MarshalJSON() ([]byte return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition: Currently used -// for Managed Constraints. This represents a subset of fields missing from -// Constraint proto that are required to describe CustomConstraint +// GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition: Custom +// constraint definition. Defines this as a managed constraint. type GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition struct { // ActionType: Allow or deny type. // // Possible values: - // "ACTION_TYPE_UNSPECIFIED" - Unspecified. Results in an error. + // "ACTION_TYPE_UNSPECIFIED" - This is only used for distinguishing unset + // values and should never be used. Results in an error. // "ALLOW" - Allowed action type. // "DENY" - Deny action type. ActionType string `json:"actionType,omitempty"` @@ -409,16 +409,17 @@ type GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition struct { // MethodTypes: All the operations being applied for this constraint. // // Possible values: - // "METHOD_TYPE_UNSPECIFIED" - Unspecified. Results in an error. + // "METHOD_TYPE_UNSPECIFIED" - This is only used for distinguishing unset + // values and should never be used. Results in an error. // "CREATE" - Constraint applied when creating the resource. // "UPDATE" - Constraint applied when updating the resource. - // "DELETE" - Constraint applied when deleting the resource. Not supported - // yet. + // "DELETE" - Constraint applied when deleting the resource. Not currently + // supported. // "REMOVE_GRANT" - Constraint applied when removing an IAM grant. // "GOVERN_TAGS" - Constraint applied when enforcing forced tagging. MethodTypes []string `json:"methodTypes,omitempty"` - // Parameters: Stores Structure of parameters used by Constraint condition. Key - // of map represents name of the parameter. + // Parameters: Stores the structure of `Parameters` used by the constraint + // condition. The key of `map` represents the name of the parameter. Parameters map[string]GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter `json:"parameters,omitempty"` // ResourceTypes: The resource instance type on which this policy applies. // Format will be of the form : `/` Example: * @@ -448,11 +449,12 @@ type GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter struct // DefaultValue: Sets the value of the parameter in an assignment if no value // is given. DefaultValue interface{} `json:"defaultValue,omitempty"` - // Item: Determines the parameter’s value structure. For example, LIST can be - // specified by defining type : LIST, and item type as : STRING. + // Item: Determines the parameter's value structure. For example, `LIST` can be + // specified by defining `type: LIST`, and `item: STRING`. // // Possible values: - // "TYPE_UNSPECIFIED" - Unspecified. Results in an error. + // "TYPE_UNSPECIFIED" - This is only used for distinguishing unset values and + // should never be used. Results in an error. // "LIST" - List parameter type. // "STRING" - String parameter type. // "BOOLEAN" - Boolean parameter type. @@ -463,7 +465,8 @@ type GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter struct // Type: Type of the parameter. // // Possible values: - // "TYPE_UNSPECIFIED" - Unspecified. Results in an error. + // "TYPE_UNSPECIFIED" - This is only used for distinguishing unset values and + // should never be used. Results in an error. // "LIST" - List parameter type. // "STRING" - String parameter type. // "BOOLEAN" - Boolean parameter type. @@ -491,7 +494,7 @@ func (s GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter) Mar } // GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata: -// Defines Medata structure. +// Defines Metadata structure. type GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata struct { // Description: Detailed description of what this `parameter` is and use of it. // Mutable. @@ -514,9 +517,9 @@ func (s GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetad return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudOrgpolicyV2ConstraintListConstraint: A constraint that allows or -// disallows a list of string values, which are configured by an Organization -// Policy administrator with a policy. +// GoogleCloudOrgpolicyV2ConstraintListConstraint: A constraint type that +// allows or disallows a list of string values, which are configured in the +// `PolicyRule`. type GoogleCloudOrgpolicyV2ConstraintListConstraint struct { // SupportsIn: Indicates whether values grouped into categories can be used in // `Policy.allowed_values` and `Policy.denied_values`. For example, @@ -554,11 +557,13 @@ type GoogleCloudOrgpolicyV2CustomConstraint struct { // ActionType: Allow or deny type. // // Possible values: - // "ACTION_TYPE_UNSPECIFIED" - Unspecified. Results in an error. + // "ACTION_TYPE_UNSPECIFIED" - This is only used for distinguishing unset + // values and should never be used. Results in an error. // "ALLOW" - Allowed action type. // "DENY" - Deny action type. ActionType string `json:"actionType,omitempty"` - // Condition: Org policy condition/expression. For example: + // Condition: A Common Expression Language (CEL) condition which is used in the + // evaluation of the constraint. For example: // `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, // `resource.management.auto_upgrade == true` The max length of the condition // is 1000 characters. @@ -572,11 +577,12 @@ type GoogleCloudOrgpolicyV2CustomConstraint struct { // MethodTypes: All the operations being applied for this constraint. // // Possible values: - // "METHOD_TYPE_UNSPECIFIED" - Unspecified. Results in an error. + // "METHOD_TYPE_UNSPECIFIED" - This is only used for distinguishing unset + // values and should never be used. Results in an error. // "CREATE" - Constraint applied when creating the resource. // "UPDATE" - Constraint applied when updating the resource. - // "DELETE" - Constraint applied when deleting the resource. Not supported - // yet. + // "DELETE" - Constraint applied when deleting the resource. Not currently + // supported. // "REMOVE_GRANT" - Constraint applied when removing an IAM grant. // "GOVERN_TAGS" - Constraint applied when enforcing forced tagging. MethodTypes []string `json:"methodTypes,omitempty"` @@ -593,7 +599,7 @@ type GoogleCloudOrgpolicyV2CustomConstraint struct { ResourceTypes []string `json:"resourceTypes,omitempty"` // UpdateTime: Output only. The last time this custom constraint was updated. // This represents the last time that the `CreateCustomConstraint` or - // `UpdateCustomConstraint` RPC was called + // `UpdateCustomConstraint` methods were called. UpdateTime string `json:"updateTime,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -647,11 +653,11 @@ func (s GoogleCloudOrgpolicyV2ListConstraintsResponse) MarshalJSON() ([]byte, er } // GoogleCloudOrgpolicyV2ListCustomConstraintsResponse: The response returned -// from the ListCustomConstraints method. It will be empty if no custom -// constraints are set on the organization resource. +// from the ListCustomConstraints method. It will be empty if no custom or +// managed constraints are set on the organization resource. type GoogleCloudOrgpolicyV2ListCustomConstraintsResponse struct { - // CustomConstraints: All custom constraints that exist on the organization - // resource. It will be empty if no custom constraints are set. + // CustomConstraints: All custom and managed constraints that exist on the + // organization resource. It will be empty if no custom constraints are set. CustomConstraints []*GoogleCloudOrgpolicyV2CustomConstraint `json:"customConstraints,omitempty"` // NextPageToken: Page token used to retrieve the next page. This is currently // not used, but the server may at any point start supplying a valid token. @@ -733,7 +739,7 @@ type GoogleCloudOrgpolicyV2Policy struct { // name for API requests, but responses will return the name using the // equivalent project number. Name string `json:"name,omitempty"` - // Spec: Basic information about the Organization Policy. + // Spec: Basic information about the organization policy. Spec *GoogleCloudOrgpolicyV2PolicySpec `json:"spec,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -833,11 +839,11 @@ type GoogleCloudOrgpolicyV2PolicySpecPolicyRule struct { // configuration is acceptable. This field can be set only in policies for // boolean constraints. Enforce bool `json:"enforce,omitempty"` - // Parameters: Optional. Required for GMCs if parameters defined in - // constraints. Pass parameter values when policy enforcement is enabled. - // Ensure that parameter value types match those defined in the constraint - // definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], - // "allowAll" : true } + // Parameters: Optional. Required for managed constraints if parameters are + // defined. Passes parameter values when policy enforcement is enabled. Ensure + // that parameter value types match those defined in the constraint definition. + // For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : + // true } Parameters googleapi.RawMessage `json:"parameters,omitempty"` // Values: List of values to be used for this policy rule. This field can be // set only in policies for list constraints. @@ -2192,11 +2198,12 @@ type OrganizationsCustomConstraintsGetCall struct { header_ http.Header } -// Get: Gets a custom constraint. Returns a `google.rpc.Status` with -// `google.rpc.Code.NOT_FOUND` if the custom constraint does not exist. +// Get: Gets a custom or managed constraint. Returns a `google.rpc.Status` with +// `google.rpc.Code.NOT_FOUND` if the custom or managed constraint does not +// exist. // -// - name: Resource name of the custom constraint. See the custom constraint -// entry for naming requirements. +// - name: Resource name of the custom or managed constraint. See the custom +// constraint entry for naming requirements. func (r *OrganizationsCustomConstraintsService) Get(name string) *OrganizationsCustomConstraintsGetCall { c := &OrganizationsCustomConstraintsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name diff --git a/retail/v2/retail-api.json b/retail/v2/retail-api.json index 9257c27f71d..678baa4661f 100644 --- a/retail/v2/retail-api.json +++ b/retail/v2/retail-api.json @@ -2223,7 +2223,7 @@ } } }, - "revision": "20250109", + "revision": "20250116", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2919,10 +2919,11 @@ "type": "object" }, "GoogleCloudRetailV2CompleteQueryResponseAttributeResult": { - "description": "Resource that represents attribute results. The list of suggestions for the attribute.", + "description": "Resource that represents attribute results.", "id": "GoogleCloudRetailV2CompleteQueryResponseAttributeResult", "properties": { "suggestions": { + "description": "The list of suggestions for the attribute.", "items": { "type": "string" }, diff --git a/retail/v2/retail-gen.go b/retail/v2/retail-gen.go index 834294af412..076def6bb8d 100644 --- a/retail/v2/retail-gen.go +++ b/retail/v2/retail-gen.go @@ -1432,8 +1432,9 @@ func (s GoogleCloudRetailV2CompleteQueryResponse) MarshalJSON() ([]byte, error) } // GoogleCloudRetailV2CompleteQueryResponseAttributeResult: Resource that -// represents attribute results. The list of suggestions for the attribute. +// represents attribute results. type GoogleCloudRetailV2CompleteQueryResponseAttributeResult struct { + // Suggestions: The list of suggestions for the attribute. Suggestions []string `json:"suggestions,omitempty"` // ForceSendFields is a list of field names (e.g. "Suggestions") to // unconditionally include in API requests. By default, fields with empty or diff --git a/retail/v2alpha/retail-api.json b/retail/v2alpha/retail-api.json index 7e0202eb1db..ad2ff1c49f7 100644 --- a/retail/v2alpha/retail-api.json +++ b/retail/v2alpha/retail-api.json @@ -2744,7 +2744,7 @@ } } }, - "revision": "20250109", + "revision": "20250116", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4230,10 +4230,11 @@ "type": "object" }, "GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult": { - "description": "Resource that represents attribute results. The list of suggestions for the attribute.", + "description": "Resource that represents attribute results.", "id": "GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult", "properties": { "suggestions": { + "description": "The list of suggestions for the attribute.", "items": { "type": "string" }, diff --git a/retail/v2alpha/retail-gen.go b/retail/v2alpha/retail-gen.go index b3bd08fc2fe..1b8d973d7e7 100644 --- a/retail/v2alpha/retail-gen.go +++ b/retail/v2alpha/retail-gen.go @@ -2600,8 +2600,9 @@ func (s GoogleCloudRetailV2alphaCompleteQueryResponse) MarshalJSON() ([]byte, er } // GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult: Resource that -// represents attribute results. The list of suggestions for the attribute. +// represents attribute results. type GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult struct { + // Suggestions: The list of suggestions for the attribute. Suggestions []string `json:"suggestions,omitempty"` // ForceSendFields is a list of field names (e.g. "Suggestions") to // unconditionally include in API requests. By default, fields with empty or diff --git a/retail/v2beta/retail-api.json b/retail/v2beta/retail-api.json index c1480a87e69..ab659c6ce3f 100644 --- a/retail/v2beta/retail-api.json +++ b/retail/v2beta/retail-api.json @@ -2368,7 +2368,7 @@ } } }, - "revision": "20250109", + "revision": "20250116", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4573,10 +4573,11 @@ "type": "object" }, "GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult": { - "description": "Resource that represents attribute results. The list of suggestions for the attribute.", + "description": "Resource that represents attribute results.", "id": "GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult", "properties": { "suggestions": { + "description": "The list of suggestions for the attribute.", "items": { "type": "string" }, diff --git a/retail/v2beta/retail-gen.go b/retail/v2beta/retail-gen.go index 08be07d8427..f18ab33abcf 100644 --- a/retail/v2beta/retail-gen.go +++ b/retail/v2beta/retail-gen.go @@ -3569,8 +3569,9 @@ func (s GoogleCloudRetailV2betaCompleteQueryResponse) MarshalJSON() ([]byte, err } // GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult: Resource that -// represents attribute results. The list of suggestions for the attribute. +// represents attribute results. type GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult struct { + // Suggestions: The list of suggestions for the attribute. Suggestions []string `json:"suggestions,omitempty"` // ForceSendFields is a list of field names (e.g. "Suggestions") to // unconditionally include in API requests. By default, fields with empty or diff --git a/vmmigration/v1alpha1/vmmigration-api.json b/vmmigration/v1alpha1/vmmigration-api.json index e80d2ef56bb..ea6dbaedb4f 100644 --- a/vmmigration/v1alpha1/vmmigration-api.json +++ b/vmmigration/v1alpha1/vmmigration-api.json @@ -2220,7 +2220,7 @@ } } }, - "revision": "20241114", + "revision": "20250116", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -6013,12 +6013,14 @@ "enum": [ "OS_CAPABILITY_UNSPECIFIED", "OS_CAPABILITY_NVME_STORAGE_ACCESS", - "OS_CAPABILITY_GVNIC_NETWORK_INTERFACE" + "OS_CAPABILITY_GVNIC_NETWORK_INTERFACE", + "OS_CAPABILITY_IDPF_NETWORK_INTERFACE" ], "enumDescriptions": [ "This is for API compatibility only and is not in use.", "NVMe driver installed and the VM can use NVMe PD or local SSD.", - "gVNIC virtual NIC driver supported." + "gVNIC virtual NIC driver supported.", + "IDPF virtual NIC driver supported." ], "type": "string" }, diff --git a/vmmigration/v1alpha1/vmmigration-gen.go b/vmmigration/v1alpha1/vmmigration-gen.go index 7577a277450..43a1e64ae12 100644 --- a/vmmigration/v1alpha1/vmmigration-gen.go +++ b/vmmigration/v1alpha1/vmmigration-gen.go @@ -3931,6 +3931,8 @@ type VmCapabilities struct { // use NVMe PD or local SSD. // "OS_CAPABILITY_GVNIC_NETWORK_INTERFACE" - gVNIC virtual NIC driver // supported. + // "OS_CAPABILITY_IDPF_NETWORK_INTERFACE" - IDPF virtual NIC driver + // supported. OsCapabilities []string `json:"osCapabilities,omitempty"` // ForceSendFields is a list of field names (e.g. // "LastOsCapabilitiesUpdateTime") to unconditionally include in API requests. diff --git a/webfonts/v1/webfonts-api.json b/webfonts/v1/webfonts-api.json index 9c87d0c1ec6..daa3cec7d0f 100644 --- a/webfonts/v1/webfonts-api.json +++ b/webfonts/v1/webfonts-api.json @@ -120,6 +120,11 @@ "repeated": true, "type": "string" }, + "category": { + "description": "Filters by Webfont.category, if category is found in Webfont.categories. If not set, returns all families.", + "location": "query", + "type": "string" + }, "family": { "description": "Filters by Webfont.family, using literal match. If not set, returns all families", "location": "query", @@ -161,7 +166,7 @@ } } }, - "revision": "20240508", + "revision": "20250121", "rootUrl": "https://webfonts.googleapis.com/", "schemas": { "Axis": { diff --git a/webfonts/v1/webfonts-gen.go b/webfonts/v1/webfonts-gen.go index 16080fb4b0a..edea26ce813 100644 --- a/webfonts/v1/webfonts-gen.go +++ b/webfonts/v1/webfonts-gen.go @@ -300,6 +300,14 @@ func (c *WebfontsListCall) Capability(capability ...string) *WebfontsListCall { return c } +// Category sets the optional parameter "category": Filters by +// Webfont.category, if category is found in Webfont.categories. If not set, +// returns all families. +func (c *WebfontsListCall) Category(category string) *WebfontsListCall { + c.urlParams_.Set("category", category) + return c +} + // Family sets the optional parameter "family": Filters by Webfont.family, // using literal match. If not set, returns all families func (c *WebfontsListCall) Family(family ...string) *WebfontsListCall {