google-api-python-client 2.86.0__py2.py3-none-any.whl → 2.87.0__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {google_api_python_client-2.86.0.dist-info → google_api_python_client-2.87.0.dist-info}/METADATA +2 -2
- {google_api_python_client-2.86.0.dist-info → google_api_python_client-2.87.0.dist-info}/RECORD +406 -404
- googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json +1 -1
- googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +1 -1
- googleapiclient/discovery_cache/documents/accessapproval.v1.json +12 -3
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/acmedns.v1.json +1 -1
- googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +4 -4
- googleapiclient/discovery_cache/documents/adexperiencereport.v1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.datatransferv1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +4 -4
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +4 -4
- googleapiclient/discovery_cache/documents/admin.reports_v1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.reportsv1.json +1 -1
- googleapiclient/discovery_cache/documents/admob.v1.json +2 -2
- googleapiclient/discovery_cache/documents/admob.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/adsense.v2.json +1 -1
- googleapiclient/discovery_cache/documents/advisorynotifications.v1.json +1 -1
- googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +86 -6
- googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +445 -9
- googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +4 -4
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +1 -20
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +1 -20
- googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +10 -3
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +5 -1
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +39 -8
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +23 -17
- googleapiclient/discovery_cache/documents/apigateway.v1.json +2 -2
- googleapiclient/discovery_cache/documents/apigateway.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/apigee.v1.json +34 -25
- googleapiclient/discovery_cache/documents/apikeys.v2.json +1 -1
- googleapiclient/discovery_cache/documents/appengine.v1.json +2 -2
- googleapiclient/discovery_cache/documents/appengine.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/appengine.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1.json +206 -2
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +4 -2
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +4 -2
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +22 -18
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +130 -2
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +3 -3
- googleapiclient/discovery_cache/documents/baremetalsolution.v2.json +2 -2
- googleapiclient/discovery_cache/documents/batch.v1.json +45 -4
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +286 -2
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +458 -2
- googleapiclient/discovery_cache/documents/bigquery.v2.json +196 -42
- googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +4 -2
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +4 -3
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +6 -2
- googleapiclient/discovery_cache/documents/billingbudgets.v1.json +1 -1
- googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +1 -1
- googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/blogger.v2.json +1 -1
- googleapiclient/discovery_cache/documents/blogger.v3.json +1 -1
- googleapiclient/discovery_cache/documents/books.v1.json +1 -1
- googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +2 -2
- googleapiclient/discovery_cache/documents/certificatemanager.v1.json +4 -4
- googleapiclient/discovery_cache/documents/chat.v1.json +973 -166
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +91 -27
- googleapiclient/discovery_cache/documents/chromepolicy.v1.json +9 -1
- googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +1 -1
- googleapiclient/discovery_cache/documents/civicinfo.v2.json +1 -1
- googleapiclient/discovery_cache/documents/classroom.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1.json +172 -7
- googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudbilling.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +51 -19
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +164 -16
- googleapiclient/discovery_cache/documents/clouddebugger.v2.json +1 -1
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +53 -3
- googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +92 -92
- googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +91 -91
- googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +91 -91
- googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +91 -91
- googleapiclient/discovery_cache/documents/cloudidentity.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudkms.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudprofiler.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +2 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +8 -8
- googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +3 -3
- googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/cloudsearch.v1.json +369 -44
- googleapiclient/discovery_cache/documents/cloudshell.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +12 -12
- googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +11 -3
- googleapiclient/discovery_cache/documents/cloudtrace.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudtrace.v2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/composer.v1.json +349 -3
- googleapiclient/discovery_cache/documents/composer.v1beta1.json +272 -3
- googleapiclient/discovery_cache/documents/compute.alpha.json +539 -40
- googleapiclient/discovery_cache/documents/compute.beta.json +3403 -757
- googleapiclient/discovery_cache/documents/compute.v1.json +1017 -26
- googleapiclient/discovery_cache/documents/connectors.v1.json +524 -3
- googleapiclient/discovery_cache/documents/connectors.v2.json +1 -1
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +50 -4
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +157 -1
- googleapiclient/discovery_cache/documents/container.v1.json +30 -22
- googleapiclient/discovery_cache/documents/container.v1beta1.json +45 -22
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +208 -87
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +81 -5
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +159 -7
- googleapiclient/discovery_cache/documents/content.v2.1.json +211 -7
- googleapiclient/discovery_cache/documents/contentwarehouse.v1.json +1468 -234
- googleapiclient/discovery_cache/documents/customsearch.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +19 -4
- googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +8 -3
- googleapiclient/discovery_cache/documents/dataflow.v1b3.json +38 -3
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +50 -2
- googleapiclient/discovery_cache/documents/datafusion.v1.json +7 -2
- googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +7 -2
- googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/datalineage.v1.json +4 -4
- googleapiclient/discovery_cache/documents/datamigration.v1.json +106 -5
- googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +6 -4
- googleapiclient/discovery_cache/documents/datapipelines.v1.json +1 -1
- googleapiclient/discovery_cache/documents/dataplex.v1.json +381 -4
- googleapiclient/discovery_cache/documents/dataproc.v1.json +7 -7
- googleapiclient/discovery_cache/documents/datastore.v1.json +2 -2
- googleapiclient/discovery_cache/documents/datastore.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/datastore.v1beta3.json +2 -2
- googleapiclient/discovery_cache/documents/datastream.v1.json +3 -3
- googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +27 -2
- googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +1 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +1 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/dfareporting.v3.5.json +1 -1
- googleapiclient/discovery_cache/documents/dfareporting.v4.json +62 -1
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +365 -18
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +439 -18
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +219 -18
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +219 -18
- googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +344 -29
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +344 -29
- googleapiclient/discovery_cache/documents/displayvideo.v1.json +100 -100
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +106 -106
- googleapiclient/discovery_cache/documents/dlp.v2.json +20 -12
- googleapiclient/discovery_cache/documents/dns.v1.json +1 -1
- googleapiclient/discovery_cache/documents/dns.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/docs.v1.json +1 -1
- googleapiclient/discovery_cache/documents/documentai.v1.json +417 -141
- googleapiclient/discovery_cache/documents/documentai.v1beta2.json +309 -108
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +427 -147
- googleapiclient/discovery_cache/documents/domains.v1.json +2 -2
- googleapiclient/discovery_cache/documents/domains.v1alpha2.json +2 -2
- googleapiclient/discovery_cache/documents/domains.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/domainsrdap.v1.json +1 -1
- googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json +1 -1
- googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +3 -3
- googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drive.v2.json +9 -4
- googleapiclient/discovery_cache/documents/drive.v3.json +44 -39
- googleapiclient/discovery_cache/documents/driveactivity.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drivelabels.v2.json +6 -4
- googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +6 -4
- googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +1 -1
- googleapiclient/discovery_cache/documents/eventarc.v1.json +10 -10
- googleapiclient/discovery_cache/documents/eventarc.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/fcm.v1.json +17 -1
- googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/file.v1.json +10 -6
- googleapiclient/discovery_cache/documents/file.v1beta1.json +61 -6
- googleapiclient/discovery_cache/documents/firebase.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +5 -1
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +62 -1
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +2 -12
- googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasehosting.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +7 -1
- googleapiclient/discovery_cache/documents/firebaseml.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/firebaserules.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +5 -5
- googleapiclient/discovery_cache/documents/firestore.v1.json +509 -3
- googleapiclient/discovery_cache/documents/firestore.v1beta1.json +43 -1
- googleapiclient/discovery_cache/documents/firestore.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/fitness.v1.json +1 -1
- googleapiclient/discovery_cache/documents/forms.v1.json +1 -1
- googleapiclient/discovery_cache/documents/games.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +1 -1
- googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +1 -1
- googleapiclient/discovery_cache/documents/gameservices.v1.json +2 -2
- googleapiclient/discovery_cache/documents/gameservices.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/genomics.v2alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +2 -2
- googleapiclient/discovery_cache/documents/gkehub.v1.json +108 -12
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +162 -25
- googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json +8 -8
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +154 -17
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +3 -2
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +2 -2
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +6197 -0
- googleapiclient/discovery_cache/documents/gmail.v1.json +3 -3
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/healthcare.v1.json +50 -6
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +16 -8
- googleapiclient/discovery_cache/documents/homegraph.v1.json +1 -1
- googleapiclient/discovery_cache/documents/iam.v1.json +40 -3
- googleapiclient/discovery_cache/documents/iam.v2.json +1 -1
- googleapiclient/discovery_cache/documents/iam.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/iamcredentials.v1.json +1 -1
- googleapiclient/discovery_cache/documents/iap.v1.json +1 -1
- googleapiclient/discovery_cache/documents/iap.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +56 -1
- googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +608 -1
- googleapiclient/discovery_cache/documents/indexing.v3.json +1 -1
- googleapiclient/discovery_cache/documents/integrations.v1alpha.json +75 -5
- googleapiclient/discovery_cache/documents/jobs.v3.json +1 -1
- googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/jobs.v4.json +1 -1
- googleapiclient/discovery_cache/documents/keep.v1.json +1 -1
- googleapiclient/discovery_cache/documents/kgsearch.v1.json +1 -1
- googleapiclient/discovery_cache/documents/kmsinventory.v1.json +1 -1
- googleapiclient/discovery_cache/documents/language.v1.json +2 -2
- googleapiclient/discovery_cache/documents/language.v1beta2.json +3 -3
- googleapiclient/discovery_cache/documents/libraryagent.v1.json +1 -1
- googleapiclient/discovery_cache/documents/licensing.v1.json +1 -1
- googleapiclient/discovery_cache/documents/lifesciences.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/localservices.v1.json +1 -1
- googleapiclient/discovery_cache/documents/logging.v2.json +3 -3
- googleapiclient/discovery_cache/documents/managedidentities.v1.json +93 -2
- googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/memcache.v1.json +3 -3
- googleapiclient/discovery_cache/documents/memcache.v1beta2.json +3 -3
- googleapiclient/discovery_cache/documents/metastore.v1.json +168 -2
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +16 -2
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +16 -2
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +198 -12
- googleapiclient/discovery_cache/documents/ml.v1.json +1 -1
- googleapiclient/discovery_cache/documents/monitoring.v1.json +1 -1
- googleapiclient/discovery_cache/documents/monitoring.v3.json +4 -4
- googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessbusinesscalls.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +1 -1
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +1379 -170
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +6 -6
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +6 -6
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +1005 -35
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +9 -9
- googleapiclient/discovery_cache/documents/networkservices.v1.json +15 -8
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +15 -8
- googleapiclient/discovery_cache/documents/notebooks.v1.json +2 -2
- googleapiclient/discovery_cache/documents/notebooks.v2.json +2 -2
- googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +119 -21
- googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +119 -21
- googleapiclient/discovery_cache/documents/orgpolicy.v2.json +1 -1
- googleapiclient/discovery_cache/documents/osconfig.v1.json +1 -1
- googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +4 -1
- googleapiclient/discovery_cache/documents/osconfig.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/oslogin.v1.json +1 -1
- googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/oslogin.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +1 -1
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +10 -4
- googleapiclient/discovery_cache/documents/people.v1.json +1 -1
- googleapiclient/discovery_cache/documents/playcustomapp.v1.json +1 -1
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +297 -28
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +297 -28
- googleapiclient/discovery_cache/documents/playintegrity.v1.json +35 -1
- googleapiclient/discovery_cache/documents/policyanalyzer.v1.json +1 -1
- googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1.json +1 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json +1 -1
- googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/privateca.v1.json +16 -2
- googleapiclient/discovery_cache/documents/privateca.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/publicca.v1.json +180 -0
- googleapiclient/discovery_cache/documents/publicca.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/publicca.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/pubsub.v1.json +79 -3
- googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +1 -1
- googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/pubsublite.v1.json +1 -1
- googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json +1 -1
- googleapiclient/discovery_cache/documents/realtimebidding.v1.json +1 -1
- googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +26 -3
- googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/recommender.v1.json +1 -1
- googleapiclient/discovery_cache/documents/recommender.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/redis.v1.json +2 -2
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/reseller.v1.json +1 -1
- googleapiclient/discovery_cache/documents/resourcesettings.v1.json +1 -1
- googleapiclient/discovery_cache/documents/retail.v2.json +145 -29
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +161 -50
- googleapiclient/discovery_cache/documents/retail.v2beta.json +149 -33
- googleapiclient/discovery_cache/documents/run.v1.json +79 -60
- googleapiclient/discovery_cache/documents/run.v2.json +80 -28
- googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +1 -1
- googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/safebrowsing.v4.json +1 -1
- googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/script.v1.json +15 -1
- googleapiclient/discovery_cache/documents/searchads360.v0.json +161 -99
- googleapiclient/discovery_cache/documents/searchconsole.v1.json +1 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +2 -2
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +111 -97
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +96 -82
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +96 -82
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +11 -3
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +11 -3
- googleapiclient/discovery_cache/documents/servicecontrol.v1.json +1 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +1 -1
- googleapiclient/discovery_cache/documents/servicedirectory.v1.json +2 -2
- googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +13 -3
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +13 -3
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +13 -3
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +132 -4
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +137 -4
- googleapiclient/discovery_cache/documents/sheets.v4.json +1 -1
- googleapiclient/discovery_cache/documents/slides.v1.json +1 -1
- googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sourcerepo.v1.json +1 -1
- googleapiclient/discovery_cache/documents/spanner.v1.json +130 -2
- googleapiclient/discovery_cache/documents/speech.v1.json +21 -1
- googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +21 -1
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +68 -8
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +66 -6
- googleapiclient/discovery_cache/documents/storage.v1.json +2 -2
- googleapiclient/discovery_cache/documents/storagetransfer.v1.json +10 -2
- googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +3 -2
- googleapiclient/discovery_cache/documents/sts.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sts.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/tagmanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/tagmanager.v2.json +1 -1
- googleapiclient/discovery_cache/documents/tasks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/testing.v1.json +52 -2
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +4 -4
- googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +4 -4
- googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +1 -1
- googleapiclient/discovery_cache/documents/tpu.v1.json +2 -2
- googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/tpu.v2.json +2 -2
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +12 -2
- googleapiclient/discovery_cache/documents/trafficdirector.v2.json +1 -1
- googleapiclient/discovery_cache/documents/transcoder.v1.json +4 -4
- googleapiclient/discovery_cache/documents/translate.v3.json +122 -2
- googleapiclient/discovery_cache/documents/translate.v3beta1.json +2 -2
- googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +1 -1
- googleapiclient/discovery_cache/documents/vault.v1.json +1 -1
- googleapiclient/discovery_cache/documents/verifiedaccess.v1.json +1 -1
- googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +266 -7
- googleapiclient/discovery_cache/documents/versionhistory.v1.json +1 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1.json +1 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +1 -1
- googleapiclient/discovery_cache/documents/vision.v1.json +1 -1
- googleapiclient/discovery_cache/documents/vision.v1p1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/vision.v1p2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +34 -2
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +34 -2
- googleapiclient/discovery_cache/documents/vpcaccess.v1.json +2 -2
- googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/webfonts.v1.json +60 -1
- googleapiclient/discovery_cache/documents/webrisk.v1.json +1 -1
- googleapiclient/discovery_cache/documents/websecurityscanner.v1.json +1 -1
- googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +2 -2
- googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/workflows.v1.json +4 -4
- googleapiclient/discovery_cache/documents/workflows.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +56 -22
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +80 -28
- googleapiclient/discovery_cache/documents/youtube.v3.json +4 -2
- googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json +1 -1
- googleapiclient/discovery_cache/documents/youtubereporting.v1.json +1 -1
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.86.0.dist-info → google_api_python_client-2.87.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.86.0.dist-info → google_api_python_client-2.87.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.86.0.dist-info → google_api_python_client-2.87.0.dist-info}/top_level.txt +0 -0
|
@@ -5,9 +5,15 @@
|
|
|
5
5
|
"https://www.googleapis.com/auth/chat.bot": {
|
|
6
6
|
"description": "Private Service: https://www.googleapis.com/auth/chat.bot"
|
|
7
7
|
},
|
|
8
|
+
"https://www.googleapis.com/auth/chat.delete": {
|
|
9
|
+
"description": "Delete conversations and spaces & remove access to associated files in Google Chat"
|
|
10
|
+
},
|
|
8
11
|
"https://www.googleapis.com/auth/chat.memberships": {
|
|
9
12
|
"description": "View, add, and remove members from conversations in Google Chat"
|
|
10
13
|
},
|
|
14
|
+
"https://www.googleapis.com/auth/chat.memberships.app": {
|
|
15
|
+
"description": "Add and remove itself from conversations in Google Chat"
|
|
16
|
+
},
|
|
11
17
|
"https://www.googleapis.com/auth/chat.memberships.readonly": {
|
|
12
18
|
"description": "View members in Google Chat conversations."
|
|
13
19
|
},
|
|
@@ -17,12 +23,24 @@
|
|
|
17
23
|
"https://www.googleapis.com/auth/chat.messages.create": {
|
|
18
24
|
"description": "Compose and send messages in Google Chat"
|
|
19
25
|
},
|
|
26
|
+
"https://www.googleapis.com/auth/chat.messages.reactions": {
|
|
27
|
+
"description": "View, add, and delete reactions to messages in Google Chat"
|
|
28
|
+
},
|
|
29
|
+
"https://www.googleapis.com/auth/chat.messages.reactions.create": {
|
|
30
|
+
"description": "Add reactions to messages in Google Chat"
|
|
31
|
+
},
|
|
32
|
+
"https://www.googleapis.com/auth/chat.messages.reactions.readonly": {
|
|
33
|
+
"description": "View reactions to messages in Google Chat"
|
|
34
|
+
},
|
|
20
35
|
"https://www.googleapis.com/auth/chat.messages.readonly": {
|
|
21
36
|
"description": "View messages and reactions in Google Chat"
|
|
22
37
|
},
|
|
23
38
|
"https://www.googleapis.com/auth/chat.spaces": {
|
|
24
39
|
"description": "Create conversations and spaces and view or update metadata (including history settings) in Google Chat"
|
|
25
40
|
},
|
|
41
|
+
"https://www.googleapis.com/auth/chat.spaces.create": {
|
|
42
|
+
"description": "Create new conversations in Google Chat"
|
|
43
|
+
},
|
|
26
44
|
"https://www.googleapis.com/auth/chat.spaces.readonly": {
|
|
27
45
|
"description": "View chat and spaces in Google Chat"
|
|
28
46
|
}
|
|
@@ -155,11 +173,130 @@
|
|
|
155
173
|
"https://www.googleapis.com/auth/chat.messages.readonly"
|
|
156
174
|
],
|
|
157
175
|
"supportsMediaDownload": true
|
|
176
|
+
},
|
|
177
|
+
"upload": {
|
|
178
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Uploads an attachment. Requires user [authentication](https://developers.google.com/chat/api/guides/auth/users). You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).",
|
|
179
|
+
"flatPath": "v1/spaces/{spacesId}/attachments:upload",
|
|
180
|
+
"httpMethod": "POST",
|
|
181
|
+
"id": "chat.media.upload",
|
|
182
|
+
"mediaUpload": {
|
|
183
|
+
"accept": [
|
|
184
|
+
"*/*"
|
|
185
|
+
],
|
|
186
|
+
"maxSize": "209715200",
|
|
187
|
+
"protocols": {
|
|
188
|
+
"resumable": {
|
|
189
|
+
"multipart": true,
|
|
190
|
+
"path": "/resumable/upload/v1/{+parent}/attachments:upload"
|
|
191
|
+
},
|
|
192
|
+
"simple": {
|
|
193
|
+
"multipart": true,
|
|
194
|
+
"path": "/upload/v1/{+parent}/attachments:upload"
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
},
|
|
198
|
+
"parameterOrder": [
|
|
199
|
+
"parent"
|
|
200
|
+
],
|
|
201
|
+
"parameters": {
|
|
202
|
+
"parent": {
|
|
203
|
+
"description": "Required. Resource name of the Chat space in which the attachment is uploaded. Format \"spaces/{space}\".",
|
|
204
|
+
"location": "path",
|
|
205
|
+
"pattern": "^spaces/[^/]+$",
|
|
206
|
+
"required": true,
|
|
207
|
+
"type": "string"
|
|
208
|
+
}
|
|
209
|
+
},
|
|
210
|
+
"path": "v1/{+parent}/attachments:upload",
|
|
211
|
+
"request": {
|
|
212
|
+
"$ref": "UploadAttachmentRequest"
|
|
213
|
+
},
|
|
214
|
+
"response": {
|
|
215
|
+
"$ref": "UploadAttachmentResponse"
|
|
216
|
+
},
|
|
217
|
+
"scopes": [
|
|
218
|
+
"https://www.googleapis.com/auth/chat.messages",
|
|
219
|
+
"https://www.googleapis.com/auth/chat.messages.create"
|
|
220
|
+
],
|
|
221
|
+
"supportsMediaUpload": true
|
|
158
222
|
}
|
|
159
223
|
}
|
|
160
224
|
},
|
|
161
225
|
"spaces": {
|
|
162
226
|
"methods": {
|
|
227
|
+
"create": {
|
|
228
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access aren't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.",
|
|
229
|
+
"flatPath": "v1/spaces",
|
|
230
|
+
"httpMethod": "POST",
|
|
231
|
+
"id": "chat.spaces.create",
|
|
232
|
+
"parameterOrder": [],
|
|
233
|
+
"parameters": {
|
|
234
|
+
"requestId": {
|
|
235
|
+
"description": "Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.",
|
|
236
|
+
"location": "query",
|
|
237
|
+
"type": "string"
|
|
238
|
+
}
|
|
239
|
+
},
|
|
240
|
+
"path": "v1/spaces",
|
|
241
|
+
"request": {
|
|
242
|
+
"$ref": "Space"
|
|
243
|
+
},
|
|
244
|
+
"response": {
|
|
245
|
+
"$ref": "Space"
|
|
246
|
+
},
|
|
247
|
+
"scopes": [
|
|
248
|
+
"https://www.googleapis.com/auth/chat.spaces",
|
|
249
|
+
"https://www.googleapis.com/auth/chat.spaces.create"
|
|
250
|
+
]
|
|
251
|
+
},
|
|
252
|
+
"delete": {
|
|
253
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Deletes a named space. Always performs a cascading delete, which means that the space's child resources\u2014like messages posted in the space and memberships in the space\u2014are also deleted. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has permission to delete the space, and the `chat.delete` scope.",
|
|
254
|
+
"flatPath": "v1/spaces/{spacesId}",
|
|
255
|
+
"httpMethod": "DELETE",
|
|
256
|
+
"id": "chat.spaces.delete",
|
|
257
|
+
"parameterOrder": [
|
|
258
|
+
"name"
|
|
259
|
+
],
|
|
260
|
+
"parameters": {
|
|
261
|
+
"name": {
|
|
262
|
+
"description": "Required. Resource name of the space to delete. Format: `spaces/{space}`",
|
|
263
|
+
"location": "path",
|
|
264
|
+
"pattern": "^spaces/[^/]+$",
|
|
265
|
+
"required": true,
|
|
266
|
+
"type": "string"
|
|
267
|
+
}
|
|
268
|
+
},
|
|
269
|
+
"path": "v1/{+name}",
|
|
270
|
+
"response": {
|
|
271
|
+
"$ref": "Empty"
|
|
272
|
+
},
|
|
273
|
+
"scopes": [
|
|
274
|
+
"https://www.googleapis.com/auth/chat.delete"
|
|
275
|
+
]
|
|
276
|
+
},
|
|
277
|
+
"findDirectMessage": {
|
|
278
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Returns the existing direct message with the specified user. With [user authentication](https://developers.google.com/chat/api/guides/auth/users), returns the direct message space between the specified user and the authenticated user. With [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), returns the direct message space between the specified user and the calling Chat app. If no direct message space is found, returns a `404 NOT_FOUND` error. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) or [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).",
|
|
279
|
+
"flatPath": "v1/spaces:findDirectMessage",
|
|
280
|
+
"httpMethod": "GET",
|
|
281
|
+
"id": "chat.spaces.findDirectMessage",
|
|
282
|
+
"parameterOrder": [],
|
|
283
|
+
"parameters": {
|
|
284
|
+
"name": {
|
|
285
|
+
"description": "Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API `Person.resourceName` is `people/123456789`, you can find a direct message with that person by using `users/123456789` as the `name`.",
|
|
286
|
+
"location": "query",
|
|
287
|
+
"type": "string"
|
|
288
|
+
}
|
|
289
|
+
},
|
|
290
|
+
"path": "v1/spaces:findDirectMessage",
|
|
291
|
+
"response": {
|
|
292
|
+
"$ref": "Space"
|
|
293
|
+
},
|
|
294
|
+
"scopes": [
|
|
295
|
+
"https://www.googleapis.com/auth/chat.bot",
|
|
296
|
+
"https://www.googleapis.com/auth/chat.spaces",
|
|
297
|
+
"https://www.googleapis.com/auth/chat.spaces.readonly"
|
|
298
|
+
]
|
|
299
|
+
},
|
|
163
300
|
"get": {
|
|
164
301
|
"description": "Returns a space. Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Supports [user authentication](https://developers.google.com/chat/api/guides/auth/users) as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.spaces` or `chat.spaces.readonly` authorization scope.",
|
|
165
302
|
"flatPath": "v1/spaces/{spacesId}",
|
|
@@ -170,7 +307,7 @@
|
|
|
170
307
|
],
|
|
171
308
|
"parameters": {
|
|
172
309
|
"name": {
|
|
173
|
-
"description": "Required. Resource name of the space, in the form \"spaces/*\". Format: spaces/{space}",
|
|
310
|
+
"description": "Required. Resource name of the space, in the form \"spaces/*\". Format: `spaces/{space}`",
|
|
174
311
|
"location": "path",
|
|
175
312
|
"pattern": "^spaces/[^/]+$",
|
|
176
313
|
"required": true,
|
|
@@ -194,14 +331,19 @@
|
|
|
194
331
|
"id": "chat.spaces.list",
|
|
195
332
|
"parameterOrder": [],
|
|
196
333
|
"parameters": {
|
|
334
|
+
"filter": {
|
|
335
|
+
"description": "Optional. A query filter. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). You can filter spaces by the space type ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid enum value, such as `SPACE` or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ``` space_type = \"SPACE\" spaceType = \"GROUP_CHAT\" OR spaceType = \"DIRECT_MESSAGE\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. With [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), this field is ignored and the query always returns all spaces. But the Chat API still validates the query syntax with service accounts, so invalid queries are still rejected. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
336
|
+
"location": "query",
|
|
337
|
+
"type": "string"
|
|
338
|
+
},
|
|
197
339
|
"pageSize": {
|
|
198
|
-
"description": "Optional. The maximum number of spaces to return. The service
|
|
340
|
+
"description": "Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.",
|
|
199
341
|
"format": "int32",
|
|
200
342
|
"location": "query",
|
|
201
343
|
"type": "integer"
|
|
202
344
|
},
|
|
203
345
|
"pageToken": {
|
|
204
|
-
"description": "Optional. A page token, received from a previous list spaces call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.",
|
|
346
|
+
"description": "Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.",
|
|
205
347
|
"location": "query",
|
|
206
348
|
"type": "string"
|
|
207
349
|
}
|
|
@@ -215,11 +357,119 @@
|
|
|
215
357
|
"https://www.googleapis.com/auth/chat.spaces",
|
|
216
358
|
"https://www.googleapis.com/auth/chat.spaces.readonly"
|
|
217
359
|
]
|
|
360
|
+
},
|
|
361
|
+
"patch": {
|
|
362
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Updates a space. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces` scope.",
|
|
363
|
+
"flatPath": "v1/spaces/{spacesId}",
|
|
364
|
+
"httpMethod": "PATCH",
|
|
365
|
+
"id": "chat.spaces.patch",
|
|
366
|
+
"parameterOrder": [
|
|
367
|
+
"name"
|
|
368
|
+
],
|
|
369
|
+
"parameters": {
|
|
370
|
+
"name": {
|
|
371
|
+
"description": "Resource name of the space. Format: `spaces/{space}`",
|
|
372
|
+
"location": "path",
|
|
373
|
+
"pattern": "^spaces/[^/]+$",
|
|
374
|
+
"required": true,
|
|
375
|
+
"type": "string"
|
|
376
|
+
},
|
|
377
|
+
"updateMask": {
|
|
378
|
+
"description": "Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error). - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.)",
|
|
379
|
+
"format": "google-fieldmask",
|
|
380
|
+
"location": "query",
|
|
381
|
+
"type": "string"
|
|
382
|
+
}
|
|
383
|
+
},
|
|
384
|
+
"path": "v1/{+name}",
|
|
385
|
+
"request": {
|
|
386
|
+
"$ref": "Space"
|
|
387
|
+
},
|
|
388
|
+
"response": {
|
|
389
|
+
"$ref": "Space"
|
|
390
|
+
},
|
|
391
|
+
"scopes": [
|
|
392
|
+
"https://www.googleapis.com/auth/chat.spaces"
|
|
393
|
+
]
|
|
394
|
+
},
|
|
395
|
+
"setup": {
|
|
396
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to true and don't specify any memberships. You can only use this method to add app memberships to DMs. To add the calling app as a member of other space types, use [create membership](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/create) If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies or guest access aren't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.",
|
|
397
|
+
"flatPath": "v1/spaces:setup",
|
|
398
|
+
"httpMethod": "POST",
|
|
399
|
+
"id": "chat.spaces.setup",
|
|
400
|
+
"parameterOrder": [],
|
|
401
|
+
"parameters": {},
|
|
402
|
+
"path": "v1/spaces:setup",
|
|
403
|
+
"request": {
|
|
404
|
+
"$ref": "SetUpSpaceRequest"
|
|
405
|
+
},
|
|
406
|
+
"response": {
|
|
407
|
+
"$ref": "Space"
|
|
408
|
+
},
|
|
409
|
+
"scopes": [
|
|
410
|
+
"https://www.googleapis.com/auth/chat.spaces",
|
|
411
|
+
"https://www.googleapis.com/auth/chat.spaces.create"
|
|
412
|
+
]
|
|
218
413
|
}
|
|
219
414
|
},
|
|
220
415
|
"resources": {
|
|
221
416
|
"members": {
|
|
222
417
|
"methods": {
|
|
418
|
+
"create": {
|
|
419
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` (for human membership) or `chat.memberships.app` (for app membership) scope. To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to the space, use `users/app`. - To add a human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, you can add the user to the space by setting the `membership.member.name` to `users/123456789`.",
|
|
420
|
+
"flatPath": "v1/spaces/{spacesId}/members",
|
|
421
|
+
"httpMethod": "POST",
|
|
422
|
+
"id": "chat.spaces.members.create",
|
|
423
|
+
"parameterOrder": [
|
|
424
|
+
"parent"
|
|
425
|
+
],
|
|
426
|
+
"parameters": {
|
|
427
|
+
"parent": {
|
|
428
|
+
"description": "Required. The resource name of the space for which to create the membership. Format: spaces/{space}",
|
|
429
|
+
"location": "path",
|
|
430
|
+
"pattern": "^spaces/[^/]+$",
|
|
431
|
+
"required": true,
|
|
432
|
+
"type": "string"
|
|
433
|
+
}
|
|
434
|
+
},
|
|
435
|
+
"path": "v1/{+parent}/members",
|
|
436
|
+
"request": {
|
|
437
|
+
"$ref": "Membership"
|
|
438
|
+
},
|
|
439
|
+
"response": {
|
|
440
|
+
"$ref": "Membership"
|
|
441
|
+
},
|
|
442
|
+
"scopes": [
|
|
443
|
+
"https://www.googleapis.com/auth/chat.memberships",
|
|
444
|
+
"https://www.googleapis.com/auth/chat.memberships.app"
|
|
445
|
+
]
|
|
446
|
+
},
|
|
447
|
+
"delete": {
|
|
448
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Deletes a membership. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` or `chat.memberships.app` authorization scope.",
|
|
449
|
+
"flatPath": "v1/spaces/{spacesId}/members/{membersId}",
|
|
450
|
+
"httpMethod": "DELETE",
|
|
451
|
+
"id": "chat.spaces.members.delete",
|
|
452
|
+
"parameterOrder": [
|
|
453
|
+
"name"
|
|
454
|
+
],
|
|
455
|
+
"parameters": {
|
|
456
|
+
"name": {
|
|
457
|
+
"description": "Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope and `spaces/{space}/members/{member}` format. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`",
|
|
458
|
+
"location": "path",
|
|
459
|
+
"pattern": "^spaces/[^/]+/members/[^/]+$",
|
|
460
|
+
"required": true,
|
|
461
|
+
"type": "string"
|
|
462
|
+
}
|
|
463
|
+
},
|
|
464
|
+
"path": "v1/{+name}",
|
|
465
|
+
"response": {
|
|
466
|
+
"$ref": "Membership"
|
|
467
|
+
},
|
|
468
|
+
"scopes": [
|
|
469
|
+
"https://www.googleapis.com/auth/chat.memberships",
|
|
470
|
+
"https://www.googleapis.com/auth/chat.memberships.app"
|
|
471
|
+
]
|
|
472
|
+
},
|
|
223
473
|
"get": {
|
|
224
474
|
"description": "Returns a membership. Requires [authentication](https://developers.google.com/chat/api/guides/auth/). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Supports [user authentication](https://developers.google.com/chat/api/guides/auth/users) as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.memberships` or `chat.memberships.readonly` authorization scope.",
|
|
225
475
|
"flatPath": "v1/spaces/{spacesId}/members/{membersId}",
|
|
@@ -230,7 +480,7 @@
|
|
|
230
480
|
],
|
|
231
481
|
"parameters": {
|
|
232
482
|
"name": {
|
|
233
|
-
"description": "Required. Resource name of the membership to retrieve. Format: spaces/{space}/members/{member}",
|
|
483
|
+
"description": "Required. Resource name of the membership to retrieve. Format: `spaces/{space}/members/{member}`",
|
|
234
484
|
"location": "path",
|
|
235
485
|
"pattern": "^spaces/[^/]+/members/[^/]+$",
|
|
236
486
|
"required": true,
|
|
@@ -256,14 +506,19 @@
|
|
|
256
506
|
"parent"
|
|
257
507
|
],
|
|
258
508
|
"parameters": {
|
|
509
|
+
"filter": {
|
|
510
|
+
"description": "Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. For example, the following queries are valid: ``` role = \"ROLE_MANAGER\" OR role = \"ROLE_MEMBER\" member.type = \"HUMAN\" AND role = \"ROLE_MANAGER\" ``` The following queries are invalid: ``` member.type = \"HUMAN\" AND member.type = \"BOT\" role = \"ROLE_MANAGER\" AND role = \"ROLE_MEMBER\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.",
|
|
511
|
+
"location": "query",
|
|
512
|
+
"type": "string"
|
|
513
|
+
},
|
|
259
514
|
"pageSize": {
|
|
260
|
-
"description": "The maximum number of memberships to return. The service
|
|
515
|
+
"description": "The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.",
|
|
261
516
|
"format": "int32",
|
|
262
517
|
"location": "query",
|
|
263
518
|
"type": "integer"
|
|
264
519
|
},
|
|
265
520
|
"pageToken": {
|
|
266
|
-
"description": "A page token, received from a previous call to list memberships. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters
|
|
521
|
+
"description": "A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.",
|
|
267
522
|
"location": "query",
|
|
268
523
|
"type": "string"
|
|
269
524
|
},
|
|
@@ -273,6 +528,11 @@
|
|
|
273
528
|
"pattern": "^spaces/[^/]+$",
|
|
274
529
|
"required": true,
|
|
275
530
|
"type": "string"
|
|
531
|
+
},
|
|
532
|
+
"showInvited": {
|
|
533
|
+
"description": "Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/chat/api/guides/auth/users).",
|
|
534
|
+
"location": "query",
|
|
535
|
+
"type": "boolean"
|
|
276
536
|
}
|
|
277
537
|
},
|
|
278
538
|
"path": "v1/{+parent}/members",
|
|
@@ -312,14 +572,14 @@
|
|
|
312
572
|
],
|
|
313
573
|
"enumDescriptions": [
|
|
314
574
|
"Default. Starts a thread.",
|
|
315
|
-
"Creates the message as a reply to the thread specified by thread ID or thread_key
|
|
316
|
-
"Creates the message as a reply to the thread specified by thread ID or thread_key
|
|
575
|
+
"Creates the message as a reply to the thread specified by thread ID or `thread_key`. If it fails, the message starts a new thread instead.",
|
|
576
|
+
"Creates the message as a reply to the thread specified by thread ID or `thread_key`. If it fails, a `NOT_FOUND` error is returned instead."
|
|
317
577
|
],
|
|
318
578
|
"location": "query",
|
|
319
579
|
"type": "string"
|
|
320
580
|
},
|
|
321
581
|
"parent": {
|
|
322
|
-
"description": "Required. The resource name of the space in which to create a message. Format: spaces/{space}",
|
|
582
|
+
"description": "Required. The resource name of the space in which to create a message. Format: `spaces/{space}`",
|
|
323
583
|
"location": "path",
|
|
324
584
|
"pattern": "^spaces/[^/]+$",
|
|
325
585
|
"required": true,
|
|
@@ -331,6 +591,7 @@
|
|
|
331
591
|
"type": "string"
|
|
332
592
|
},
|
|
333
593
|
"threadKey": {
|
|
594
|
+
"deprecated": true,
|
|
334
595
|
"description": "Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).",
|
|
335
596
|
"location": "query",
|
|
336
597
|
"type": "string"
|
|
@@ -358,8 +619,13 @@
|
|
|
358
619
|
"name"
|
|
359
620
|
],
|
|
360
621
|
"parameters": {
|
|
622
|
+
"force": {
|
|
623
|
+
"description": "When `true`, deleting a message also deletes its threaded replies. When `false`, if a message has threaded replies, deletion fails. Only applies when [authenticating as a user](https://developers.google.com/chat/api/guides/auth/users). Has no effect when [authenticating with a service account] (https://developers.google.com/chat/api/guides/auth/service-accounts).",
|
|
624
|
+
"location": "query",
|
|
625
|
+
"type": "boolean"
|
|
626
|
+
},
|
|
361
627
|
"name": {
|
|
362
|
-
"description": "Required. Resource name of the message to
|
|
628
|
+
"description": "Required. Resource name of the message that you want to delete, in the form `spaces/*/messages/*` Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`",
|
|
363
629
|
"location": "path",
|
|
364
630
|
"pattern": "^spaces/[^/]+/messages/[^/]+$",
|
|
365
631
|
"required": true,
|
|
@@ -385,7 +651,7 @@
|
|
|
385
651
|
],
|
|
386
652
|
"parameters": {
|
|
387
653
|
"name": {
|
|
388
|
-
"description": "Required. Resource name of the message to retrieve. Format: spaces/{space}/messages/{message} If the message begins with `client-`, then it has a custom name assigned by a Chat app that created it with the Chat REST API. That Chat app (but not others) can pass the custom name to get, update, or delete the message. To learn more, see [create and name a message] (https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).",
|
|
654
|
+
"description": "Required. Resource name of the message to retrieve. Format: `spaces/{space}/messages/{message}` If the message begins with `client-`, then it has a custom name assigned by a Chat app that created it with the Chat REST API. That Chat app (but not others) can pass the custom name to get, update, or delete the message. To learn more, see [create and name a message] (https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).",
|
|
389
655
|
"location": "path",
|
|
390
656
|
"pattern": "^spaces/[^/]+/messages/[^/]+$",
|
|
391
657
|
"required": true,
|
|
@@ -402,6 +668,58 @@
|
|
|
402
668
|
"https://www.googleapis.com/auth/chat.messages.readonly"
|
|
403
669
|
]
|
|
404
670
|
},
|
|
671
|
+
"list": {
|
|
672
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.readonly` authorization scope. This method is only supported in spaces that don't allow users from outside the Workspace organization to join.",
|
|
673
|
+
"flatPath": "v1/spaces/{spacesId}/messages",
|
|
674
|
+
"httpMethod": "GET",
|
|
675
|
+
"id": "chat.spaces.messages.list",
|
|
676
|
+
"parameterOrder": [
|
|
677
|
+
"parent"
|
|
678
|
+
],
|
|
679
|
+
"parameters": {
|
|
680
|
+
"filter": {
|
|
681
|
+
"description": "A query filter. You can filter messages by date (`create_time`) and thread (`thread.name`). To filter messages by the date they were created, specify the `create_time` with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and double quotation marks. For example, `\"2023-04-21T11:30:00-04:00\"`. You can use the greater than operator `>` to list messages that were created after a timestamp, or the less than operator `<` to list messages that were created before a timestamp. To filter messages within a time interval, use the `AND` operator between two timestamps. To filter by thread, specify the `thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can only specify one `thread.name` per query. To filter by both thread and date, use the `AND` operator in your query. For example, the following queries are valid: ``` create_time > \"2012-04-21T11:30:00-04:00\" create_time > \"2012-04-21T11:30:00-04:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > \"2012-04-21T11:30:00+00:00\" AND create_time < \"2013-01-01T00:00:00+00:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.",
|
|
682
|
+
"location": "query",
|
|
683
|
+
"type": "string"
|
|
684
|
+
},
|
|
685
|
+
"orderBy": {
|
|
686
|
+
"description": "Optional, if resuming from a previous query. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.",
|
|
687
|
+
"location": "query",
|
|
688
|
+
"type": "string"
|
|
689
|
+
},
|
|
690
|
+
"pageSize": {
|
|
691
|
+
"description": "The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.",
|
|
692
|
+
"format": "int32",
|
|
693
|
+
"location": "query",
|
|
694
|
+
"type": "integer"
|
|
695
|
+
},
|
|
696
|
+
"pageToken": {
|
|
697
|
+
"description": "Optional, if resuming from a previous query. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.",
|
|
698
|
+
"location": "query",
|
|
699
|
+
"type": "string"
|
|
700
|
+
},
|
|
701
|
+
"parent": {
|
|
702
|
+
"description": "Required. The resource name of the space to list messages from. Format: `spaces/{space}`",
|
|
703
|
+
"location": "path",
|
|
704
|
+
"pattern": "^spaces/[^/]+$",
|
|
705
|
+
"required": true,
|
|
706
|
+
"type": "string"
|
|
707
|
+
},
|
|
708
|
+
"showDeleted": {
|
|
709
|
+
"description": "Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.",
|
|
710
|
+
"location": "query",
|
|
711
|
+
"type": "boolean"
|
|
712
|
+
}
|
|
713
|
+
},
|
|
714
|
+
"path": "v1/{+parent}/messages",
|
|
715
|
+
"response": {
|
|
716
|
+
"$ref": "ListMessagesResponse"
|
|
717
|
+
},
|
|
718
|
+
"scopes": [
|
|
719
|
+
"https://www.googleapis.com/auth/chat.messages",
|
|
720
|
+
"https://www.googleapis.com/auth/chat.messages.readonly"
|
|
721
|
+
]
|
|
722
|
+
},
|
|
405
723
|
"patch": {
|
|
406
724
|
"description": "Updates a message. There's a difference between `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For example usage, see [Update a message](https://developers.google.com/chat/api/guides/crudl/messages#update_a_message). Requires [authentication](https://developers.google.com/chat/api/guides/auth/). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Supports [user authentication](https://developers.google.com/chat/api/guides/auth/users) as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.",
|
|
407
725
|
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
|
|
@@ -412,7 +730,7 @@
|
|
|
412
730
|
],
|
|
413
731
|
"parameters": {
|
|
414
732
|
"allowMissing": {
|
|
415
|
-
"description": "Optional. If `true` and the message
|
|
733
|
+
"description": "Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.",
|
|
416
734
|
"location": "query",
|
|
417
735
|
"type": "boolean"
|
|
418
736
|
},
|
|
@@ -424,7 +742,7 @@
|
|
|
424
742
|
"type": "string"
|
|
425
743
|
},
|
|
426
744
|
"updateMask": {
|
|
427
|
-
"description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - cards_v2 ",
|
|
745
|
+
"description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` ",
|
|
428
746
|
"format": "google-fieldmask",
|
|
429
747
|
"location": "query",
|
|
430
748
|
"type": "string"
|
|
@@ -452,7 +770,7 @@
|
|
|
452
770
|
],
|
|
453
771
|
"parameters": {
|
|
454
772
|
"allowMissing": {
|
|
455
|
-
"description": "Optional. If `true` and the message
|
|
773
|
+
"description": "Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.",
|
|
456
774
|
"location": "query",
|
|
457
775
|
"type": "boolean"
|
|
458
776
|
},
|
|
@@ -464,7 +782,7 @@
|
|
|
464
782
|
"type": "string"
|
|
465
783
|
},
|
|
466
784
|
"updateMask": {
|
|
467
|
-
"description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - cards_v2 ",
|
|
785
|
+
"description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` ",
|
|
468
786
|
"format": "google-fieldmask",
|
|
469
787
|
"location": "query",
|
|
470
788
|
"type": "string"
|
|
@@ -496,7 +814,7 @@
|
|
|
496
814
|
],
|
|
497
815
|
"parameters": {
|
|
498
816
|
"name": {
|
|
499
|
-
"description": "Required. Resource name of the attachment, in the form
|
|
817
|
+
"description": "Required. Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.",
|
|
500
818
|
"location": "path",
|
|
501
819
|
"pattern": "^spaces/[^/]+/messages/[^/]+/attachments/[^/]+$",
|
|
502
820
|
"required": true,
|
|
@@ -512,17 +830,121 @@
|
|
|
512
830
|
]
|
|
513
831
|
}
|
|
514
832
|
}
|
|
833
|
+
},
|
|
834
|
+
"reactions": {
|
|
835
|
+
"methods": {
|
|
836
|
+
"create": {
|
|
837
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a reaction and adds it to a message. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages`, `chat.messages.reactions`, or `chat.messages.reactions.create` scope. Only unicode emoji are supported.",
|
|
838
|
+
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions",
|
|
839
|
+
"httpMethod": "POST",
|
|
840
|
+
"id": "chat.spaces.messages.reactions.create",
|
|
841
|
+
"parameterOrder": [
|
|
842
|
+
"parent"
|
|
843
|
+
],
|
|
844
|
+
"parameters": {
|
|
845
|
+
"parent": {
|
|
846
|
+
"description": "Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}`",
|
|
847
|
+
"location": "path",
|
|
848
|
+
"pattern": "^spaces/[^/]+/messages/[^/]+$",
|
|
849
|
+
"required": true,
|
|
850
|
+
"type": "string"
|
|
851
|
+
}
|
|
852
|
+
},
|
|
853
|
+
"path": "v1/{+parent}/reactions",
|
|
854
|
+
"request": {
|
|
855
|
+
"$ref": "Reaction"
|
|
856
|
+
},
|
|
857
|
+
"response": {
|
|
858
|
+
"$ref": "Reaction"
|
|
859
|
+
},
|
|
860
|
+
"scopes": [
|
|
861
|
+
"https://www.googleapis.com/auth/chat.messages",
|
|
862
|
+
"https://www.googleapis.com/auth/chat.messages.reactions",
|
|
863
|
+
"https://www.googleapis.com/auth/chat.messages.reactions.create"
|
|
864
|
+
]
|
|
865
|
+
},
|
|
866
|
+
"delete": {
|
|
867
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Deletes a reaction to a message. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.reactions` scope.",
|
|
868
|
+
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}",
|
|
869
|
+
"httpMethod": "DELETE",
|
|
870
|
+
"id": "chat.spaces.messages.reactions.delete",
|
|
871
|
+
"parameterOrder": [
|
|
872
|
+
"name"
|
|
873
|
+
],
|
|
874
|
+
"parameters": {
|
|
875
|
+
"name": {
|
|
876
|
+
"description": "Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`",
|
|
877
|
+
"location": "path",
|
|
878
|
+
"pattern": "^spaces/[^/]+/messages/[^/]+/reactions/[^/]+$",
|
|
879
|
+
"required": true,
|
|
880
|
+
"type": "string"
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
"path": "v1/{+name}",
|
|
884
|
+
"response": {
|
|
885
|
+
"$ref": "Empty"
|
|
886
|
+
},
|
|
887
|
+
"scopes": [
|
|
888
|
+
"https://www.googleapis.com/auth/chat.messages",
|
|
889
|
+
"https://www.googleapis.com/auth/chat.messages.reactions"
|
|
890
|
+
]
|
|
891
|
+
},
|
|
892
|
+
"list": {
|
|
893
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview): Lists reactions to a message. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and `chat.messages`, `chat.messages.readonly`, `chat.messages.reactions`, or `chat.messages.reactions.readonly` scope.",
|
|
894
|
+
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions",
|
|
895
|
+
"httpMethod": "GET",
|
|
896
|
+
"id": "chat.spaces.messages.reactions.list",
|
|
897
|
+
"parameterOrder": [
|
|
898
|
+
"parent"
|
|
899
|
+
],
|
|
900
|
+
"parameters": {
|
|
901
|
+
"filter": {
|
|
902
|
+
"description": "Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = \"\ud83d\ude42\" OR emoji.unicode = \"\ud83d\udc4d\"` and `user.name = \"users/AAAAAA\" OR user.name = \"users/BBBBBB\"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = \"\ud83d\ude42\" AND user.name = \"users/AAAAAA\"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = \"users/{user}\" emoji.unicode = \"\ud83d\ude42\" emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"\ud83d\ude42\" OR emoji.unicode = \"\ud83d\udc4d\" emoji.unicode = \"\ud83d\ude42\" OR emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"\ud83d\ude42\" AND user.name = \"users/{user}\" (emoji.unicode = \"\ud83d\ude42\" OR emoji.custom_emoji.uid = \"{uid}\") AND user.name = \"users/{user}\" ``` The following queries are invalid: ``` emoji.unicode = \"\ud83d\ude42\" AND emoji.unicode = \"\ud83d\udc4d\" emoji.unicode = \"\ud83d\ude42\" AND emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"\ud83d\ude42\" OR user.name = \"users/{user}\" emoji.unicode = \"\ud83d\ude42\" OR emoji.custom_emoji.uid = \"{uid}\" OR user.name = \"users/{user}\" emoji.unicode = \"\ud83d\ude42\" OR emoji.custom_emoji.uid = \"{uid}\" AND user.name = \"users/{user}\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.",
|
|
903
|
+
"location": "query",
|
|
904
|
+
"type": "string"
|
|
905
|
+
},
|
|
906
|
+
"pageSize": {
|
|
907
|
+
"description": "Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.",
|
|
908
|
+
"format": "int32",
|
|
909
|
+
"location": "query",
|
|
910
|
+
"type": "integer"
|
|
911
|
+
},
|
|
912
|
+
"pageToken": {
|
|
913
|
+
"description": "Optional. (If resuming from a previous query.) A page token received from a previous list reactions call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.",
|
|
914
|
+
"location": "query",
|
|
915
|
+
"type": "string"
|
|
916
|
+
},
|
|
917
|
+
"parent": {
|
|
918
|
+
"description": "Required. The message users reacted to. Format: `spaces/{space}/messages/{message}`",
|
|
919
|
+
"location": "path",
|
|
920
|
+
"pattern": "^spaces/[^/]+/messages/[^/]+$",
|
|
921
|
+
"required": true,
|
|
922
|
+
"type": "string"
|
|
923
|
+
}
|
|
924
|
+
},
|
|
925
|
+
"path": "v1/{+parent}/reactions",
|
|
926
|
+
"response": {
|
|
927
|
+
"$ref": "ListReactionsResponse"
|
|
928
|
+
},
|
|
929
|
+
"scopes": [
|
|
930
|
+
"https://www.googleapis.com/auth/chat.messages",
|
|
931
|
+
"https://www.googleapis.com/auth/chat.messages.reactions",
|
|
932
|
+
"https://www.googleapis.com/auth/chat.messages.reactions.readonly",
|
|
933
|
+
"https://www.googleapis.com/auth/chat.messages.readonly"
|
|
934
|
+
]
|
|
935
|
+
}
|
|
936
|
+
}
|
|
515
937
|
}
|
|
516
938
|
}
|
|
517
939
|
}
|
|
518
940
|
}
|
|
519
941
|
}
|
|
520
942
|
},
|
|
521
|
-
"revision": "
|
|
943
|
+
"revision": "20230521",
|
|
522
944
|
"rootUrl": "https://chat.googleapis.com/",
|
|
523
945
|
"schemas": {
|
|
524
946
|
"ActionParameter": {
|
|
525
|
-
"description": "List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze
|
|
947
|
+
"description": "List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.",
|
|
526
948
|
"id": "ActionParameter",
|
|
527
949
|
"properties": {
|
|
528
950
|
"key": {
|
|
@@ -555,17 +977,17 @@
|
|
|
555
977
|
"DIALOG"
|
|
556
978
|
],
|
|
557
979
|
"enumDescriptions": [
|
|
558
|
-
"Default type
|
|
980
|
+
"Default type that's handled as `NEW_MESSAGE`.",
|
|
559
981
|
"Post as a new message in the topic.",
|
|
560
|
-
"Update the Chat app's message. This is only permitted on a CARD_CLICKED event where the message sender type is BOT
|
|
561
|
-
"Update the cards on a user's message. This is only permitted as a response to a MESSAGE event with a matched url, or a CARD_CLICKED event where the message sender type is HUMAN
|
|
562
|
-
"Privately ask the user for additional
|
|
982
|
+
"Update the Chat app's message. This is only permitted on a `CARD_CLICKED` event where the message sender type is `BOT`.",
|
|
983
|
+
"Update the cards on a user's message. This is only permitted as a response to a `MESSAGE` event with a matched url, or a `CARD_CLICKED` event where the message sender type is `HUMAN`. Text is ignored.",
|
|
984
|
+
"Privately ask the user for additional authentication or configuration.",
|
|
563
985
|
"Presents a [dialog](https://developers.google.com/chat/how-tos/dialogs)."
|
|
564
986
|
],
|
|
565
987
|
"type": "string"
|
|
566
988
|
},
|
|
567
989
|
"url": {
|
|
568
|
-
"description": "Input only. URL for users to
|
|
990
|
+
"description": "Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)",
|
|
569
991
|
"type": "string"
|
|
570
992
|
}
|
|
571
993
|
},
|
|
@@ -650,7 +1072,7 @@
|
|
|
650
1072
|
"SLASH_COMMAND"
|
|
651
1073
|
],
|
|
652
1074
|
"enumDescriptions": [
|
|
653
|
-
"Default value for the enum.
|
|
1075
|
+
"Default value for the enum. Don't use.",
|
|
654
1076
|
"A user is mentioned.",
|
|
655
1077
|
"A slash command is invoked."
|
|
656
1078
|
],
|
|
@@ -669,7 +1091,7 @@
|
|
|
669
1091
|
"properties": {
|
|
670
1092
|
"attachmentDataRef": {
|
|
671
1093
|
"$ref": "AttachmentDataRef",
|
|
672
|
-
"description": "A reference to the attachment data. This is used with the media API to download the attachment data."
|
|
1094
|
+
"description": "A reference to the attachment data. This field is used with the media API to download the attachment data."
|
|
673
1095
|
},
|
|
674
1096
|
"contentName": {
|
|
675
1097
|
"description": "The original file name for the content, not the full path.",
|
|
@@ -680,16 +1102,16 @@
|
|
|
680
1102
|
"type": "string"
|
|
681
1103
|
},
|
|
682
1104
|
"downloadUri": {
|
|
683
|
-
"description": "Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps
|
|
1105
|
+
"description": "Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content.",
|
|
684
1106
|
"readOnly": true,
|
|
685
1107
|
"type": "string"
|
|
686
1108
|
},
|
|
687
1109
|
"driveDataRef": {
|
|
688
1110
|
"$ref": "DriveDataRef",
|
|
689
|
-
"description": "A reference to the drive attachment. This is used with the Drive API."
|
|
1111
|
+
"description": "A reference to the drive attachment. This field is used with the Drive API."
|
|
690
1112
|
},
|
|
691
1113
|
"name": {
|
|
692
|
-
"description": "Resource name of the attachment, in the form
|
|
1114
|
+
"description": "Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.",
|
|
693
1115
|
"type": "string"
|
|
694
1116
|
},
|
|
695
1117
|
"source": {
|
|
@@ -707,7 +1129,7 @@
|
|
|
707
1129
|
"type": "string"
|
|
708
1130
|
},
|
|
709
1131
|
"thumbnailUri": {
|
|
710
|
-
"description": "Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps
|
|
1132
|
+
"description": "Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.",
|
|
711
1133
|
"readOnly": true,
|
|
712
1134
|
"type": "string"
|
|
713
1135
|
}
|
|
@@ -717,8 +1139,12 @@
|
|
|
717
1139
|
"AttachmentDataRef": {
|
|
718
1140
|
"id": "AttachmentDataRef",
|
|
719
1141
|
"properties": {
|
|
1142
|
+
"attachmentUploadToken": {
|
|
1143
|
+
"description": "Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
1144
|
+
"type": "string"
|
|
1145
|
+
},
|
|
720
1146
|
"resourceName": {
|
|
721
|
-
"description": "The resource name of the attachment data. This is used with the media API to download the attachment data.",
|
|
1147
|
+
"description": "The resource name of the attachment data. This field is used with the media API to download the attachment data.",
|
|
722
1148
|
"type": "string"
|
|
723
1149
|
}
|
|
724
1150
|
},
|
|
@@ -730,17 +1156,17 @@
|
|
|
730
1156
|
"properties": {
|
|
731
1157
|
"imageButton": {
|
|
732
1158
|
"$ref": "ImageButton",
|
|
733
|
-
"description": "A button with image and onclick action."
|
|
1159
|
+
"description": "A button with image and `onclick` action."
|
|
734
1160
|
},
|
|
735
1161
|
"textButton": {
|
|
736
1162
|
"$ref": "TextButton",
|
|
737
|
-
"description": "A button with text and onclick action."
|
|
1163
|
+
"description": "A button with text and `onclick` action."
|
|
738
1164
|
}
|
|
739
1165
|
},
|
|
740
1166
|
"type": "object"
|
|
741
1167
|
},
|
|
742
1168
|
"Card": {
|
|
743
|
-
"description": "A card is a UI element that can contain UI widgets such as
|
|
1169
|
+
"description": "A card is a UI element that can contain UI widgets such as text and images.",
|
|
744
1170
|
"id": "Card",
|
|
745
1171
|
"properties": {
|
|
746
1172
|
"cardActions": {
|
|
@@ -787,7 +1213,7 @@
|
|
|
787
1213
|
"id": "CardHeader",
|
|
788
1214
|
"properties": {
|
|
789
1215
|
"imageStyle": {
|
|
790
|
-
"description": "The image's type (
|
|
1216
|
+
"description": "The image's type (for example, square border or circular border).",
|
|
791
1217
|
"enum": [
|
|
792
1218
|
"IMAGE_STYLE_UNSPECIFIED",
|
|
793
1219
|
"IMAGE",
|
|
@@ -809,7 +1235,7 @@
|
|
|
809
1235
|
"type": "string"
|
|
810
1236
|
},
|
|
811
1237
|
"title": {
|
|
812
|
-
"description": "The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each
|
|
1238
|
+
"description": "The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each takes up one line. If only the title is specified, it takes up both lines.",
|
|
813
1239
|
"type": "string"
|
|
814
1240
|
}
|
|
815
1241
|
},
|
|
@@ -850,7 +1276,7 @@
|
|
|
850
1276
|
"type": "object"
|
|
851
1277
|
},
|
|
852
1278
|
"Color": {
|
|
853
|
-
"description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to
|
|
1279
|
+
"description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page does not have information about the absolute color space that should be used to interpret the RGB value\u2014for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...",
|
|
854
1280
|
"id": "Color",
|
|
855
1281
|
"properties": {
|
|
856
1282
|
"alpha": {
|
|
@@ -946,17 +1372,28 @@
|
|
|
946
1372
|
},
|
|
947
1373
|
"timeZone": {
|
|
948
1374
|
"$ref": "TimeZone",
|
|
949
|
-
"description": "The timezone ID and offset from Coordinated Universal Time (UTC)."
|
|
1375
|
+
"description": "The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG)."
|
|
950
1376
|
},
|
|
951
1377
|
"userLocale": {
|
|
952
|
-
"description": "The full `locale.displayName` in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as \"en-US\".
|
|
1378
|
+
"description": "The full `locale.displayName` in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as \"en-US\".",
|
|
1379
|
+
"type": "string"
|
|
1380
|
+
}
|
|
1381
|
+
},
|
|
1382
|
+
"type": "object"
|
|
1383
|
+
},
|
|
1384
|
+
"CustomEmoji": {
|
|
1385
|
+
"description": "Represents a custom emoji. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
1386
|
+
"id": "CustomEmoji",
|
|
1387
|
+
"properties": {
|
|
1388
|
+
"uid": {
|
|
1389
|
+
"description": "Unique key for the custom emoji resource.",
|
|
953
1390
|
"type": "string"
|
|
954
1391
|
}
|
|
955
1392
|
},
|
|
956
1393
|
"type": "object"
|
|
957
1394
|
},
|
|
958
1395
|
"DateInput": {
|
|
959
|
-
"description": "Date input values.
|
|
1396
|
+
"description": "Date input values.",
|
|
960
1397
|
"id": "DateInput",
|
|
961
1398
|
"properties": {
|
|
962
1399
|
"msSinceEpoch": {
|
|
@@ -968,7 +1405,7 @@
|
|
|
968
1405
|
"type": "object"
|
|
969
1406
|
},
|
|
970
1407
|
"DateTimeInput": {
|
|
971
|
-
"description": "Date and time input values.
|
|
1408
|
+
"description": "Date and time input values.",
|
|
972
1409
|
"id": "DateTimeInput",
|
|
973
1410
|
"properties": {
|
|
974
1411
|
"hasDate": {
|
|
@@ -987,6 +1424,35 @@
|
|
|
987
1424
|
},
|
|
988
1425
|
"type": "object"
|
|
989
1426
|
},
|
|
1427
|
+
"DeletionMetadata": {
|
|
1428
|
+
"description": "Information about a deleted message. A message is deleted when `delete_time` is set. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
1429
|
+
"id": "DeletionMetadata",
|
|
1430
|
+
"properties": {
|
|
1431
|
+
"deletionType": {
|
|
1432
|
+
"description": "Indicates who deleted the message.",
|
|
1433
|
+
"enum": [
|
|
1434
|
+
"DELETION_TYPE_UNSPECIFIED",
|
|
1435
|
+
"CREATOR",
|
|
1436
|
+
"SPACE_OWNER",
|
|
1437
|
+
"ADMIN",
|
|
1438
|
+
"APP_MESSAGE_EXPIRY",
|
|
1439
|
+
"CREATOR_VIA_APP",
|
|
1440
|
+
"SPACE_OWNER_VIA_APP"
|
|
1441
|
+
],
|
|
1442
|
+
"enumDescriptions": [
|
|
1443
|
+
"This value is unused.",
|
|
1444
|
+
"User deleted their own message.",
|
|
1445
|
+
"The space owner deleted the message.",
|
|
1446
|
+
"A Google Workspace admin deleted the message.",
|
|
1447
|
+
"A Chat app deleted its own message when it expired.",
|
|
1448
|
+
"A Chat app deleted the message on behalf of the user.",
|
|
1449
|
+
"A Chat app deleted the message on behalf of the space owner."
|
|
1450
|
+
],
|
|
1451
|
+
"type": "string"
|
|
1452
|
+
}
|
|
1453
|
+
},
|
|
1454
|
+
"type": "object"
|
|
1455
|
+
},
|
|
990
1456
|
"DeprecatedEvent": {
|
|
991
1457
|
"description": "Google Chat events.",
|
|
992
1458
|
"id": "DeprecatedEvent",
|
|
@@ -1075,7 +1541,7 @@
|
|
|
1075
1541
|
"properties": {
|
|
1076
1542
|
"body": {
|
|
1077
1543
|
"$ref": "GoogleAppsCardV1Card",
|
|
1078
|
-
"description": "Input only. Body of the dialog, which is rendered in a modal. Google Chat apps
|
|
1544
|
+
"description": "Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`."
|
|
1079
1545
|
}
|
|
1080
1546
|
},
|
|
1081
1547
|
"type": "object"
|
|
@@ -1100,12 +1566,44 @@
|
|
|
1100
1566
|
"id": "DriveDataRef",
|
|
1101
1567
|
"properties": {
|
|
1102
1568
|
"driveFileId": {
|
|
1103
|
-
"description": "The
|
|
1569
|
+
"description": "The ID for the drive file. Use with the Drive API.",
|
|
1570
|
+
"type": "string"
|
|
1571
|
+
}
|
|
1572
|
+
},
|
|
1573
|
+
"type": "object"
|
|
1574
|
+
},
|
|
1575
|
+
"Emoji": {
|
|
1576
|
+
"description": "An emoji that is used as a reaction to a message. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
1577
|
+
"id": "Emoji",
|
|
1578
|
+
"properties": {
|
|
1579
|
+
"customEmoji": {
|
|
1580
|
+
"$ref": "CustomEmoji",
|
|
1581
|
+
"description": "Output only. A custom emoji.",
|
|
1582
|
+
"readOnly": true
|
|
1583
|
+
},
|
|
1584
|
+
"unicode": {
|
|
1585
|
+
"description": "A basic emoji represented by a unicode string.",
|
|
1104
1586
|
"type": "string"
|
|
1105
1587
|
}
|
|
1106
1588
|
},
|
|
1107
1589
|
"type": "object"
|
|
1108
1590
|
},
|
|
1591
|
+
"EmojiReactionSummary": {
|
|
1592
|
+
"description": "The number of people who reacted to a message with a specific emoji. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
1593
|
+
"id": "EmojiReactionSummary",
|
|
1594
|
+
"properties": {
|
|
1595
|
+
"emoji": {
|
|
1596
|
+
"$ref": "Emoji",
|
|
1597
|
+
"description": "Emoji associated with the reactions."
|
|
1598
|
+
},
|
|
1599
|
+
"reactionCount": {
|
|
1600
|
+
"description": "The total number of reactions using the associated emoji.",
|
|
1601
|
+
"format": "int32",
|
|
1602
|
+
"type": "integer"
|
|
1603
|
+
}
|
|
1604
|
+
},
|
|
1605
|
+
"type": "object"
|
|
1606
|
+
},
|
|
1109
1607
|
"Empty": {
|
|
1110
1608
|
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
|
|
1111
1609
|
"id": "Empty",
|
|
@@ -1113,11 +1611,11 @@
|
|
|
1113
1611
|
"type": "object"
|
|
1114
1612
|
},
|
|
1115
1613
|
"FormAction": {
|
|
1116
|
-
"description": "A form action describes the behavior when the form is submitted. For example,
|
|
1614
|
+
"description": "A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.",
|
|
1117
1615
|
"id": "FormAction",
|
|
1118
1616
|
"properties": {
|
|
1119
1617
|
"actionMethodName": {
|
|
1120
|
-
"description": "The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event.
|
|
1618
|
+
"description": "The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.",
|
|
1121
1619
|
"type": "string"
|
|
1122
1620
|
},
|
|
1123
1621
|
"parameters": {
|
|
@@ -1131,7 +1629,7 @@
|
|
|
1131
1629
|
"type": "object"
|
|
1132
1630
|
},
|
|
1133
1631
|
"GoogleAppsCardV1Action": {
|
|
1134
|
-
"description": "An action that describes the behavior when the form is submitted. For example, an Apps Script
|
|
1632
|
+
"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.",
|
|
1135
1633
|
"id": "GoogleAppsCardV1Action",
|
|
1136
1634
|
"properties": {
|
|
1137
1635
|
"function": {
|
|
@@ -1139,7 +1637,7 @@
|
|
|
1139
1637
|
"type": "string"
|
|
1140
1638
|
},
|
|
1141
1639
|
"interaction": {
|
|
1142
|
-
"description": "Optional. Required when opening a [dialog](https://developers.google.com/chat/how-tos/dialogs). What to do in response to an interaction with a user, such as a user clicking button
|
|
1640
|
+
"description": "Optional. Required when opening a [dialog](https://developers.google.com/chat/how-tos/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`\u2014like opening a link or running a function\u2014as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/chat/how-tos/dialogs). When specified, a loading indicator isn't shown. Supported by Chat apps, but not Google Workspace Add-ons. If specified for an add-on, the entire card is stripped and nothing is shown in the client.",
|
|
1143
1641
|
"enum": [
|
|
1144
1642
|
"INTERACTION_UNSPECIFIED",
|
|
1145
1643
|
"OPEN_DIALOG"
|
|
@@ -1170,14 +1668,14 @@
|
|
|
1170
1668
|
"type": "array"
|
|
1171
1669
|
},
|
|
1172
1670
|
"persistValues": {
|
|
1173
|
-
"description": "Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [LoadIndicator](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/chat/api/guides/message-formats/cards) in Chat apps, you must also set the action's [ResponseType](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [LoadIndicator](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.",
|
|
1671
|
+
"description": "Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/chat/api/guides/message-formats/cards) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.",
|
|
1174
1672
|
"type": "boolean"
|
|
1175
1673
|
}
|
|
1176
1674
|
},
|
|
1177
1675
|
"type": "object"
|
|
1178
1676
|
},
|
|
1179
1677
|
"GoogleAppsCardV1ActionParameter": {
|
|
1180
|
-
"description": "List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze
|
|
1678
|
+
"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/chat/api/reference/rest/v1/Event#commoneventobject).",
|
|
1181
1679
|
"id": "GoogleAppsCardV1ActionParameter",
|
|
1182
1680
|
"properties": {
|
|
1183
1681
|
"key": {
|
|
@@ -1222,16 +1720,16 @@
|
|
|
1222
1720
|
"type": "object"
|
|
1223
1721
|
},
|
|
1224
1722
|
"GoogleAppsCardV1Button": {
|
|
1225
|
-
"description": "A text, icon, or text
|
|
1723
|
+
"description": "A text, icon, or text and icon button that users can click. To make an image a clickable button, specify an `Image` (not an `ImageComponent`) and set an `onClick` action.",
|
|
1226
1724
|
"id": "GoogleAppsCardV1Button",
|
|
1227
1725
|
"properties": {
|
|
1228
1726
|
"altText": {
|
|
1229
|
-
"description": "The alternative text used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: \"Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat\".",
|
|
1727
|
+
"description": "The alternative text that's used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: \"Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat\".",
|
|
1230
1728
|
"type": "string"
|
|
1231
1729
|
},
|
|
1232
1730
|
"color": {
|
|
1233
1731
|
"$ref": "Color",
|
|
1234
|
-
"description": "If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background
|
|
1732
|
+
"description": "If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background likely results in white text. If unset, the image background is white and the font color is blue. For red, green, and blue, the value of each field is a `float` number that you can express in either of two ways: as a number between 0 and 255 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale. Optionally set `alpha`, which sets a level of transparency using this equation: ``` pixel color = alpha * (this color) + (1.0 - alpha) * (background color) ``` For `alpha`, a value of `1` corresponds with a solid color, and a value of `0` corresponds with a completely transparent color. For example, the following color represents a half transparent red: ``` \"color\": { \"red\": 1, \"green\": 0, \"blue\": 0, \"alpha\": 0.5 } ```"
|
|
1235
1733
|
},
|
|
1236
1734
|
"disabled": {
|
|
1237
1735
|
"description": "If `true`, the button is displayed in an inactive state and doesn't respond to user actions.",
|
|
@@ -1243,7 +1741,7 @@
|
|
|
1243
1741
|
},
|
|
1244
1742
|
"onClick": {
|
|
1245
1743
|
"$ref": "GoogleAppsCardV1OnClick",
|
|
1246
|
-
"description": "Required. The action to perform when the button
|
|
1744
|
+
"description": "Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function."
|
|
1247
1745
|
},
|
|
1248
1746
|
"text": {
|
|
1249
1747
|
"description": "The text displayed inside the button.",
|
|
@@ -1267,11 +1765,11 @@
|
|
|
1267
1765
|
"type": "object"
|
|
1268
1766
|
},
|
|
1269
1767
|
"GoogleAppsCardV1Card": {
|
|
1270
|
-
"description": "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. In Google Chat, cards appear in several places: - As stand-alone messages. - Accompanying a text message, just beneath the text message. - As a [dialog](https://developers.google.com/chat/how-tos/dialogs). The following example JSON creates a \"contact card\" that features: - A header with the contact's name, job title, avatar picture. - A section with the contact information, including formatted text. - Buttons that users can click to share the contact or see more or less
|
|
1768
|
+
"description": "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. In Google Chat, cards appear in several places: - As stand-alone messages. - Accompanying a text message, just beneath the text message. - As a [dialog](https://developers.google.com/chat/how-tos/dialogs). The following example JSON creates a \"contact card\" that features: - A header with the contact's name, job title, and avatar picture. - A section with the contact information, including formatted text. - Buttons that users can click to share the contact, or see more or less information.  ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/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\", } ], } } }, ], } }, ], }, ], }, } ], } ```",
|
|
1271
1769
|
"id": "GoogleAppsCardV1Card",
|
|
1272
1770
|
"properties": {
|
|
1273
1771
|
"cardActions": {
|
|
1274
|
-
"description": "The card's actions. Actions are added to the card's toolbar menu. Because Chat app cards have no toolbar, `cardActions[]`
|
|
1772
|
+
"description": "The card's actions. Actions are added to the card's toolbar menu. Because Chat app cards have no toolbar, `cardActions[]` isn't supported by Chat apps. 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\" } } } ] ```",
|
|
1275
1773
|
"items": {
|
|
1276
1774
|
"$ref": "GoogleAppsCardV1CardAction"
|
|
1277
1775
|
},
|
|
@@ -1285,7 +1783,7 @@
|
|
|
1285
1783
|
"REPLACE"
|
|
1286
1784
|
],
|
|
1287
1785
|
"enumDescriptions": [
|
|
1288
|
-
"
|
|
1786
|
+
"Don't use.",
|
|
1289
1787
|
"The header of the card appears at the bottom of the sidebar, partially covering the current top card of the stack. Clicking the header pops the card into the card stack. If the card has no header, a generated header is used instead.",
|
|
1290
1788
|
"Default value. The card is shown by replacing the view of the top card in the card stack."
|
|
1291
1789
|
],
|
|
@@ -1293,7 +1791,7 @@
|
|
|
1293
1791
|
},
|
|
1294
1792
|
"fixedFooter": {
|
|
1295
1793
|
"$ref": "GoogleAppsCardV1CardFixedFooter",
|
|
1296
|
-
"description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Chat apps
|
|
1794
|
+
"description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/message-formats/cards)."
|
|
1297
1795
|
},
|
|
1298
1796
|
"header": {
|
|
1299
1797
|
"$ref": "GoogleAppsCardV1CardHeader",
|
|
@@ -1333,7 +1831,7 @@
|
|
|
1333
1831
|
"type": "object"
|
|
1334
1832
|
},
|
|
1335
1833
|
"GoogleAppsCardV1CardFixedFooter": {
|
|
1336
|
-
"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. Chat apps
|
|
1834
|
+
"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. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/message-formats/cards).",
|
|
1337
1835
|
"id": "GoogleAppsCardV1CardFixedFooter",
|
|
1338
1836
|
"properties": {
|
|
1339
1837
|
"primaryButton": {
|
|
@@ -1342,7 +1840,14 @@
|
|
|
1342
1840
|
},
|
|
1343
1841
|
"secondaryButton": {
|
|
1344
1842
|
"$ref": "GoogleAppsCardV1Button",
|
|
1345
|
-
"description": "The secondary button of the fixed footer. The button must be a text button with text and color set. `
|
|
1843
|
+
"description": "The secondary button of the fixed footer. The button must be a text button with text and color set. If `secondaryButton` is set, you must also set `primaryButton`."
|
|
1844
|
+
},
|
|
1845
|
+
"widgets": {
|
|
1846
|
+
"description": "A list of widgets included in the card footer. Primary button and secondary button are rendered below these widgets.",
|
|
1847
|
+
"items": {
|
|
1848
|
+
"$ref": "GoogleAppsCardV1FooterWidget"
|
|
1849
|
+
},
|
|
1850
|
+
"type": "array"
|
|
1346
1851
|
}
|
|
1347
1852
|
},
|
|
1348
1853
|
"type": "object"
|
|
@@ -1352,7 +1857,7 @@
|
|
|
1352
1857
|
"id": "GoogleAppsCardV1CardHeader",
|
|
1353
1858
|
"properties": {
|
|
1354
1859
|
"imageAltText": {
|
|
1355
|
-
"description": "The alternative text of this image
|
|
1860
|
+
"description": "The alternative text of this image that's used for accessibility.",
|
|
1356
1861
|
"type": "string"
|
|
1357
1862
|
},
|
|
1358
1863
|
"imageType": {
|
|
@@ -1382,43 +1887,117 @@
|
|
|
1382
1887
|
},
|
|
1383
1888
|
"type": "object"
|
|
1384
1889
|
},
|
|
1890
|
+
"GoogleAppsCardV1Column": {
|
|
1891
|
+
"description": "A column.",
|
|
1892
|
+
"id": "GoogleAppsCardV1Column",
|
|
1893
|
+
"properties": {
|
|
1894
|
+
"horizontalAlignment": {
|
|
1895
|
+
"description": "Specifies whether widgets align to the left, right, or center of a column.",
|
|
1896
|
+
"enum": [
|
|
1897
|
+
"HORIZONTAL_ALIGNMENT_UNSPECIFIED",
|
|
1898
|
+
"START",
|
|
1899
|
+
"CENTER",
|
|
1900
|
+
"END"
|
|
1901
|
+
],
|
|
1902
|
+
"enumDescriptions": [
|
|
1903
|
+
"Unspecified. Do not use.",
|
|
1904
|
+
"Default value. Aligns widgets to the start position of the column. For left-to-right layouts, aligns to the left. For right-to-left layouts, aligns to the right.",
|
|
1905
|
+
"Aligns widgets to the center of the column.",
|
|
1906
|
+
"Aligns widgets to the end position of the column. For left-to-right layouts, aligns widgets to the right. For right-to-left layouts, aligns widgets to the left."
|
|
1907
|
+
],
|
|
1908
|
+
"type": "string"
|
|
1909
|
+
},
|
|
1910
|
+
"horizontalSizeStyle": {
|
|
1911
|
+
"description": "Specifies how a column fills the width of the card.",
|
|
1912
|
+
"enum": [
|
|
1913
|
+
"HORIZONTAL_SIZE_STYLE_UNSPECIFIED",
|
|
1914
|
+
"FILL_AVAILABLE_SPACE",
|
|
1915
|
+
"FILL_MINIMUM_SPACE"
|
|
1916
|
+
],
|
|
1917
|
+
"enumDescriptions": [
|
|
1918
|
+
"Unspecified. Do not use.",
|
|
1919
|
+
"Default value. Column fills the available space, up to 70% of the card's width. If both columns are set to `FILL_AVAILABLE_SPACE`, each column fills 50% of the space.",
|
|
1920
|
+
"Column fills the least amount of space possible and no more than 30% of the card's width."
|
|
1921
|
+
],
|
|
1922
|
+
"type": "string"
|
|
1923
|
+
},
|
|
1924
|
+
"verticalAlignment": {
|
|
1925
|
+
"description": "Specifies whether widgets align to the top, bottom, or center of a column.",
|
|
1926
|
+
"enum": [
|
|
1927
|
+
"VERTICAL_ALIGNMENT_UNSPECIFIED",
|
|
1928
|
+
"CENTER",
|
|
1929
|
+
"TOP",
|
|
1930
|
+
"BOTTOM"
|
|
1931
|
+
],
|
|
1932
|
+
"enumDescriptions": [
|
|
1933
|
+
"Unspecified. Don't use.",
|
|
1934
|
+
"Default value. Aligns widgets to the center of a column.",
|
|
1935
|
+
"Aligns widgets to the top of a column.",
|
|
1936
|
+
"Aligns widgets to the bottom of a column."
|
|
1937
|
+
],
|
|
1938
|
+
"type": "string"
|
|
1939
|
+
},
|
|
1940
|
+
"widgets": {
|
|
1941
|
+
"description": "An array of widgets included in a column. Widgets appear in the order that they are specified.",
|
|
1942
|
+
"items": {
|
|
1943
|
+
"$ref": "GoogleAppsCardV1Widgets"
|
|
1944
|
+
},
|
|
1945
|
+
"type": "array"
|
|
1946
|
+
}
|
|
1947
|
+
},
|
|
1948
|
+
"type": "object"
|
|
1949
|
+
},
|
|
1950
|
+
"GoogleAppsCardV1Columns": {
|
|
1951
|
+
"description": "The `Columns` widget displays up to 2 columns in a card message or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. 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 2 columns, or to use rows, use the `Grid` widget. Supported by Chat apps, but not Google Workspace Add-ons.",
|
|
1952
|
+
"id": "GoogleAppsCardV1Columns",
|
|
1953
|
+
"properties": {
|
|
1954
|
+
"columnItems": {
|
|
1955
|
+
"description": "An array of columns. You can include up to 2 columns in a card or dialog.",
|
|
1956
|
+
"items": {
|
|
1957
|
+
"$ref": "GoogleAppsCardV1Column"
|
|
1958
|
+
},
|
|
1959
|
+
"type": "array"
|
|
1960
|
+
}
|
|
1961
|
+
},
|
|
1962
|
+
"type": "object"
|
|
1963
|
+
},
|
|
1385
1964
|
"GoogleAppsCardV1DateTimePicker": {
|
|
1386
|
-
"description": "Lets users
|
|
1965
|
+
"description": "Lets users input a date, a time, or both a date and a 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.",
|
|
1387
1966
|
"id": "GoogleAppsCardV1DateTimePicker",
|
|
1388
1967
|
"properties": {
|
|
1389
1968
|
"label": {
|
|
1390
|
-
"description": "The text that prompts users to
|
|
1969
|
+
"description": "The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`.",
|
|
1391
1970
|
"type": "string"
|
|
1392
1971
|
},
|
|
1393
1972
|
"name": {
|
|
1394
|
-
"description": "The name by which the
|
|
1973
|
+
"description": "The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).",
|
|
1395
1974
|
"type": "string"
|
|
1396
1975
|
},
|
|
1397
1976
|
"onChangeAction": {
|
|
1398
1977
|
"$ref": "GoogleAppsCardV1Action",
|
|
1399
|
-
"description": "Triggered when the user clicks **Save** or **Clear** from the
|
|
1978
|
+
"description": "Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface."
|
|
1400
1979
|
},
|
|
1401
1980
|
"timezoneOffsetDate": {
|
|
1402
|
-
"description": "The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If
|
|
1981
|
+
"description": "The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.",
|
|
1403
1982
|
"format": "int32",
|
|
1404
1983
|
"type": "integer"
|
|
1405
1984
|
},
|
|
1406
1985
|
"type": {
|
|
1407
|
-
"description": "
|
|
1986
|
+
"description": "Whether the widget supports inputting a date, a time, or the date and time.",
|
|
1408
1987
|
"enum": [
|
|
1409
1988
|
"DATE_AND_TIME",
|
|
1410
1989
|
"DATE_ONLY",
|
|
1411
1990
|
"TIME_ONLY"
|
|
1412
1991
|
],
|
|
1413
1992
|
"enumDescriptions": [
|
|
1414
|
-
"
|
|
1415
|
-
"
|
|
1416
|
-
"
|
|
1993
|
+
"Users input a date and time.",
|
|
1994
|
+
"Users input a date.",
|
|
1995
|
+
"Users input a time."
|
|
1417
1996
|
],
|
|
1418
1997
|
"type": "string"
|
|
1419
1998
|
},
|
|
1420
1999
|
"valueMsEpoch": {
|
|
1421
|
-
"description": "The value displayed
|
|
2000
|
+
"description": "The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).",
|
|
1422
2001
|
"format": "int64",
|
|
1423
2002
|
"type": "string"
|
|
1424
2003
|
}
|
|
@@ -1426,7 +2005,7 @@
|
|
|
1426
2005
|
"type": "object"
|
|
1427
2006
|
},
|
|
1428
2007
|
"GoogleAppsCardV1DecoratedText": {
|
|
1429
|
-
"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.",
|
|
2008
|
+
"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.",
|
|
1430
2009
|
"id": "GoogleAppsCardV1DecoratedText",
|
|
1431
2010
|
"properties": {
|
|
1432
2011
|
"bottomLabel": {
|
|
@@ -1435,7 +2014,7 @@
|
|
|
1435
2014
|
},
|
|
1436
2015
|
"button": {
|
|
1437
2016
|
"$ref": "GoogleAppsCardV1Button",
|
|
1438
|
-
"description": "A button that can
|
|
2017
|
+
"description": "A button that a user can click to trigger an action."
|
|
1439
2018
|
},
|
|
1440
2019
|
"endIcon": {
|
|
1441
2020
|
"$ref": "GoogleAppsCardV1Icon",
|
|
@@ -1447,7 +2026,7 @@
|
|
|
1447
2026
|
},
|
|
1448
2027
|
"onClick": {
|
|
1449
2028
|
"$ref": "GoogleAppsCardV1OnClick",
|
|
1450
|
-
"description": "
|
|
2029
|
+
"description": "This action is triggered when users click `topLabel` or `bottomLabel`."
|
|
1451
2030
|
},
|
|
1452
2031
|
"startIcon": {
|
|
1453
2032
|
"$ref": "GoogleAppsCardV1Icon",
|
|
@@ -1455,10 +2034,10 @@
|
|
|
1455
2034
|
},
|
|
1456
2035
|
"switchControl": {
|
|
1457
2036
|
"$ref": "GoogleAppsCardV1SwitchControl",
|
|
1458
|
-
"description": "A switch widget can
|
|
2037
|
+
"description": "A switch widget that a user can click to change its state and trigger an action."
|
|
1459
2038
|
},
|
|
1460
2039
|
"text": {
|
|
1461
|
-
"description": "Required. The primary text. Supports simple formatting.
|
|
2040
|
+
"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/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
1462
2041
|
"type": "string"
|
|
1463
2042
|
},
|
|
1464
2043
|
"topLabel": {
|
|
@@ -1473,13 +2052,40 @@
|
|
|
1473
2052
|
"type": "object"
|
|
1474
2053
|
},
|
|
1475
2054
|
"GoogleAppsCardV1Divider": {
|
|
1476
|
-
"description": "Displays a divider between widgets
|
|
2055
|
+
"description": "Displays a divider between widgets as a horizontal line. For example, the following JSON creates a divider: ``` \"divider\": {} ```",
|
|
1477
2056
|
"id": "GoogleAppsCardV1Divider",
|
|
1478
2057
|
"properties": {},
|
|
1479
2058
|
"type": "object"
|
|
1480
2059
|
},
|
|
2060
|
+
"GoogleAppsCardV1FooterWidget": {
|
|
2061
|
+
"description": "The CardFixedFooter can contain a list of these widgets.",
|
|
2062
|
+
"id": "GoogleAppsCardV1FooterWidget",
|
|
2063
|
+
"properties": {
|
|
2064
|
+
"buttonList": {
|
|
2065
|
+
"$ref": "GoogleAppsCardV1ButtonList",
|
|
2066
|
+
"description": "ButtonList widget."
|
|
2067
|
+
},
|
|
2068
|
+
"dateTimePicker": {
|
|
2069
|
+
"$ref": "GoogleAppsCardV1DateTimePicker",
|
|
2070
|
+
"description": "DateTimePicker widget."
|
|
2071
|
+
},
|
|
2072
|
+
"decoratedText": {
|
|
2073
|
+
"$ref": "GoogleAppsCardV1DecoratedText",
|
|
2074
|
+
"description": "DecoratedText widget."
|
|
2075
|
+
},
|
|
2076
|
+
"textInput": {
|
|
2077
|
+
"$ref": "GoogleAppsCardV1TextInput",
|
|
2078
|
+
"description": "TextInput widget."
|
|
2079
|
+
},
|
|
2080
|
+
"textParagraph": {
|
|
2081
|
+
"$ref": "GoogleAppsCardV1TextParagraph",
|
|
2082
|
+
"description": "TextParagraph widget."
|
|
2083
|
+
}
|
|
2084
|
+
},
|
|
2085
|
+
"type": "object"
|
|
2086
|
+
},
|
|
1481
2087
|
"GoogleAppsCardV1Grid": {
|
|
1482
|
-
"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 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. 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\" } } } ```",
|
|
2088
|
+
"description": "Displays a grid with a collection of items. Items can only include text or images. 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. For responsive columns, or to include more than text or images, use `Columns`. 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\" } } } ```",
|
|
1483
2089
|
"id": "GoogleAppsCardV1Grid",
|
|
1484
2090
|
"properties": {
|
|
1485
2091
|
"borderStyle": {
|
|
@@ -1510,11 +2116,11 @@
|
|
|
1510
2116
|
"type": "object"
|
|
1511
2117
|
},
|
|
1512
2118
|
"GoogleAppsCardV1GridItem": {
|
|
1513
|
-
"description": "Represents
|
|
2119
|
+
"description": "Represents an item in a grid layout. Items can contain text, an image, or both text and an image.",
|
|
1514
2120
|
"id": "GoogleAppsCardV1GridItem",
|
|
1515
2121
|
"properties": {
|
|
1516
2122
|
"id": {
|
|
1517
|
-
"description": "A user-specified identifier for this grid item. This identifier is returned in the parent
|
|
2123
|
+
"description": "A user-specified identifier for this grid item. This identifier is returned in the parent grid's `onClick` callback parameters.",
|
|
1518
2124
|
"type": "string"
|
|
1519
2125
|
},
|
|
1520
2126
|
"image": {
|
|
@@ -1551,7 +2157,7 @@
|
|
|
1551
2157
|
"id": "GoogleAppsCardV1Icon",
|
|
1552
2158
|
"properties": {
|
|
1553
2159
|
"altText": {
|
|
1554
|
-
"description": "Optional. A description of the icon used for accessibility. If unspecified, the default value
|
|
2160
|
+
"description": "Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.",
|
|
1555
2161
|
"type": "string"
|
|
1556
2162
|
},
|
|
1557
2163
|
"iconUrl": {
|
|
@@ -1582,16 +2188,16 @@
|
|
|
1582
2188
|
"id": "GoogleAppsCardV1Image",
|
|
1583
2189
|
"properties": {
|
|
1584
2190
|
"altText": {
|
|
1585
|
-
"description": "The alternative text of this image
|
|
2191
|
+
"description": "The alternative text of this image that's used for accessibility.",
|
|
1586
2192
|
"type": "string"
|
|
1587
2193
|
},
|
|
1588
2194
|
"imageUrl": {
|
|
1589
|
-
"description": "The
|
|
2195
|
+
"description": "The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/chat/images/quickstart-app-avatar.png ```",
|
|
1590
2196
|
"type": "string"
|
|
1591
2197
|
},
|
|
1592
2198
|
"onClick": {
|
|
1593
2199
|
"$ref": "GoogleAppsCardV1OnClick",
|
|
1594
|
-
"description": "When a user clicks
|
|
2200
|
+
"description": "When a user clicks the image, the click triggers this action."
|
|
1595
2201
|
}
|
|
1596
2202
|
},
|
|
1597
2203
|
"type": "object"
|
|
@@ -1620,11 +2226,11 @@
|
|
|
1620
2226
|
"type": "object"
|
|
1621
2227
|
},
|
|
1622
2228
|
"GoogleAppsCardV1ImageCropStyle": {
|
|
1623
|
-
"description": "Represents the crop style applied to an image. For example, here's how to apply a 16
|
|
2229
|
+
"description": "Represents the crop style applied to an image. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```",
|
|
1624
2230
|
"id": "GoogleAppsCardV1ImageCropStyle",
|
|
1625
2231
|
"properties": {
|
|
1626
2232
|
"aspectRatio": {
|
|
1627
|
-
"description": "The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16
|
|
2233
|
+
"description": "The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```",
|
|
1628
2234
|
"format": "double",
|
|
1629
2235
|
"type": "number"
|
|
1630
2236
|
},
|
|
@@ -1638,7 +2244,7 @@
|
|
|
1638
2244
|
"RECTANGLE_4_3"
|
|
1639
2245
|
],
|
|
1640
2246
|
"enumDescriptions": [
|
|
1641
|
-
"No value specified.
|
|
2247
|
+
"No value specified. Don't use.",
|
|
1642
2248
|
"Default value. Applies a square crop.",
|
|
1643
2249
|
"Applies a circular crop.",
|
|
1644
2250
|
"Applies a rectangular crop with a custom aspect ratio. Set the custom aspect ratio with `aspectRatio`.",
|
|
@@ -1683,8 +2289,8 @@
|
|
|
1683
2289
|
"RELOAD"
|
|
1684
2290
|
],
|
|
1685
2291
|
"enumDescriptions": [
|
|
1686
|
-
"Default value. The card
|
|
1687
|
-
"Reloads the card after the child window closes. If used in conjunction with [OpenAs.OVERLAY](https://developers.google.com/workspace/add-ons/reference/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."
|
|
2292
|
+
"Default value. The card doesn't reload; nothing happens.",
|
|
2293
|
+
"Reloads the card after the child window closes. If used in conjunction with [`OpenAs.OVERLAY`](https://developers.google.com/workspace/add-ons/reference/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."
|
|
1688
2294
|
],
|
|
1689
2295
|
"type": "string"
|
|
1690
2296
|
},
|
|
@@ -1695,7 +2301,7 @@
|
|
|
1695
2301
|
"OVERLAY"
|
|
1696
2302
|
],
|
|
1697
2303
|
"enumDescriptions": [
|
|
1698
|
-
"The link opens as a full
|
|
2304
|
+
"The link opens as a full-size window (if that's the frame used by the client).",
|
|
1699
2305
|
"The link opens as an overlay, such as a pop-up."
|
|
1700
2306
|
],
|
|
1701
2307
|
"type": "string"
|
|
@@ -1708,7 +2314,7 @@
|
|
|
1708
2314
|
"type": "object"
|
|
1709
2315
|
},
|
|
1710
2316
|
"GoogleAppsCardV1Section": {
|
|
1711
|
-
"description": "A section contains a collection of widgets that are rendered vertically in the order that they
|
|
2317
|
+
"description": "A section contains a collection of widgets that are rendered vertically in the order that they're specified.",
|
|
1712
2318
|
"id": "GoogleAppsCardV1Section",
|
|
1713
2319
|
"properties": {
|
|
1714
2320
|
"collapsible": {
|
|
@@ -1716,7 +2322,7 @@
|
|
|
1716
2322
|
"type": "boolean"
|
|
1717
2323
|
},
|
|
1718
2324
|
"header": {
|
|
1719
|
-
"description": "Text that appears at the top of a section. Supports
|
|
2325
|
+
"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/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
1720
2326
|
"type": "string"
|
|
1721
2327
|
},
|
|
1722
2328
|
"uncollapsibleWidgetsCount": {
|
|
@@ -1725,7 +2331,7 @@
|
|
|
1725
2331
|
"type": "integer"
|
|
1726
2332
|
},
|
|
1727
2333
|
"widgets": {
|
|
1728
|
-
"description": "All the widgets in the section. Must contain at least
|
|
2334
|
+
"description": "All the widgets in the section. Must contain at least one widget.",
|
|
1729
2335
|
"items": {
|
|
1730
2336
|
"$ref": "GoogleAppsCardV1Widget"
|
|
1731
2337
|
},
|
|
@@ -1735,11 +2341,11 @@
|
|
|
1735
2341
|
"type": "object"
|
|
1736
2342
|
},
|
|
1737
2343
|
"GoogleAppsCardV1SelectionInput": {
|
|
1738
|
-
"description": "A widget that creates
|
|
2344
|
+
"description": "A widget that creates one or more UI items that users can select. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. 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/chat/how-tos/dialogs#receive_form_data_from_dialogs). To collect undefined or abstract data from users, use the TextInput widget.",
|
|
1739
2345
|
"id": "GoogleAppsCardV1SelectionInput",
|
|
1740
2346
|
"properties": {
|
|
1741
2347
|
"items": {
|
|
1742
|
-
"description": "An array of
|
|
2348
|
+
"description": "An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.",
|
|
1743
2349
|
"items": {
|
|
1744
2350
|
"$ref": "GoogleAppsCardV1SelectionItem"
|
|
1745
2351
|
},
|
|
@@ -1750,7 +2356,7 @@
|
|
|
1750
2356
|
"type": "string"
|
|
1751
2357
|
},
|
|
1752
2358
|
"name": {
|
|
1753
|
-
"description": "The name
|
|
2359
|
+
"description": "The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).",
|
|
1754
2360
|
"type": "string"
|
|
1755
2361
|
},
|
|
1756
2362
|
"onChangeAction": {
|
|
@@ -1758,7 +2364,7 @@
|
|
|
1758
2364
|
"description": "If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs)."
|
|
1759
2365
|
},
|
|
1760
2366
|
"type": {
|
|
1761
|
-
"description": "The
|
|
2367
|
+
"description": "The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.",
|
|
1762
2368
|
"enum": [
|
|
1763
2369
|
"CHECK_BOX",
|
|
1764
2370
|
"RADIO_BUTTON",
|
|
@@ -1766,10 +2372,10 @@
|
|
|
1766
2372
|
"DROPDOWN"
|
|
1767
2373
|
],
|
|
1768
2374
|
"enumDescriptions": [
|
|
1769
|
-
"A set of checkboxes. Users can select
|
|
1770
|
-
"A set of radio buttons. Users can select one radio button
|
|
1771
|
-
"A set of switches. Users can turn on
|
|
1772
|
-
"A dropdown menu. Users can select one
|
|
2375
|
+
"A set of checkboxes. Users can select one or more checkboxes.",
|
|
2376
|
+
"A set of radio buttons. Users can select one radio button.",
|
|
2377
|
+
"A set of switches. Users can turn on one or more switches.",
|
|
2378
|
+
"A dropdown menu. Users can select one item from the menu."
|
|
1773
2379
|
],
|
|
1774
2380
|
"type": "string"
|
|
1775
2381
|
}
|
|
@@ -1777,7 +2383,7 @@
|
|
|
1777
2383
|
"type": "object"
|
|
1778
2384
|
},
|
|
1779
2385
|
"GoogleAppsCardV1SelectionItem": {
|
|
1780
|
-
"description": "
|
|
2386
|
+
"description": "An item that users can select in a selection input, such as a checkbox or switch.",
|
|
1781
2387
|
"id": "GoogleAppsCardV1SelectionItem",
|
|
1782
2388
|
"properties": {
|
|
1783
2389
|
"selected": {
|
|
@@ -1785,7 +2391,7 @@
|
|
|
1785
2391
|
"type": "boolean"
|
|
1786
2392
|
},
|
|
1787
2393
|
"text": {
|
|
1788
|
-
"description": "The text
|
|
2394
|
+
"description": "The text that identifies or describes the item to users.",
|
|
1789
2395
|
"type": "string"
|
|
1790
2396
|
},
|
|
1791
2397
|
"value": {
|
|
@@ -1800,14 +2406,14 @@
|
|
|
1800
2406
|
"id": "GoogleAppsCardV1SuggestionItem",
|
|
1801
2407
|
"properties": {
|
|
1802
2408
|
"text": {
|
|
1803
|
-
"description": "The value of a suggested input to a text input field. This is equivalent to what users
|
|
2409
|
+
"description": "The value of a suggested input to a text input field. This is equivalent to what users enter themselves.",
|
|
1804
2410
|
"type": "string"
|
|
1805
2411
|
}
|
|
1806
2412
|
},
|
|
1807
2413
|
"type": "object"
|
|
1808
2414
|
},
|
|
1809
2415
|
"GoogleAppsCardV1Suggestions": {
|
|
1810
|
-
"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
|
|
2416
|
+
"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`.",
|
|
1811
2417
|
"id": "GoogleAppsCardV1Suggestions",
|
|
1812
2418
|
"properties": {
|
|
1813
2419
|
"items": {
|
|
@@ -1821,7 +2427,7 @@
|
|
|
1821
2427
|
"type": "object"
|
|
1822
2428
|
},
|
|
1823
2429
|
"GoogleAppsCardV1SwitchControl": {
|
|
1824
|
-
"description": "Either a toggle-style switch or a checkbox inside a `decoratedText` widget. Only supported
|
|
2430
|
+
"description": "Either a toggle-style switch or a checkbox inside a `decoratedText` widget. Only supported in the `decoratedText` widget.",
|
|
1825
2431
|
"id": "GoogleAppsCardV1SwitchControl",
|
|
1826
2432
|
"properties": {
|
|
1827
2433
|
"controlType": {
|
|
@@ -1858,7 +2464,7 @@
|
|
|
1858
2464
|
"type": "object"
|
|
1859
2465
|
},
|
|
1860
2466
|
"GoogleAppsCardV1TextInput": {
|
|
1861
|
-
"description": "A field in which users can enter text. Supports suggestions and on-change actions. 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/chat/how-tos/dialogs#receive_form_data_from_dialogs). When you need to collect abstract data from users, use a text input. To collect defined data from users, use the
|
|
2467
|
+
"description": "A field in which users can enter text. Supports suggestions and on-change actions. 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/chat/how-tos/dialogs#receive_form_data_from_dialogs). 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.",
|
|
1862
2468
|
"id": "GoogleAppsCardV1TextInput",
|
|
1863
2469
|
"properties": {
|
|
1864
2470
|
"autoCompleteAction": {
|
|
@@ -1871,10 +2477,10 @@
|
|
|
1871
2477
|
},
|
|
1872
2478
|
"initialSuggestions": {
|
|
1873
2479
|
"$ref": "GoogleAppsCardV1Suggestions",
|
|
1874
|
-
"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
|
|
2480
|
+
"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`."
|
|
1875
2481
|
},
|
|
1876
2482
|
"label": {
|
|
1877
|
-
"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
|
|
2483
|
+
"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.",
|
|
1878
2484
|
"type": "string"
|
|
1879
2485
|
},
|
|
1880
2486
|
"name": {
|
|
@@ -1883,7 +2489,7 @@
|
|
|
1883
2489
|
},
|
|
1884
2490
|
"onChangeAction": {
|
|
1885
2491
|
"$ref": "GoogleAppsCardV1Action",
|
|
1886
|
-
"description": "What to do when a change occurs in the text input field.
|
|
2492
|
+
"description": "What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/chat/how-tos/dialogs) in Google Chat."
|
|
1887
2493
|
},
|
|
1888
2494
|
"type": {
|
|
1889
2495
|
"description": "How a text input field appears in the user interface. For example, whether the field is single or multi-line.",
|
|
@@ -1905,7 +2511,7 @@
|
|
|
1905
2511
|
"type": "object"
|
|
1906
2512
|
},
|
|
1907
2513
|
"GoogleAppsCardV1TextParagraph": {
|
|
1908
|
-
"description": "A paragraph of text that supports formatting.
|
|
2514
|
+
"description": "A paragraph of text that supports formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
1909
2515
|
"id": "GoogleAppsCardV1TextParagraph",
|
|
1910
2516
|
"properties": {
|
|
1911
2517
|
"text": {
|
|
@@ -1923,9 +2529,13 @@
|
|
|
1923
2529
|
"$ref": "GoogleAppsCardV1ButtonList",
|
|
1924
2530
|
"description": "A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` \"buttonList\": { \"buttons\": [ { \"text\": \"Edit\", \"color\": { \"red\": 0, \"green\": 0, \"blue\": 1, \"alpha\": 1 }, \"disabled\": true, }, { \"icon\": { \"knownIcon\": \"INVITE\", \"altText\": \"check calendar\" }, \"onClick\": { \"openLink\": { \"url\": \"https://example.com/calendar\" } } } ] } ```"
|
|
1925
2531
|
},
|
|
2532
|
+
"columns": {
|
|
2533
|
+
"$ref": "GoogleAppsCardV1Columns",
|
|
2534
|
+
"description": "Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` \"columns\": { \"columnItems\": [ { \"horizontalSizeStyle\": \"FILL_AVAILABLE_SPACE\", \"horizontalAlignment\": \"CENTER\", \"verticalAlignment\": \"CENTER\", \"widgets\": [ { \"textParagraph\": { \"text\": \"First column text paragraph\" } } ] }, { \"horizontalSizeStyle\": \"FILL_AVAILABLE_SPACE\", \"horizontalAlignment\": \"CENTER\", \"verticalAlignment\": \"CENTER\", \"widgets\": [ { \"textParagraph\": { \"text\": \"Second column text paragraph\" } } ] } ] } ```"
|
|
2535
|
+
},
|
|
1926
2536
|
"dateTimePicker": {
|
|
1927
2537
|
"$ref": "GoogleAppsCardV1DateTimePicker",
|
|
1928
|
-
"description": "Displays a
|
|
2538
|
+
"description": "Displays a widget that lets users input a date, time, or date and time. For example, the following JSON creates a date time picker to schedule an appointment: ``` \"dateTimePicker\": { \"name\": \"appointment_time\", \"label\": \"Book your appointment at:\", \"type\": \"DATE_AND_TIME\", \"valueMsEpoch\": \"796435200000\" } ```"
|
|
1929
2539
|
},
|
|
1930
2540
|
"decoratedText": {
|
|
1931
2541
|
"$ref": "GoogleAppsCardV1DecoratedText",
|
|
@@ -1939,13 +2549,29 @@
|
|
|
1939
2549
|
"$ref": "GoogleAppsCardV1Grid",
|
|
1940
2550
|
"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. 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\" } } } ```"
|
|
1941
2551
|
},
|
|
2552
|
+
"horizontalAlignment": {
|
|
2553
|
+
"description": "Specifies whether widgets align to the left, right, or center of a column.",
|
|
2554
|
+
"enum": [
|
|
2555
|
+
"HORIZONTAL_ALIGNMENT_UNSPECIFIED",
|
|
2556
|
+
"START",
|
|
2557
|
+
"CENTER",
|
|
2558
|
+
"END"
|
|
2559
|
+
],
|
|
2560
|
+
"enumDescriptions": [
|
|
2561
|
+
"Unspecified. Do not use.",
|
|
2562
|
+
"Default value. Aligns widgets to the start position of the column. For left-to-right layouts, aligns to the left. For right-to-left layouts, aligns to the right.",
|
|
2563
|
+
"Aligns widgets to the center of the column.",
|
|
2564
|
+
"Aligns widgets to the end position of the column. For left-to-right layouts, aligns widgets to the right. For right-to-left layouts, aligns widgets to the left."
|
|
2565
|
+
],
|
|
2566
|
+
"type": "string"
|
|
2567
|
+
},
|
|
1942
2568
|
"image": {
|
|
1943
2569
|
"$ref": "GoogleAppsCardV1Image",
|
|
1944
2570
|
"description": "Displays an image. For example, the following JSON creates an image with alternative text: ``` \"image\": { \"imageUrl\": \"https://developers.google.com/chat/images/quickstart-app-avatar.png\", \"altText\": \"Chat app avatar\" } ```"
|
|
1945
2571
|
},
|
|
1946
2572
|
"selectionInput": {
|
|
1947
2573
|
"$ref": "GoogleAppsCardV1SelectionInput",
|
|
1948
|
-
"description": "Displays a selection control that lets users select items. Selection controls can be
|
|
2574
|
+
"description": "Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` \"selectionInput\": { \"name\": \"size\", \"label\": \"Size\" \"type\": \"DROPDOWN\", \"items\": [ { \"text\": \"S\", \"value\": \"small\", \"selected\": false }, { \"text\": \"M\", \"value\": \"medium\", \"selected\": true }, { \"text\": \"L\", \"value\": \"large\", \"selected\": false }, { \"text\": \"XL\", \"value\": \"extra_large\", \"selected\": false } ] } ```"
|
|
1949
2575
|
},
|
|
1950
2576
|
"textInput": {
|
|
1951
2577
|
"$ref": "GoogleAppsCardV1TextInput",
|
|
@@ -1953,17 +2579,52 @@
|
|
|
1953
2579
|
},
|
|
1954
2580
|
"textParagraph": {
|
|
1955
2581
|
"$ref": "GoogleAppsCardV1TextParagraph",
|
|
1956
|
-
"description": "Displays a text paragraph. Supports
|
|
2582
|
+
"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/chat/api/guides/message-formats/cards#card_text_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*\" } ```"
|
|
2583
|
+
}
|
|
2584
|
+
},
|
|
2585
|
+
"type": "object"
|
|
2586
|
+
},
|
|
2587
|
+
"GoogleAppsCardV1Widgets": {
|
|
2588
|
+
"description": "The supported widgets that you can include in a column.",
|
|
2589
|
+
"id": "GoogleAppsCardV1Widgets",
|
|
2590
|
+
"properties": {
|
|
2591
|
+
"buttonList": {
|
|
2592
|
+
"$ref": "GoogleAppsCardV1ButtonList",
|
|
2593
|
+
"description": "ButtonList widget."
|
|
2594
|
+
},
|
|
2595
|
+
"dateTimePicker": {
|
|
2596
|
+
"$ref": "GoogleAppsCardV1DateTimePicker",
|
|
2597
|
+
"description": "DateTimePicker widget."
|
|
2598
|
+
},
|
|
2599
|
+
"decoratedText": {
|
|
2600
|
+
"$ref": "GoogleAppsCardV1DecoratedText",
|
|
2601
|
+
"description": "DecoratedText widget."
|
|
2602
|
+
},
|
|
2603
|
+
"image": {
|
|
2604
|
+
"$ref": "GoogleAppsCardV1Image",
|
|
2605
|
+
"description": "Image widget."
|
|
2606
|
+
},
|
|
2607
|
+
"selectionInput": {
|
|
2608
|
+
"$ref": "GoogleAppsCardV1SelectionInput",
|
|
2609
|
+
"description": "SelectionInput widget."
|
|
2610
|
+
},
|
|
2611
|
+
"textInput": {
|
|
2612
|
+
"$ref": "GoogleAppsCardV1TextInput",
|
|
2613
|
+
"description": "TextInput widget."
|
|
2614
|
+
},
|
|
2615
|
+
"textParagraph": {
|
|
2616
|
+
"$ref": "GoogleAppsCardV1TextParagraph",
|
|
2617
|
+
"description": "TextParagraph widget."
|
|
1957
2618
|
}
|
|
1958
2619
|
},
|
|
1959
2620
|
"type": "object"
|
|
1960
2621
|
},
|
|
1961
2622
|
"Image": {
|
|
1962
|
-
"description": "An image that
|
|
2623
|
+
"description": "An image that's specified by a URL and can have an `onclick` action.",
|
|
1963
2624
|
"id": "Image",
|
|
1964
2625
|
"properties": {
|
|
1965
2626
|
"aspectRatio": {
|
|
1966
|
-
"description": "The aspect ratio of this image (width
|
|
2627
|
+
"description": "The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.",
|
|
1967
2628
|
"format": "double",
|
|
1968
2629
|
"type": "number"
|
|
1969
2630
|
},
|
|
@@ -1973,17 +2634,17 @@
|
|
|
1973
2634
|
},
|
|
1974
2635
|
"onClick": {
|
|
1975
2636
|
"$ref": "OnClick",
|
|
1976
|
-
"description": "The onclick action."
|
|
2637
|
+
"description": "The `onclick` action."
|
|
1977
2638
|
}
|
|
1978
2639
|
},
|
|
1979
2640
|
"type": "object"
|
|
1980
2641
|
},
|
|
1981
2642
|
"ImageButton": {
|
|
1982
|
-
"description": "An image button with an onclick action.",
|
|
2643
|
+
"description": "An image button with an `onclick` action.",
|
|
1983
2644
|
"id": "ImageButton",
|
|
1984
2645
|
"properties": {
|
|
1985
2646
|
"icon": {
|
|
1986
|
-
"description": "The icon specified by an enum that indices to an icon provided by Chat API.",
|
|
2647
|
+
"description": "The icon specified by an `enum` that indices to an icon provided by Chat API.",
|
|
1987
2648
|
"enum": [
|
|
1988
2649
|
"ICON_UNSPECIFIED",
|
|
1989
2650
|
"AIRPLANE",
|
|
@@ -2057,12 +2718,12 @@
|
|
|
2057
2718
|
"type": "string"
|
|
2058
2719
|
},
|
|
2059
2720
|
"name": {
|
|
2060
|
-
"description": "The name of this image_button
|
|
2721
|
+
"description": "The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified.",
|
|
2061
2722
|
"type": "string"
|
|
2062
2723
|
},
|
|
2063
2724
|
"onClick": {
|
|
2064
2725
|
"$ref": "OnClick",
|
|
2065
|
-
"description": "The onclick action."
|
|
2726
|
+
"description": "The `onclick` action."
|
|
2066
2727
|
}
|
|
2067
2728
|
},
|
|
2068
2729
|
"type": "object"
|
|
@@ -2073,11 +2734,11 @@
|
|
|
2073
2734
|
"properties": {
|
|
2074
2735
|
"dateInput": {
|
|
2075
2736
|
"$ref": "DateInput",
|
|
2076
|
-
"description": "Date input values.
|
|
2737
|
+
"description": "Date input values."
|
|
2077
2738
|
},
|
|
2078
2739
|
"dateTimeInput": {
|
|
2079
2740
|
"$ref": "DateTimeInput",
|
|
2080
|
-
"description": "Date and time input values.
|
|
2741
|
+
"description": "Date and time input values."
|
|
2081
2742
|
},
|
|
2082
2743
|
"stringInputs": {
|
|
2083
2744
|
"$ref": "StringInputs",
|
|
@@ -2085,17 +2746,17 @@
|
|
|
2085
2746
|
},
|
|
2086
2747
|
"timeInput": {
|
|
2087
2748
|
"$ref": "TimeInput",
|
|
2088
|
-
"description": "Time input values.
|
|
2749
|
+
"description": "Time input values."
|
|
2089
2750
|
}
|
|
2090
2751
|
},
|
|
2091
2752
|
"type": "object"
|
|
2092
2753
|
},
|
|
2093
2754
|
"KeyValue": {
|
|
2094
|
-
"description": "A UI element contains a key (label) and a value (content).
|
|
2755
|
+
"description": "A UI element contains a key (label) and a value (content). This element can also contain some actions such as `onclick` button.",
|
|
2095
2756
|
"id": "KeyValue",
|
|
2096
2757
|
"properties": {
|
|
2097
2758
|
"bottomLabel": {
|
|
2098
|
-
"description": "The text of the bottom label. Formatted text supported.",
|
|
2759
|
+
"description": "The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
2099
2760
|
"type": "string"
|
|
2100
2761
|
},
|
|
2101
2762
|
"button": {
|
|
@@ -2103,7 +2764,7 @@
|
|
|
2103
2764
|
"description": "A button that can be clicked to trigger an action."
|
|
2104
2765
|
},
|
|
2105
2766
|
"content": {
|
|
2106
|
-
"description": "The text of the content. Formatted text supported and always required.",
|
|
2767
|
+
"description": "The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
2107
2768
|
"type": "string"
|
|
2108
2769
|
},
|
|
2109
2770
|
"contentMultiline": {
|
|
@@ -2111,7 +2772,7 @@
|
|
|
2111
2772
|
"type": "boolean"
|
|
2112
2773
|
},
|
|
2113
2774
|
"icon": {
|
|
2114
|
-
"description": "An enum value that
|
|
2775
|
+
"description": "An enum value that's replaced by the Chat API with the corresponding icon image.",
|
|
2115
2776
|
"enum": [
|
|
2116
2777
|
"ICON_UNSPECIFIED",
|
|
2117
2778
|
"AIRPLANE",
|
|
@@ -2186,10 +2847,10 @@
|
|
|
2186
2847
|
},
|
|
2187
2848
|
"onClick": {
|
|
2188
2849
|
"$ref": "OnClick",
|
|
2189
|
-
"description": "The onclick action. Only the top label, bottom label and content region are clickable."
|
|
2850
|
+
"description": "The `onclick` action. Only the top label, bottom label, and content region are clickable."
|
|
2190
2851
|
},
|
|
2191
2852
|
"topLabel": {
|
|
2192
|
-
"description": "The text of the top label. Formatted text supported.",
|
|
2853
|
+
"description": "The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
2193
2854
|
"type": "string"
|
|
2194
2855
|
}
|
|
2195
2856
|
},
|
|
@@ -2206,17 +2867,51 @@
|
|
|
2206
2867
|
"type": "array"
|
|
2207
2868
|
},
|
|
2208
2869
|
"nextPageToken": {
|
|
2209
|
-
"description": "A token that can
|
|
2870
|
+
"description": "A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.",
|
|
2210
2871
|
"type": "string"
|
|
2211
2872
|
}
|
|
2212
2873
|
},
|
|
2213
2874
|
"type": "object"
|
|
2214
2875
|
},
|
|
2876
|
+
"ListMessagesResponse": {
|
|
2877
|
+
"id": "ListMessagesResponse",
|
|
2878
|
+
"properties": {
|
|
2879
|
+
"messages": {
|
|
2880
|
+
"description": "List of messages.",
|
|
2881
|
+
"items": {
|
|
2882
|
+
"$ref": "Message"
|
|
2883
|
+
},
|
|
2884
|
+
"type": "array"
|
|
2885
|
+
},
|
|
2886
|
+
"nextPageToken": {
|
|
2887
|
+
"description": "You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.",
|
|
2888
|
+
"type": "string"
|
|
2889
|
+
}
|
|
2890
|
+
},
|
|
2891
|
+
"type": "object"
|
|
2892
|
+
},
|
|
2893
|
+
"ListReactionsResponse": {
|
|
2894
|
+
"id": "ListReactionsResponse",
|
|
2895
|
+
"properties": {
|
|
2896
|
+
"nextPageToken": {
|
|
2897
|
+
"description": "Continuation token to retrieve the next page of results. It's empty for the last page of results.",
|
|
2898
|
+
"type": "string"
|
|
2899
|
+
},
|
|
2900
|
+
"reactions": {
|
|
2901
|
+
"description": "List of reactions in the requested (or first) page.",
|
|
2902
|
+
"items": {
|
|
2903
|
+
"$ref": "Reaction"
|
|
2904
|
+
},
|
|
2905
|
+
"type": "array"
|
|
2906
|
+
}
|
|
2907
|
+
},
|
|
2908
|
+
"type": "object"
|
|
2909
|
+
},
|
|
2215
2910
|
"ListSpacesResponse": {
|
|
2216
2911
|
"id": "ListSpacesResponse",
|
|
2217
2912
|
"properties": {
|
|
2218
2913
|
"nextPageToken": {
|
|
2219
|
-
"description": "
|
|
2914
|
+
"description": "You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.",
|
|
2220
2915
|
"type": "string"
|
|
2221
2916
|
},
|
|
2222
2917
|
"spaces": {
|
|
@@ -2230,11 +2925,11 @@
|
|
|
2230
2925
|
"type": "object"
|
|
2231
2926
|
},
|
|
2232
2927
|
"MatchedUrl": {
|
|
2233
|
-
"description": "A matched
|
|
2928
|
+
"description": "A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links).",
|
|
2234
2929
|
"id": "MatchedUrl",
|
|
2235
2930
|
"properties": {
|
|
2236
2931
|
"url": {
|
|
2237
|
-
"description": "Output only. The
|
|
2932
|
+
"description": "Output only. The URL that was matched.",
|
|
2238
2933
|
"readOnly": true,
|
|
2239
2934
|
"type": "string"
|
|
2240
2935
|
}
|
|
@@ -2264,10 +2959,10 @@
|
|
|
2264
2959
|
},
|
|
2265
2960
|
"member": {
|
|
2266
2961
|
"$ref": "User",
|
|
2267
|
-
"description": "The Google Chat user or app the membership corresponds to."
|
|
2962
|
+
"description": "The Google Chat user or app the membership corresponds to. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`."
|
|
2268
2963
|
},
|
|
2269
2964
|
"name": {
|
|
2270
|
-
"description": "Resource name of the membership, assigned by the server. Format: spaces/{space}/members/{member}",
|
|
2965
|
+
"description": "Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`",
|
|
2271
2966
|
"type": "string"
|
|
2272
2967
|
},
|
|
2273
2968
|
"role": {
|
|
@@ -2280,7 +2975,7 @@
|
|
|
2280
2975
|
"enumDescriptions": [
|
|
2281
2976
|
"Default value. The user isn't a member of the space, but might be invited.",
|
|
2282
2977
|
"A member of the space. The user has basic permissions, like sending messages to the space. In 1:1 and unnamed group conversations, everyone has this role.",
|
|
2283
|
-
"A space manager. The user has all basic permissions plus administrative permissions that
|
|
2978
|
+
"A space manager. The user has all basic permissions plus administrative permissions that let them manage the space, like adding or removing members. Only supported in SpaceType.SPACE."
|
|
2284
2979
|
],
|
|
2285
2980
|
"readOnly": true,
|
|
2286
2981
|
"type": "string"
|
|
@@ -2294,10 +2989,10 @@
|
|
|
2294
2989
|
"NOT_A_MEMBER"
|
|
2295
2990
|
],
|
|
2296
2991
|
"enumDescriptions": [
|
|
2297
|
-
"Default,
|
|
2992
|
+
"Default, don't use.",
|
|
2298
2993
|
"The user has joined the space.",
|
|
2299
|
-
"The user has been invited, is able to join the space, but currently
|
|
2300
|
-
"The user
|
|
2994
|
+
"The user has been invited, is able to join the space, but currently hasn't joined.",
|
|
2995
|
+
"The user isn't a member of the space, hasn't been invited and isn't able to join the space."
|
|
2301
2996
|
],
|
|
2302
2997
|
"readOnly": true,
|
|
2303
2998
|
"type": "string"
|
|
@@ -2314,7 +3009,7 @@
|
|
|
2314
3009
|
"description": "Input only. Parameters that a Chat app can use to configure how its response is posted."
|
|
2315
3010
|
},
|
|
2316
3011
|
"annotations": {
|
|
2317
|
-
"description": "Output only. Annotations associated with the text in this message.",
|
|
3012
|
+
"description": "Output only. Annotations associated with the `text` in this message.",
|
|
2318
3013
|
"items": {
|
|
2319
3014
|
"$ref": "Annotation"
|
|
2320
3015
|
},
|
|
@@ -2334,7 +3029,7 @@
|
|
|
2334
3029
|
"type": "array"
|
|
2335
3030
|
},
|
|
2336
3031
|
"cards": {
|
|
2337
|
-
"description": "Deprecated: Use `cards_v2` instead. Rich, formatted and interactive cards that can
|
|
3032
|
+
"description": "Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. `cards` and `cards_v2` can have a maximum size of 32 KB.",
|
|
2338
3033
|
"items": {
|
|
2339
3034
|
"$ref": "Card"
|
|
2340
3035
|
},
|
|
@@ -2352,13 +3047,32 @@
|
|
|
2352
3047
|
"type": "string"
|
|
2353
3048
|
},
|
|
2354
3049
|
"createTime": {
|
|
2355
|
-
"description": "Output only. The time at which the message was created in Google Chat
|
|
3050
|
+
"description": "Output only. The time at which the message was created in Google Chat.",
|
|
2356
3051
|
"format": "google-datetime",
|
|
2357
3052
|
"readOnly": true,
|
|
2358
3053
|
"type": "string"
|
|
2359
3054
|
},
|
|
3055
|
+
"deleteTime": {
|
|
3056
|
+
"description": "Output only. The time at which the message was deleted in Google Chat server. If the message is never deleted, this field is empty. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
3057
|
+
"format": "google-datetime",
|
|
3058
|
+
"readOnly": true,
|
|
3059
|
+
"type": "string"
|
|
3060
|
+
},
|
|
3061
|
+
"deletionMetadata": {
|
|
3062
|
+
"$ref": "DeletionMetadata",
|
|
3063
|
+
"description": "Output only. Information about a deleted message. A message is deleted when `delete_time` is set. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
3064
|
+
"readOnly": true
|
|
3065
|
+
},
|
|
3066
|
+
"emojiReactionSummaries": {
|
|
3067
|
+
"description": "Output only. The list of emoji reaction summaries on the message. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
3068
|
+
"items": {
|
|
3069
|
+
"$ref": "EmojiReactionSummary"
|
|
3070
|
+
},
|
|
3071
|
+
"readOnly": true,
|
|
3072
|
+
"type": "array"
|
|
3073
|
+
},
|
|
2360
3074
|
"fallbackText": {
|
|
2361
|
-
"description": "A plain-text description of the message's cards, used when the actual cards
|
|
3075
|
+
"description": "A plain-text description of the message's cards, used when the actual cards can't be displayed\u2014for example, mobile notifications.",
|
|
2362
3076
|
"type": "string"
|
|
2363
3077
|
},
|
|
2364
3078
|
"lastUpdateTime": {
|
|
@@ -2369,7 +3083,7 @@
|
|
|
2369
3083
|
},
|
|
2370
3084
|
"matchedUrl": {
|
|
2371
3085
|
"$ref": "MatchedUrl",
|
|
2372
|
-
"description": "Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information,
|
|
3086
|
+
"description": "Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links).",
|
|
2373
3087
|
"readOnly": true
|
|
2374
3088
|
},
|
|
2375
3089
|
"name": {
|
|
@@ -2407,16 +3121,16 @@
|
|
|
2407
3121
|
"type": "object"
|
|
2408
3122
|
},
|
|
2409
3123
|
"OnClick": {
|
|
2410
|
-
"description": "An onclick action (
|
|
3124
|
+
"description": "An `onclick` action (for example, open a link).",
|
|
2411
3125
|
"id": "OnClick",
|
|
2412
3126
|
"properties": {
|
|
2413
3127
|
"action": {
|
|
2414
3128
|
"$ref": "FormAction",
|
|
2415
|
-
"description": "A form action
|
|
3129
|
+
"description": "A form action is triggered by this `onclick` action if specified."
|
|
2416
3130
|
},
|
|
2417
3131
|
"openLink": {
|
|
2418
3132
|
"$ref": "OpenLink",
|
|
2419
|
-
"description": "This onclick triggers an open link action if specified."
|
|
3133
|
+
"description": "This `onclick` action triggers an open link action if specified."
|
|
2420
3134
|
}
|
|
2421
3135
|
},
|
|
2422
3136
|
"type": "object"
|
|
@@ -2432,16 +3146,36 @@
|
|
|
2432
3146
|
},
|
|
2433
3147
|
"type": "object"
|
|
2434
3148
|
},
|
|
3149
|
+
"Reaction": {
|
|
3150
|
+
"description": "A reaction to a message. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
3151
|
+
"id": "Reaction",
|
|
3152
|
+
"properties": {
|
|
3153
|
+
"emoji": {
|
|
3154
|
+
"$ref": "Emoji",
|
|
3155
|
+
"description": "The emoji used in the reaction."
|
|
3156
|
+
},
|
|
3157
|
+
"name": {
|
|
3158
|
+
"description": "The resource name of the reaction. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`",
|
|
3159
|
+
"type": "string"
|
|
3160
|
+
},
|
|
3161
|
+
"user": {
|
|
3162
|
+
"$ref": "User",
|
|
3163
|
+
"description": "Output only. The user who created the reaction.",
|
|
3164
|
+
"readOnly": true
|
|
3165
|
+
}
|
|
3166
|
+
},
|
|
3167
|
+
"type": "object"
|
|
3168
|
+
},
|
|
2435
3169
|
"Section": {
|
|
2436
|
-
"description": "A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there
|
|
3170
|
+
"description": "A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float).",
|
|
2437
3171
|
"id": "Section",
|
|
2438
3172
|
"properties": {
|
|
2439
3173
|
"header": {
|
|
2440
|
-
"description": "The header of the section
|
|
3174
|
+
"description": "The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
2441
3175
|
"type": "string"
|
|
2442
3176
|
},
|
|
2443
3177
|
"widgets": {
|
|
2444
|
-
"description": "A section must contain at least
|
|
3178
|
+
"description": "A section must contain at least one widget.",
|
|
2445
3179
|
"items": {
|
|
2446
3180
|
"$ref": "WidgetMarkup"
|
|
2447
3181
|
},
|
|
@@ -2450,12 +3184,34 @@
|
|
|
2450
3184
|
},
|
|
2451
3185
|
"type": "object"
|
|
2452
3186
|
},
|
|
3187
|
+
"SetUpSpaceRequest": {
|
|
3188
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview).",
|
|
3189
|
+
"id": "SetUpSpaceRequest",
|
|
3190
|
+
"properties": {
|
|
3191
|
+
"memberships": {
|
|
3192
|
+
"description": "Optional. The initial set of in-domain users invited to join the space. The calling user is automatically added to the space, and shouldn't be specified as a membership. The set currently allows up to 20 memberships (in addition to the caller). The `Membership.member` field must contain a user with `name` populated and `User.Type.HUMAN`. All other fields are ignored. Optional when setting `Space.spaceType` to `SPACE`. Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at least two memberships. Required when setting `Space.spaceType` to `DIRECT_MESSAGE` with a human user, along with exactly one membership. Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`). Not supported: Inviting guest users, or adding other Chat apps.",
|
|
3193
|
+
"items": {
|
|
3194
|
+
"$ref": "Membership"
|
|
3195
|
+
},
|
|
3196
|
+
"type": "array"
|
|
3197
|
+
},
|
|
3198
|
+
"requestId": {
|
|
3199
|
+
"description": "Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.",
|
|
3200
|
+
"type": "string"
|
|
3201
|
+
},
|
|
3202
|
+
"space": {
|
|
3203
|
+
"$ref": "Space",
|
|
3204
|
+
"description": "Required. The `Space.spaceType` field is required. To create a space, set `Space.spaceType` to `SPACE` and set `Space.displayName`. To create a group chat, set `Space.spaceType` to `GROUP_CHAT`. Don't set `Space.displayName`. To create a 1:1 conversation between humans, set `Space.spaceType` to `DIRECT_MESSAGE` and set `Space.singleUserBotDm` to `false`. Don't set `Space.displayName` or `Space.spaceDetails`. To create an 1:1 conversation between a human and the calling Chat app, set `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`. Don't set `Space.displayName` or `Space.spaceDetails`. If a `DIRECT_MESSAGE` space already exists, that space is returned instead of creating a new space."
|
|
3205
|
+
}
|
|
3206
|
+
},
|
|
3207
|
+
"type": "object"
|
|
3208
|
+
},
|
|
2453
3209
|
"SlashCommand": {
|
|
2454
3210
|
"description": "A [slash command](https://developers.google.com/chat/how-tos/slash-commands) in Google Chat.",
|
|
2455
3211
|
"id": "SlashCommand",
|
|
2456
3212
|
"properties": {
|
|
2457
3213
|
"commandId": {
|
|
2458
|
-
"description": "The
|
|
3214
|
+
"description": "The ID of the slash command invoked.",
|
|
2459
3215
|
"format": "int64",
|
|
2460
3216
|
"type": "string"
|
|
2461
3217
|
}
|
|
@@ -2471,7 +3227,7 @@
|
|
|
2471
3227
|
"description": "The Chat app whose command was invoked."
|
|
2472
3228
|
},
|
|
2473
3229
|
"commandId": {
|
|
2474
|
-
"description": "The command
|
|
3230
|
+
"description": "The command ID of the invoked slash command.",
|
|
2475
3231
|
"format": "int64",
|
|
2476
3232
|
"type": "string"
|
|
2477
3233
|
},
|
|
@@ -2480,7 +3236,7 @@
|
|
|
2480
3236
|
"type": "string"
|
|
2481
3237
|
},
|
|
2482
3238
|
"triggersDialog": {
|
|
2483
|
-
"description": "
|
|
3239
|
+
"description": "Indicates whether the slash command is for a dialog.",
|
|
2484
3240
|
"type": "boolean"
|
|
2485
3241
|
},
|
|
2486
3242
|
"type": {
|
|
@@ -2491,7 +3247,7 @@
|
|
|
2491
3247
|
"INVOKE"
|
|
2492
3248
|
],
|
|
2493
3249
|
"enumDescriptions": [
|
|
2494
|
-
"Default value for the enum.
|
|
3250
|
+
"Default value for the enum. Don't use.",
|
|
2495
3251
|
"Add Chat app to space.",
|
|
2496
3252
|
"Invoke slash command in space."
|
|
2497
3253
|
],
|
|
@@ -2510,11 +3266,11 @@
|
|
|
2510
3266
|
"type": "boolean"
|
|
2511
3267
|
},
|
|
2512
3268
|
"displayName": {
|
|
2513
|
-
"description": "The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). For direct messages, this field
|
|
3269
|
+
"description": "The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). For direct messages, this field might be empty. Supports up to 128 characters.",
|
|
2514
3270
|
"type": "string"
|
|
2515
3271
|
},
|
|
2516
3272
|
"name": {
|
|
2517
|
-
"description": "Resource name of the space. Format: spaces/{space}",
|
|
3273
|
+
"description": "Resource name of the space. Format: `spaces/{space}`",
|
|
2518
3274
|
"type": "string"
|
|
2519
3275
|
},
|
|
2520
3276
|
"singleUserBotDm": {
|
|
@@ -2525,6 +3281,20 @@
|
|
|
2525
3281
|
"$ref": "SpaceDetails",
|
|
2526
3282
|
"description": "Details about the space including description and rules."
|
|
2527
3283
|
},
|
|
3284
|
+
"spaceHistoryState": {
|
|
3285
|
+
"description": "The message history state for messages and threads in this space. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
3286
|
+
"enum": [
|
|
3287
|
+
"HISTORY_STATE_UNSPECIFIED",
|
|
3288
|
+
"HISTORY_OFF",
|
|
3289
|
+
"HISTORY_ON"
|
|
3290
|
+
],
|
|
3291
|
+
"enumDescriptions": [
|
|
3292
|
+
"Default value. Do not use.",
|
|
3293
|
+
"History off. [Messages and threads are kept for 24 hours](https://support.google.com/chat/answer/7664687).",
|
|
3294
|
+
"History on. The organization's [Vault retention rules](https://support.google.com/vault/answer/7657597) specify for how long messages and threads are kept."
|
|
3295
|
+
],
|
|
3296
|
+
"type": "string"
|
|
3297
|
+
},
|
|
2528
3298
|
"spaceThreadingState": {
|
|
2529
3299
|
"description": "Output only. The threading state in the Chat space.",
|
|
2530
3300
|
"enum": [
|
|
@@ -2542,6 +3312,22 @@
|
|
|
2542
3312
|
"readOnly": true,
|
|
2543
3313
|
"type": "string"
|
|
2544
3314
|
},
|
|
3315
|
+
"spaceType": {
|
|
3316
|
+
"description": "The type of space. Required when creating or updating a space. Output only for other usage. [Developer Preview](https://developers.google.com/workspace/preview).",
|
|
3317
|
+
"enum": [
|
|
3318
|
+
"SPACE_TYPE_UNSPECIFIED",
|
|
3319
|
+
"SPACE",
|
|
3320
|
+
"GROUP_CHAT",
|
|
3321
|
+
"DIRECT_MESSAGE"
|
|
3322
|
+
],
|
|
3323
|
+
"enumDescriptions": [
|
|
3324
|
+
"Reserved.",
|
|
3325
|
+
"A place where people send messages, share files, and collaborate. A `SPACE` can include Chat apps.",
|
|
3326
|
+
"Group conversations between 3 or more people. A `GROUP_CHAT` can include Chat apps.",
|
|
3327
|
+
"1:1 messages between two humans or a human and a Chat app."
|
|
3328
|
+
],
|
|
3329
|
+
"type": "string"
|
|
3330
|
+
},
|
|
2545
3331
|
"threaded": {
|
|
2546
3332
|
"description": "Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.",
|
|
2547
3333
|
"readOnly": true,
|
|
@@ -2557,7 +3343,7 @@
|
|
|
2557
3343
|
"enumDescriptions": [
|
|
2558
3344
|
"",
|
|
2559
3345
|
"Conversations between two or more humans.",
|
|
2560
|
-
"1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this
|
|
3346
|
+
"1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this doesn't include direct messages between two humans."
|
|
2561
3347
|
],
|
|
2562
3348
|
"readOnly": true,
|
|
2563
3349
|
"type": "string"
|
|
@@ -2570,7 +3356,7 @@
|
|
|
2570
3356
|
"id": "SpaceDetails",
|
|
2571
3357
|
"properties": {
|
|
2572
3358
|
"description": {
|
|
2573
|
-
"description": "Optional. A description of the space.
|
|
3359
|
+
"description": "Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters.",
|
|
2574
3360
|
"type": "string"
|
|
2575
3361
|
},
|
|
2576
3362
|
"guidelines": {
|
|
@@ -2622,12 +3408,12 @@
|
|
|
2622
3408
|
"type": "object"
|
|
2623
3409
|
},
|
|
2624
3410
|
"TextButton": {
|
|
2625
|
-
"description": "A button with text and onclick action.",
|
|
3411
|
+
"description": "A button with text and `onclick` action.",
|
|
2626
3412
|
"id": "TextButton",
|
|
2627
3413
|
"properties": {
|
|
2628
3414
|
"onClick": {
|
|
2629
3415
|
"$ref": "OnClick",
|
|
2630
|
-
"description": "The onclick action of the button."
|
|
3416
|
+
"description": "The `onclick` action of the button."
|
|
2631
3417
|
},
|
|
2632
3418
|
"text": {
|
|
2633
3419
|
"description": "The text of the button.",
|
|
@@ -2637,7 +3423,7 @@
|
|
|
2637
3423
|
"type": "object"
|
|
2638
3424
|
},
|
|
2639
3425
|
"TextParagraph": {
|
|
2640
|
-
"description": "A paragraph of text. Formatted text supported.",
|
|
3426
|
+
"description": "A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
2641
3427
|
"id": "TextParagraph",
|
|
2642
3428
|
"properties": {
|
|
2643
3429
|
"text": {
|
|
@@ -2651,7 +3437,7 @@
|
|
|
2651
3437
|
"id": "Thread",
|
|
2652
3438
|
"properties": {
|
|
2653
3439
|
"name": {
|
|
2654
|
-
"description": "Resource name of the thread. Example: spaces/{space}/threads/{thread}",
|
|
3440
|
+
"description": "Resource name of the thread. Example: `spaces/{space}/threads/{thread}`",
|
|
2655
3441
|
"type": "string"
|
|
2656
3442
|
},
|
|
2657
3443
|
"threadKey": {
|
|
@@ -2662,7 +3448,7 @@
|
|
|
2662
3448
|
"type": "object"
|
|
2663
3449
|
},
|
|
2664
3450
|
"TimeInput": {
|
|
2665
|
-
"description": "Time input values.
|
|
3451
|
+
"description": "Time input values.",
|
|
2666
3452
|
"id": "TimeInput",
|
|
2667
3453
|
"properties": {
|
|
2668
3454
|
"hours": {
|
|
@@ -2679,7 +3465,7 @@
|
|
|
2679
3465
|
"type": "object"
|
|
2680
3466
|
},
|
|
2681
3467
|
"TimeZone": {
|
|
2682
|
-
"description": "The timezone ID and offset from Coordinated Universal Time (UTC).
|
|
3468
|
+
"description": "The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).",
|
|
2683
3469
|
"id": "TimeZone",
|
|
2684
3470
|
"properties": {
|
|
2685
3471
|
"id": {
|
|
@@ -2694,6 +3480,27 @@
|
|
|
2694
3480
|
},
|
|
2695
3481
|
"type": "object"
|
|
2696
3482
|
},
|
|
3483
|
+
"UploadAttachmentRequest": {
|
|
3484
|
+
"description": "[Developer Preview](https://developers.google.com/workspace/preview).",
|
|
3485
|
+
"id": "UploadAttachmentRequest",
|
|
3486
|
+
"properties": {
|
|
3487
|
+
"filename": {
|
|
3488
|
+
"description": "Required. The filename of the attachment, including the file extension.",
|
|
3489
|
+
"type": "string"
|
|
3490
|
+
}
|
|
3491
|
+
},
|
|
3492
|
+
"type": "object"
|
|
3493
|
+
},
|
|
3494
|
+
"UploadAttachmentResponse": {
|
|
3495
|
+
"id": "UploadAttachmentResponse",
|
|
3496
|
+
"properties": {
|
|
3497
|
+
"attachmentDataRef": {
|
|
3498
|
+
"$ref": "AttachmentDataRef",
|
|
3499
|
+
"description": "Reference to the uploaded attachment."
|
|
3500
|
+
}
|
|
3501
|
+
},
|
|
3502
|
+
"type": "object"
|
|
3503
|
+
},
|
|
2697
3504
|
"User": {
|
|
2698
3505
|
"description": "A user in Google Chat.",
|
|
2699
3506
|
"id": "User",
|
|
@@ -2745,7 +3552,7 @@
|
|
|
2745
3552
|
"MENTION"
|
|
2746
3553
|
],
|
|
2747
3554
|
"enumDescriptions": [
|
|
2748
|
-
"Default value for the enum.
|
|
3555
|
+
"Default value for the enum. Don't use.",
|
|
2749
3556
|
"Add user to space.",
|
|
2750
3557
|
"Mention user in space."
|
|
2751
3558
|
],
|
|
@@ -2759,11 +3566,11 @@
|
|
|
2759
3566
|
"type": "object"
|
|
2760
3567
|
},
|
|
2761
3568
|
"WidgetMarkup": {
|
|
2762
|
-
"description": "A widget is a UI element that presents
|
|
3569
|
+
"description": "A widget is a UI element that presents text and images.",
|
|
2763
3570
|
"id": "WidgetMarkup",
|
|
2764
3571
|
"properties": {
|
|
2765
3572
|
"buttons": {
|
|
2766
|
-
"description": "A list of buttons. Buttons is also oneof data and only one of these fields should be set.",
|
|
3573
|
+
"description": "A list of buttons. Buttons is also `oneof data` and only one of these fields should be set.",
|
|
2767
3574
|
"items": {
|
|
2768
3575
|
"$ref": "Button"
|
|
2769
3576
|
},
|