google-api-python-client 2.125.0__py2.py3-none-any.whl → 2.127.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.125.0.dist-info → google_api_python_client-2.127.0.dist-info}/METADATA +3 -3
- {google_api_python_client-2.125.0.dist-info → google_api_python_client-2.127.0.dist-info}/RECORD +380 -376
- 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 +1 -1
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +4 -4
- googleapiclient/discovery_cache/documents/acmedns.v1.json +1 -1
- googleapiclient/discovery_cache/documents/addressvalidation.v1.json +834 -0
- googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +1 -1
- 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 +1 -1
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +1 -1
- 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 +1 -1
- googleapiclient/discovery_cache/documents/admob.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/adsense.v2.json +1 -1
- googleapiclient/discovery_cache/documents/advisorynotifications.v1.json +61 -6
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +1019 -202
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +348 -839
- googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +113 -5
- googleapiclient/discovery_cache/documents/alloydb.v1.json +97 -1
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +1 -49
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +1 -49
- googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +245 -1
- googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +245 -1
- googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +26 -3
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +1 -1
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +3 -3
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +21 -8
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +53 -3
- googleapiclient/discovery_cache/documents/apigateway.v1.json +1 -1
- googleapiclient/discovery_cache/documents/apigateway.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/apigee.v1.json +345 -8
- googleapiclient/discovery_cache/documents/apikeys.v2.json +1 -1
- googleapiclient/discovery_cache/documents/appengine.v1.json +4 -3
- googleapiclient/discovery_cache/documents/appengine.v1alpha.json +4 -3
- googleapiclient/discovery_cache/documents/appengine.v1beta.json +4 -3
- googleapiclient/discovery_cache/documents/apphub.v1.json +1 -1
- googleapiclient/discovery_cache/documents/apphub.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1.json +1 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +1 -1
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +78 -4
- googleapiclient/discovery_cache/documents/backupdr.v1.json +9 -1
- googleapiclient/discovery_cache/documents/batch.v1.json +2 -2
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +1 -1
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +9 -27
- googleapiclient/discovery_cache/documents/biglake.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +1 -1
- 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/blockchainnodeengine.v1.json +2 -2
- 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 +1 -1
- googleapiclient/discovery_cache/documents/calendar.v3.json +3 -3
- googleapiclient/discovery_cache/documents/chat.v1.json +225 -181
- googleapiclient/discovery_cache/documents/checks.v1alpha.json +11 -3
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/chromepolicy.v1.json +1 -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 +10 -6
- googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +4 -4
- googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +4 -4
- googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +4 -4
- googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +4 -4
- 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 +1 -1
- googleapiclient/discovery_cache/documents/cloudbuild.v2.json +6 -1
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +1 -1
- googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +1 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +1 -1
- 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 +1 -1
- 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 +1 -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 +1 -1
- googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudsupport.v2.json +8 -7
- googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +8 -7
- googleapiclient/discovery_cache/documents/cloudtasks.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +1 -1
- googleapiclient/discovery_cache/documents/cloudtrace.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudtrace.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/composer.v1.json +1 -1
- googleapiclient/discovery_cache/documents/composer.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/compute.alpha.json +187 -98
- googleapiclient/discovery_cache/documents/compute.beta.json +140 -10
- googleapiclient/discovery_cache/documents/compute.v1.json +131 -10
- googleapiclient/discovery_cache/documents/config.v1.json +2690 -0
- googleapiclient/discovery_cache/documents/connectors.v1.json +149 -2
- googleapiclient/discovery_cache/documents/connectors.v2.json +23 -1
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +22 -2
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +807 -1
- googleapiclient/discovery_cache/documents/container.v1.json +112 -4
- googleapiclient/discovery_cache/documents/container.v1beta1.json +160 -4
- googleapiclient/discovery_cache/documents/content.v2.1.json +465 -17
- googleapiclient/discovery_cache/documents/contentwarehouse.v1.json +1667 -303
- googleapiclient/discovery_cache/documents/customsearch.v1.json +13 -1
- googleapiclient/discovery_cache/documents/dataflow.v1b3.json +5 -1
- googleapiclient/discovery_cache/documents/datalineage.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datamigration.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/dataplex.v1.json +2 -38
- googleapiclient/discovery_cache/documents/dataportability.v1.json +1 -15
- googleapiclient/discovery_cache/documents/dataportability.v1beta.json +1 -15
- googleapiclient/discovery_cache/documents/dataproc.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datastream.v1.json +21 -1
- googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +1 -1
- 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/dialogflow.v2.json +1 -1
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +1 -1
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +1 -1
- googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +10732 -0
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +2358 -285
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +3498 -1136
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +17 -5
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +36 -5
- googleapiclient/discovery_cache/documents/dlp.v2.json +684 -4
- 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 +16 -15
- googleapiclient/discovery_cache/documents/documentai.v1beta2.json +9 -9
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +333 -15
- googleapiclient/discovery_cache/documents/domainsrdap.v1.json +1 -1
- googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +1 -1
- googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drive.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drive.v3.json +1 -1
- googleapiclient/discovery_cache/documents/driveactivity.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drivelabels.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +1 -1
- googleapiclient/discovery_cache/documents/eventarc.v1.json +1 -1
- googleapiclient/discovery_cache/documents/eventarc.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/fcm.v1.json +1 -1
- googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firebase.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +6 -6
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +20 -20
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +1 -1
- 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 +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +1176 -0
- googleapiclient/discovery_cache/documents/firebaserules.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasestorage.v1beta.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/gkebackup.v1.json +2 -2
- googleapiclient/discovery_cache/documents/gkehub.v1.json +6 -4
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +6 -4
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +6 -4
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +1 -1
- googleapiclient/discovery_cache/documents/gmail.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/groupsmigration.v1.json +1 -1
- googleapiclient/discovery_cache/documents/healthcare.v1.json +1 -1
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/homegraph.v1.json +1 -1
- googleapiclient/discovery_cache/documents/iam.v1.json +678 -18
- 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 +4 -4
- googleapiclient/discovery_cache/documents/iap.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +1 -1
- googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +2 -2
- googleapiclient/discovery_cache/documents/indexing.v3.json +1 -1
- googleapiclient/discovery_cache/documents/integrations.v1.json +12658 -12132
- googleapiclient/discovery_cache/documents/integrations.v1alpha.json +54 -6
- 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 +1 -1
- googleapiclient/discovery_cache/documents/language.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/language.v2.json +1 -1
- 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 +6 -6
- googleapiclient/discovery_cache/documents/looker.v1.json +2 -2
- googleapiclient/discovery_cache/documents/manufacturers.v1.json +1 -1
- googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +44 -1
- googleapiclient/discovery_cache/documents/metastore.v1.json +2 -2
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +51 -7
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +51 -7
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +5 -5
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +1207 -38
- googleapiclient/discovery_cache/documents/monitoring.v1.json +1 -1
- googleapiclient/discovery_cache/documents/monitoring.v3.json +26 -3
- googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.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/networkmanagement.v1.json +2 -2
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +305 -7
- googleapiclient/discovery_cache/documents/networkservices.v1.json +4 -4
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +4 -4
- googleapiclient/discovery_cache/documents/notebooks.v2.json +1 -1
- googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +1 -1
- googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/osconfig.v1.json +10 -10
- googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +1 -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 +6 -1
- googleapiclient/discovery_cache/documents/people.v1.json +1 -1
- googleapiclient/discovery_cache/documents/places.v1.json +4 -4
- googleapiclient/discovery_cache/documents/playcustomapp.v1.json +1 -1
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/playintegrity.v1.json +1 -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 +10 -10
- googleapiclient/discovery_cache/documents/privateca.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/publicca.v1.json +1 -1
- 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 +1 -1
- 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/rapidmigrationassessment.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/recaptchaenterprise.v1.json +1 -1
- googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/recommender.v1.json +3 -3
- googleapiclient/discovery_cache/documents/recommender.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/redis.v1.json +5 -1
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +5 -1
- 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 +2 -2
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +213 -2
- googleapiclient/discovery_cache/documents/retail.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/run.v1.json +9 -1
- googleapiclient/discovery_cache/documents/run.v2.json +57 -50
- googleapiclient/discovery_cache/documents/safebrowsing.v4.json +1 -1
- googleapiclient/discovery_cache/documents/safebrowsing.v5.json +6 -6
- googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/script.v1.json +1 -1
- googleapiclient/discovery_cache/documents/searchads360.v0.json +238 -3
- googleapiclient/discovery_cache/documents/searchconsole.v1.json +1 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +821 -6
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +765 -6
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +765 -6
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +3 -3
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +18 -3
- googleapiclient/discovery_cache/documents/servicecontrol.v1.json +19 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +19 -1
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +3 -3
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +3 -3
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +3 -3
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/sheets.v4.json +6 -4
- googleapiclient/discovery_cache/documents/slides.v1.json +1 -1
- googleapiclient/discovery_cache/documents/solar.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sourcerepo.v1.json +1 -1
- googleapiclient/discovery_cache/documents/spanner.v1.json +4 -4
- googleapiclient/discovery_cache/documents/speech.v1.json +1 -1
- googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +1 -1
- googleapiclient/discovery_cache/documents/storage.v1.json +2 -2
- googleapiclient/discovery_cache/documents/storagetransfer.v1.json +5 -5
- googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sts.v1.json +2 -2
- 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 +1 -1
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +1 -1
- googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +1 -1
- googleapiclient/discovery_cache/documents/tpu.v1.json +1 -1
- googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/tpu.v2.json +1 -1
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +24 -1
- googleapiclient/discovery_cache/documents/trafficdirector.v3.json +25 -2
- googleapiclient/discovery_cache/documents/transcoder.v1.json +1 -1
- 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 +5 -1
- googleapiclient/discovery_cache/documents/versionhistory.v1.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 +2 -2
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/vmwareengine.v1.json +9 -3
- googleapiclient/discovery_cache/documents/walletobjects.v1.json +1 -1
- googleapiclient/discovery_cache/documents/webfonts.v1.json +1 -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/workflows.v1.json +1 -1
- googleapiclient/discovery_cache/documents/workflows.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/workspaceevents.v1.json +2 -2
- googleapiclient/discovery_cache/documents/workstations.v1.json +1 -1
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/youtube.v3.json +4 -1
- 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.125.0.dist-info → google_api_python_client-2.127.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.125.0.dist-info → google_api_python_client-2.127.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.125.0.dist-info → google_api_python_client-2.127.0.dist-info}/top_level.txt +0 -0
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
"supportsMediaDownload": true
|
|
179
179
|
},
|
|
180
180
|
"upload": {
|
|
181
|
-
"description": "Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/chat/
|
|
181
|
+
"description": "Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). 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).",
|
|
182
182
|
"flatPath": "v1/spaces/{spacesId}/attachments:upload",
|
|
183
183
|
"httpMethod": "POST",
|
|
184
184
|
"id": "chat.media.upload",
|
|
@@ -229,7 +229,7 @@
|
|
|
229
229
|
"spaces": {
|
|
230
230
|
"methods": {
|
|
231
231
|
"completeImport": {
|
|
232
|
-
"description": "Completes the [import process](https://developers.google.com/chat/
|
|
232
|
+
"description": "Completes the [import process](https://developers.google.com/workspace/chat/import-data) for the specified space and makes it visible to users. Requires app authentication and domain-wide delegation. For more information, see [Authorize Google Chat apps to import data](https://developers.google.com/workspace/chat/authorize-import).",
|
|
233
233
|
"flatPath": "v1/spaces/{spacesId}:completeImport",
|
|
234
234
|
"httpMethod": "POST",
|
|
235
235
|
"id": "chat.spaces.completeImport",
|
|
@@ -257,7 +257,7 @@
|
|
|
257
257
|
]
|
|
258
258
|
},
|
|
259
259
|
"create": {
|
|
260
|
-
"description": "Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/chat/
|
|
260
|
+
"description": "Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
261
261
|
"flatPath": "v1/spaces",
|
|
262
262
|
"httpMethod": "POST",
|
|
263
263
|
"id": "chat.spaces.create",
|
|
@@ -283,7 +283,7 @@
|
|
|
283
283
|
]
|
|
284
284
|
},
|
|
285
285
|
"delete": {
|
|
286
|
-
"description": "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. For an example, see [Delete a space](https://developers.google.com/chat/
|
|
286
|
+
"description": "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. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) from a user who has permission to delete the space.",
|
|
287
287
|
"flatPath": "v1/spaces/{spacesId}",
|
|
288
288
|
"httpMethod": "DELETE",
|
|
289
289
|
"id": "chat.spaces.delete",
|
|
@@ -309,14 +309,14 @@
|
|
|
309
309
|
]
|
|
310
310
|
},
|
|
311
311
|
"findDirectMessage": {
|
|
312
|
-
"description": "Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/chat/
|
|
312
|
+
"description": "Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).",
|
|
313
313
|
"flatPath": "v1/spaces:findDirectMessage",
|
|
314
314
|
"httpMethod": "GET",
|
|
315
315
|
"id": "chat.spaces.findDirectMessage",
|
|
316
316
|
"parameterOrder": [],
|
|
317
317
|
"parameters": {
|
|
318
318
|
"name": {
|
|
319
|
-
"description": "Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `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 profile ID is `123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/chat/
|
|
319
|
+
"description": "Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `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 profile ID is `123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.",
|
|
320
320
|
"location": "query",
|
|
321
321
|
"type": "string"
|
|
322
322
|
}
|
|
@@ -332,7 +332,7 @@
|
|
|
332
332
|
]
|
|
333
333
|
},
|
|
334
334
|
"get": {
|
|
335
|
-
"description": "Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/
|
|
335
|
+
"description": "Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
336
336
|
"flatPath": "v1/spaces/{spacesId}",
|
|
337
337
|
"httpMethod": "GET",
|
|
338
338
|
"id": "chat.spaces.get",
|
|
@@ -359,14 +359,14 @@
|
|
|
359
359
|
]
|
|
360
360
|
},
|
|
361
361
|
"list": {
|
|
362
|
-
"description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/chat/
|
|
362
|
+
"description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent.",
|
|
363
363
|
"flatPath": "v1/spaces",
|
|
364
364
|
"httpMethod": "GET",
|
|
365
365
|
"id": "chat.spaces.list",
|
|
366
366
|
"parameterOrder": [],
|
|
367
367
|
"parameters": {
|
|
368
368
|
"filter": {
|
|
369
|
-
"description": "Optional. A query filter. 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.",
|
|
369
|
+
"description": "Optional. A query filter. You can filter spaces by the space type ([`space_type`](https://developers.google.com/workspace/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.",
|
|
370
370
|
"location": "query",
|
|
371
371
|
"type": "string"
|
|
372
372
|
},
|
|
@@ -393,7 +393,7 @@
|
|
|
393
393
|
]
|
|
394
394
|
},
|
|
395
395
|
"patch": {
|
|
396
|
-
"description": "Updates a space. For an example, see [Update a space](https://developers.google.com/chat/
|
|
396
|
+
"description": "Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
397
397
|
"flatPath": "v1/spaces/{spacesId}",
|
|
398
398
|
"httpMethod": "PATCH",
|
|
399
399
|
"id": "chat.spaces.patch",
|
|
@@ -428,7 +428,7 @@
|
|
|
428
428
|
]
|
|
429
429
|
},
|
|
430
430
|
"setup": {
|
|
431
|
-
"description": "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. For an example, see [Set up a space](https://developers.google.com/chat/
|
|
431
|
+
"description": "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. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). 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}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. 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 set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). 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 aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
432
432
|
"flatPath": "v1/spaces:setup",
|
|
433
433
|
"httpMethod": "POST",
|
|
434
434
|
"id": "chat.spaces.setup",
|
|
@@ -451,7 +451,7 @@
|
|
|
451
451
|
"members": {
|
|
452
452
|
"methods": {
|
|
453
453
|
"create": {
|
|
454
|
-
"description": "Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [
|
|
454
|
+
"description": "Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [Invite or add a user or a Google Chat app to a space](https://developers.google.com/workspace/chat/create-members). When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`.",
|
|
455
455
|
"flatPath": "v1/spaces/{spacesId}/members",
|
|
456
456
|
"httpMethod": "POST",
|
|
457
457
|
"id": "chat.spaces.members.create",
|
|
@@ -481,7 +481,7 @@
|
|
|
481
481
|
]
|
|
482
482
|
},
|
|
483
483
|
"delete": {
|
|
484
|
-
"description": "Deletes a membership. For an example, see [
|
|
484
|
+
"description": "Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
485
485
|
"flatPath": "v1/spaces/{spacesId}/members/{membersId}",
|
|
486
486
|
"httpMethod": "DELETE",
|
|
487
487
|
"id": "chat.spaces.members.delete",
|
|
@@ -508,7 +508,7 @@
|
|
|
508
508
|
]
|
|
509
509
|
},
|
|
510
510
|
"get": {
|
|
511
|
-
"description": "Returns details about a membership. For an example, see [Get a membership](https://developers.google.com/chat/
|
|
511
|
+
"description": "Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
512
512
|
"flatPath": "v1/spaces/{spacesId}/members/{membersId}",
|
|
513
513
|
"httpMethod": "GET",
|
|
514
514
|
"id": "chat.spaces.members.get",
|
|
@@ -517,7 +517,7 @@
|
|
|
517
517
|
],
|
|
518
518
|
"parameters": {
|
|
519
519
|
"name": {
|
|
520
|
-
"description": "Required. Resource name of the membership to retrieve. To get the app's own membership, you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` When [authenticated as a user](https://developers.google.com/chat/
|
|
520
|
+
"description": "Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.",
|
|
521
521
|
"location": "path",
|
|
522
522
|
"pattern": "^spaces/[^/]+/members/[^/]+$",
|
|
523
523
|
"required": true,
|
|
@@ -535,7 +535,7 @@
|
|
|
535
535
|
]
|
|
536
536
|
},
|
|
537
537
|
"list": {
|
|
538
|
-
"description": "Lists memberships in a space. For an example, see [List
|
|
538
|
+
"description": "Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
539
539
|
"flatPath": "v1/spaces/{spacesId}/members",
|
|
540
540
|
"httpMethod": "GET",
|
|
541
541
|
"id": "chat.spaces.members.list",
|
|
@@ -544,7 +544,7 @@
|
|
|
544
544
|
],
|
|
545
545
|
"parameters": {
|
|
546
546
|
"filter": {
|
|
547
|
-
"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.",
|
|
547
|
+
"description": "Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/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.",
|
|
548
548
|
"location": "query",
|
|
549
549
|
"type": "string"
|
|
550
550
|
},
|
|
@@ -572,7 +572,7 @@
|
|
|
572
572
|
"type": "boolean"
|
|
573
573
|
},
|
|
574
574
|
"showInvited": {
|
|
575
|
-
"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/
|
|
575
|
+
"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/workspace/chat/authenticate-authorize-chat-user).",
|
|
576
576
|
"location": "query",
|
|
577
577
|
"type": "boolean"
|
|
578
578
|
}
|
|
@@ -587,13 +587,48 @@
|
|
|
587
587
|
"https://www.googleapis.com/auth/chat.memberships",
|
|
588
588
|
"https://www.googleapis.com/auth/chat.memberships.readonly"
|
|
589
589
|
]
|
|
590
|
+
},
|
|
591
|
+
"patch": {
|
|
592
|
+
"description": "Updates a membership. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
593
|
+
"flatPath": "v1/spaces/{spacesId}/members/{membersId}",
|
|
594
|
+
"httpMethod": "PATCH",
|
|
595
|
+
"id": "chat.spaces.members.patch",
|
|
596
|
+
"parameterOrder": [
|
|
597
|
+
"name"
|
|
598
|
+
],
|
|
599
|
+
"parameters": {
|
|
600
|
+
"name": {
|
|
601
|
+
"description": "Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`",
|
|
602
|
+
"location": "path",
|
|
603
|
+
"pattern": "^spaces/[^/]+/members/[^/]+$",
|
|
604
|
+
"required": true,
|
|
605
|
+
"type": "string"
|
|
606
|
+
},
|
|
607
|
+
"updateMask": {
|
|
608
|
+
"description": "Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `role`",
|
|
609
|
+
"format": "google-fieldmask",
|
|
610
|
+
"location": "query",
|
|
611
|
+
"type": "string"
|
|
612
|
+
}
|
|
613
|
+
},
|
|
614
|
+
"path": "v1/{+name}",
|
|
615
|
+
"request": {
|
|
616
|
+
"$ref": "Membership"
|
|
617
|
+
},
|
|
618
|
+
"response": {
|
|
619
|
+
"$ref": "Membership"
|
|
620
|
+
},
|
|
621
|
+
"scopes": [
|
|
622
|
+
"https://www.googleapis.com/auth/chat.import",
|
|
623
|
+
"https://www.googleapis.com/auth/chat.memberships"
|
|
624
|
+
]
|
|
590
625
|
}
|
|
591
626
|
}
|
|
592
627
|
},
|
|
593
628
|
"messages": {
|
|
594
629
|
"methods": {
|
|
595
630
|
"create": {
|
|
596
|
-
"description": "Creates a message in a Google Chat space. For an example, see [
|
|
631
|
+
"description": "Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). Calling this method requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) and supports the following authentication types: - For text messages, user authentication or app authentication are supported. - For card messages, only app authentication is supported. (Only Chat apps can create card messages.)",
|
|
597
632
|
"flatPath": "v1/spaces/{spacesId}/messages",
|
|
598
633
|
"httpMethod": "POST",
|
|
599
634
|
"id": "chat.spaces.messages.create",
|
|
@@ -602,7 +637,7 @@
|
|
|
602
637
|
],
|
|
603
638
|
"parameters": {
|
|
604
639
|
"messageId": {
|
|
605
|
-
"description": "Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/chat/
|
|
640
|
+
"description": "Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).",
|
|
606
641
|
"location": "query",
|
|
607
642
|
"type": "string"
|
|
608
643
|
},
|
|
@@ -635,7 +670,7 @@
|
|
|
635
670
|
},
|
|
636
671
|
"threadKey": {
|
|
637
672
|
"deprecated": true,
|
|
638
|
-
"description": "Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. 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/
|
|
673
|
+
"description": "Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. 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/workspace/chat/create-messages#create-message-thread).",
|
|
639
674
|
"location": "query",
|
|
640
675
|
"type": "string"
|
|
641
676
|
}
|
|
@@ -655,7 +690,7 @@
|
|
|
655
690
|
]
|
|
656
691
|
},
|
|
657
692
|
"delete": {
|
|
658
|
-
"description": "Deletes a message. For an example, see [Delete a message](https://developers.google.com/chat/
|
|
693
|
+
"description": "Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only delete messages created by the calling Chat app.",
|
|
659
694
|
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
|
|
660
695
|
"httpMethod": "DELETE",
|
|
661
696
|
"id": "chat.spaces.messages.delete",
|
|
@@ -664,12 +699,12 @@
|
|
|
664
699
|
],
|
|
665
700
|
"parameters": {
|
|
666
701
|
"force": {
|
|
667
|
-
"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/
|
|
702
|
+
"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/workspace/chat/authenticate-authorize-chat-user). Has no effect when [authenticating as a Chat app] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).",
|
|
668
703
|
"location": "query",
|
|
669
704
|
"type": "boolean"
|
|
670
705
|
},
|
|
671
706
|
"name": {
|
|
672
|
-
"description": "Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/chat/
|
|
707
|
+
"description": "Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).",
|
|
673
708
|
"location": "path",
|
|
674
709
|
"pattern": "^spaces/[^/]+/messages/[^/]+$",
|
|
675
710
|
"required": true,
|
|
@@ -687,7 +722,7 @@
|
|
|
687
722
|
]
|
|
688
723
|
},
|
|
689
724
|
"get": {
|
|
690
|
-
"description": "Returns details about a message. For an example, see [
|
|
725
|
+
"description": "Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Note: Might return a message from a blocked member or space.",
|
|
691
726
|
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
|
|
692
727
|
"httpMethod": "GET",
|
|
693
728
|
"id": "chat.spaces.messages.get",
|
|
@@ -696,7 +731,7 @@
|
|
|
696
731
|
],
|
|
697
732
|
"parameters": {
|
|
698
733
|
"name": {
|
|
699
|
-
"description": "Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/chat/
|
|
734
|
+
"description": "Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).",
|
|
700
735
|
"location": "path",
|
|
701
736
|
"pattern": "^spaces/[^/]+/messages/[^/]+$",
|
|
702
737
|
"required": true,
|
|
@@ -714,7 +749,7 @@
|
|
|
714
749
|
]
|
|
715
750
|
},
|
|
716
751
|
"list": {
|
|
717
|
-
"description": "Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see [List messages](/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/chat/
|
|
752
|
+
"description": "Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see [List messages](/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
718
753
|
"flatPath": "v1/spaces/{spacesId}/messages",
|
|
719
754
|
"httpMethod": "GET",
|
|
720
755
|
"id": "chat.spaces.messages.list",
|
|
@@ -767,7 +802,7 @@
|
|
|
767
802
|
]
|
|
768
803
|
},
|
|
769
804
|
"patch": {
|
|
770
|
-
"description": "Updates a message. There's a difference between the `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 an example, see [Update a message](https://developers.google.com/chat/
|
|
805
|
+
"description": "Updates a message. There's a difference between the `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 an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only update messages created by the calling Chat app.",
|
|
771
806
|
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
|
|
772
807
|
"httpMethod": "PATCH",
|
|
773
808
|
"id": "chat.spaces.messages.patch",
|
|
@@ -776,12 +811,12 @@
|
|
|
776
811
|
],
|
|
777
812
|
"parameters": {
|
|
778
813
|
"allowMissing": {
|
|
779
|
-
"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/
|
|
814
|
+
"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/workspace/chat/create-messages#name_a_created_message) or the request fails.",
|
|
780
815
|
"location": "query",
|
|
781
816
|
"type": "boolean"
|
|
782
817
|
},
|
|
783
818
|
"name": {
|
|
784
|
-
"description": "Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/chat/
|
|
819
|
+
"description": "Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).",
|
|
785
820
|
"location": "path",
|
|
786
821
|
"pattern": "^spaces/[^/]+/messages/[^/]+$",
|
|
787
822
|
"required": true,
|
|
@@ -808,7 +843,7 @@
|
|
|
808
843
|
]
|
|
809
844
|
},
|
|
810
845
|
"update": {
|
|
811
|
-
"description": "Updates a message. There's a difference between the `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 an example, see [Update a message](https://developers.google.com/chat/
|
|
846
|
+
"description": "Updates a message. There's a difference between the `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 an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only update messages created by the calling Chat app.",
|
|
812
847
|
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
|
|
813
848
|
"httpMethod": "PUT",
|
|
814
849
|
"id": "chat.spaces.messages.update",
|
|
@@ -817,12 +852,12 @@
|
|
|
817
852
|
],
|
|
818
853
|
"parameters": {
|
|
819
854
|
"allowMissing": {
|
|
820
|
-
"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/
|
|
855
|
+
"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/workspace/chat/create-messages#name_a_created_message) or the request fails.",
|
|
821
856
|
"location": "query",
|
|
822
857
|
"type": "boolean"
|
|
823
858
|
},
|
|
824
859
|
"name": {
|
|
825
|
-
"description": "Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/chat/
|
|
860
|
+
"description": "Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).",
|
|
826
861
|
"location": "path",
|
|
827
862
|
"pattern": "^spaces/[^/]+/messages/[^/]+$",
|
|
828
863
|
"required": true,
|
|
@@ -853,7 +888,7 @@
|
|
|
853
888
|
"attachments": {
|
|
854
889
|
"methods": {
|
|
855
890
|
"get": {
|
|
856
|
-
"description": "Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/chat/api/reference/rest/v1/media/download). For an example, see [Get a message attachment](https://developers.google.com/chat/
|
|
891
|
+
"description": "Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download). For an example, see [Get metadata about a message attachment](https://developers.google.com/workspace/chat/get-media-attachments). Requires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).",
|
|
857
892
|
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/attachments/{attachmentsId}",
|
|
858
893
|
"httpMethod": "GET",
|
|
859
894
|
"id": "chat.spaces.messages.attachments.get",
|
|
@@ -882,7 +917,7 @@
|
|
|
882
917
|
"reactions": {
|
|
883
918
|
"methods": {
|
|
884
919
|
"create": {
|
|
885
|
-
"description": "Creates a reaction and adds it to a message. For an example, see [
|
|
920
|
+
"description": "Creates a reaction and adds it to a message. Only unicode emojis are supported. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
886
921
|
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions",
|
|
887
922
|
"httpMethod": "POST",
|
|
888
923
|
"id": "chat.spaces.messages.reactions.create",
|
|
@@ -913,7 +948,7 @@
|
|
|
913
948
|
]
|
|
914
949
|
},
|
|
915
950
|
"delete": {
|
|
916
|
-
"description": "Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/chat/
|
|
951
|
+
"description": "Deletes a reaction to a message. Only unicode emojis are supported. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
917
952
|
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}",
|
|
918
953
|
"httpMethod": "DELETE",
|
|
919
954
|
"id": "chat.spaces.messages.reactions.delete",
|
|
@@ -940,7 +975,7 @@
|
|
|
940
975
|
]
|
|
941
976
|
},
|
|
942
977
|
"list": {
|
|
943
|
-
"description": "Lists reactions to a message. For an example, see [List reactions](https://developers.google.com/chat/
|
|
978
|
+
"description": "Lists reactions to a message. For an example, see [List reactions for a message](https://developers.google.com/workspace/chat/list-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
|
|
944
979
|
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions",
|
|
945
980
|
"httpMethod": "GET",
|
|
946
981
|
"id": "chat.spaces.messages.reactions.list",
|
|
@@ -949,7 +984,7 @@
|
|
|
949
984
|
],
|
|
950
985
|
"parameters": {
|
|
951
986
|
"filter": {
|
|
952
|
-
"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.",
|
|
987
|
+
"description": "Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/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.",
|
|
953
988
|
"location": "query",
|
|
954
989
|
"type": "string"
|
|
955
990
|
},
|
|
@@ -990,7 +1025,7 @@
|
|
|
990
1025
|
"spaceEvents": {
|
|
991
1026
|
"methods": {
|
|
992
1027
|
"get": {
|
|
993
|
-
"description": "Returns
|
|
1028
|
+
"description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).",
|
|
994
1029
|
"flatPath": "v1/spaces/{spacesId}/spaceEvents/{spaceEventsId}",
|
|
995
1030
|
"httpMethod": "GET",
|
|
996
1031
|
"id": "chat.spaces.spaceEvents.get",
|
|
@@ -999,7 +1034,7 @@
|
|
|
999
1034
|
],
|
|
1000
1035
|
"parameters": {
|
|
1001
1036
|
"name": {
|
|
1002
|
-
"description": "Required. The resource name of the event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`",
|
|
1037
|
+
"description": "Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`",
|
|
1003
1038
|
"location": "path",
|
|
1004
1039
|
"pattern": "^spaces/[^/]+/spaceEvents/[^/]+$",
|
|
1005
1040
|
"required": true,
|
|
@@ -1022,7 +1057,7 @@
|
|
|
1022
1057
|
]
|
|
1023
1058
|
},
|
|
1024
1059
|
"list": {
|
|
1025
|
-
"description": "Lists
|
|
1060
|
+
"description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).",
|
|
1026
1061
|
"flatPath": "v1/spaces/{spacesId}/spaceEvents",
|
|
1027
1062
|
"httpMethod": "GET",
|
|
1028
1063
|
"id": "chat.spaces.spaceEvents.list",
|
|
@@ -1031,12 +1066,12 @@
|
|
|
1031
1066
|
],
|
|
1032
1067
|
"parameters": {
|
|
1033
1068
|
"filter": {
|
|
1034
|
-
"description": "Required. A query filter.
|
|
1069
|
+
"description": "Required. A query filter. You must specify at least one event type (`event_type`) using the has `:` operator. To filter by multiple event types, use the `OR` operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (`google.workspace.chat.reaction.v1.created`), the server also returns batch new reactions events (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported event types, see the [`SpaceEvents` reference documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type). Optionally, you can also filter by start time (`start_time`) and end time (`end_time`): * `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time=\"2023-08-23T19:20:33+00:00\" AND end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` start_time=\"2023-08-23T19:20:33+00:00\" AND (event_types:\"google.workspace.chat.space.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\") ``` The following queries are invalid: ``` start_time=\"2023-08-23T19:20:33+00:00\" OR end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` event_types:\"google.workspace.chat.space.v1.updated\" AND event_types:\"google.workspace.chat.message.v1.created\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.",
|
|
1035
1070
|
"location": "query",
|
|
1036
1071
|
"type": "string"
|
|
1037
1072
|
},
|
|
1038
1073
|
"pageSize": {
|
|
1039
|
-
"description": "Optional. The maximum number of space events returned. The service
|
|
1074
|
+
"description": "Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an `INVALID_ARGUMENT` error.",
|
|
1040
1075
|
"format": "int32",
|
|
1041
1076
|
"location": "query",
|
|
1042
1077
|
"type": "integer"
|
|
@@ -1047,7 +1082,7 @@
|
|
|
1047
1082
|
"type": "string"
|
|
1048
1083
|
},
|
|
1049
1084
|
"parent": {
|
|
1050
|
-
"description": "Required.
|
|
1085
|
+
"description": "Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`.",
|
|
1051
1086
|
"location": "path",
|
|
1052
1087
|
"pattern": "^spaces/[^/]+$",
|
|
1053
1088
|
"required": true,
|
|
@@ -1074,7 +1109,7 @@
|
|
|
1074
1109
|
}
|
|
1075
1110
|
}
|
|
1076
1111
|
},
|
|
1077
|
-
"revision": "
|
|
1112
|
+
"revision": "20240416",
|
|
1078
1113
|
"rootUrl": "https://chat.googleapis.com/",
|
|
1079
1114
|
"schemas": {
|
|
1080
1115
|
"AccessoryWidget": {
|
|
@@ -1109,7 +1144,7 @@
|
|
|
1109
1144
|
"properties": {
|
|
1110
1145
|
"dialogAction": {
|
|
1111
1146
|
"$ref": "DialogAction",
|
|
1112
|
-
"description": "Input only. A response to an interaction event related to a [dialog](https://developers.google.com/chat/
|
|
1147
|
+
"description": "Input only. A response to an interaction event related to a [dialog](https://developers.google.com/workspace/chat/dialogs). Must be accompanied by `ResponseType.Dialog`."
|
|
1113
1148
|
},
|
|
1114
1149
|
"type": {
|
|
1115
1150
|
"description": "Input only. The type of Chat app response.",
|
|
@@ -1128,7 +1163,7 @@
|
|
|
1128
1163
|
"Update the Chat app's message. This is only permitted on a `CARD_CLICKED` event where the message sender type is `BOT`.",
|
|
1129
1164
|
"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.",
|
|
1130
1165
|
"Privately ask the user for additional authentication or configuration.",
|
|
1131
|
-
"Presents a [dialog](https://developers.google.com/chat/
|
|
1166
|
+
"Presents a [dialog](https://developers.google.com/workspace/chat/dialogs).",
|
|
1132
1167
|
"Widget text autocomplete options query."
|
|
1133
1168
|
],
|
|
1134
1169
|
"type": "string"
|
|
@@ -1145,7 +1180,7 @@
|
|
|
1145
1180
|
"type": "object"
|
|
1146
1181
|
},
|
|
1147
1182
|
"ActionStatus": {
|
|
1148
|
-
"description": "Represents the status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/
|
|
1183
|
+
"description": "Represents the status for a request to either invoke or submit a [dialog](https://developers.google.com/workspace/chat/dialogs).",
|
|
1149
1184
|
"id": "ActionStatus",
|
|
1150
1185
|
"properties": {
|
|
1151
1186
|
"statusCode": {
|
|
@@ -1198,7 +1233,7 @@
|
|
|
1198
1233
|
"type": "object"
|
|
1199
1234
|
},
|
|
1200
1235
|
"Annotation": {
|
|
1201
|
-
"description": "Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!\" ``` The corresponding annotations metadata: ``` \"annotations\":[{ \"type\":\"USER_MENTION\", \"startIndex\":6, \"length\":7, \"userMention\": { \"user\": { \"name\":\"users/{user}\", \"displayName\":\"FooBot\", \"avatarUrl\":\"https://goo.gl/aeDtrS\", \"type\":\"BOT\" }, \"type\":\"MENTION\" } }] ```",
|
|
1236
|
+
"description": "Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!\" ``` The corresponding annotations metadata: ``` \"annotations\":[{ \"type\":\"USER_MENTION\", \"startIndex\":6, \"length\":7, \"userMention\": { \"user\": { \"name\":\"users/{user}\", \"displayName\":\"FooBot\", \"avatarUrl\":\"https://goo.gl/aeDtrS\", \"type\":\"BOT\" }, \"type\":\"MENTION\" } }] ```",
|
|
1202
1237
|
"id": "Annotation",
|
|
1203
1238
|
"properties": {
|
|
1204
1239
|
"length": {
|
|
@@ -1294,9 +1329,9 @@
|
|
|
1294
1329
|
"UPLOADED_CONTENT"
|
|
1295
1330
|
],
|
|
1296
1331
|
"enumDescriptions": [
|
|
1297
|
-
"",
|
|
1298
|
-
"",
|
|
1299
|
-
""
|
|
1332
|
+
"Reserved.",
|
|
1333
|
+
"The file is a Google Drive file.",
|
|
1334
|
+
"The file is uploaded to Chat."
|
|
1300
1335
|
],
|
|
1301
1336
|
"readOnly": true,
|
|
1302
1337
|
"type": "string"
|
|
@@ -1310,6 +1345,7 @@
|
|
|
1310
1345
|
"type": "object"
|
|
1311
1346
|
},
|
|
1312
1347
|
"AttachmentDataRef": {
|
|
1348
|
+
"description": "A reference to the attachment data.",
|
|
1313
1349
|
"id": "AttachmentDataRef",
|
|
1314
1350
|
"properties": {
|
|
1315
1351
|
"attachmentUploadToken": {
|
|
@@ -1415,7 +1451,7 @@
|
|
|
1415
1451
|
"type": "object"
|
|
1416
1452
|
},
|
|
1417
1453
|
"CardWithId": {
|
|
1418
|
-
"description": "A [card](https://developers.google.com/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
1454
|
+
"description": "A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder)",
|
|
1419
1455
|
"id": "CardWithId",
|
|
1420
1456
|
"properties": {
|
|
1421
1457
|
"card": {
|
|
@@ -1572,6 +1608,7 @@
|
|
|
1572
1608
|
"type": "object"
|
|
1573
1609
|
},
|
|
1574
1610
|
"CompleteImportSpaceResponse": {
|
|
1611
|
+
"description": "Response message for completing the import process for a space.",
|
|
1575
1612
|
"id": "CompleteImportSpaceResponse",
|
|
1576
1613
|
"properties": {
|
|
1577
1614
|
"space": {
|
|
@@ -1659,18 +1696,18 @@
|
|
|
1659
1696
|
"properties": {
|
|
1660
1697
|
"action": {
|
|
1661
1698
|
"$ref": "FormAction",
|
|
1662
|
-
"description": "For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog. To learn more, see [Read form data input by users on cards](https://developers.google.com/chat/
|
|
1699
|
+
"description": "For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog. To learn more, see [Read form data input by users on cards](https://developers.google.com/workspace/chat/read-form-data)."
|
|
1663
1700
|
},
|
|
1664
1701
|
"common": {
|
|
1665
1702
|
"$ref": "CommonEventObject",
|
|
1666
|
-
"description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/chat/
|
|
1703
|
+
"description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card."
|
|
1667
1704
|
},
|
|
1668
1705
|
"configCompleteRedirectUrl": {
|
|
1669
|
-
"description": "The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/chat/
|
|
1706
|
+
"description": "The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/workspace/chat/connect-web-services-tools).",
|
|
1670
1707
|
"type": "string"
|
|
1671
1708
|
},
|
|
1672
1709
|
"dialogEventType": {
|
|
1673
|
-
"description": "The type of [dialog](https://developers.google.com/chat/
|
|
1710
|
+
"description": "The type of [dialog](https://developers.google.com/workspace/chat/dialogs) interaction event received.",
|
|
1674
1711
|
"enum": [
|
|
1675
1712
|
"TYPE_UNSPECIFIED",
|
|
1676
1713
|
"REQUEST_DIALOG",
|
|
@@ -1691,7 +1728,7 @@
|
|
|
1691
1728
|
"type": "string"
|
|
1692
1729
|
},
|
|
1693
1730
|
"isDialogEvent": {
|
|
1694
|
-
"description": "For `CARD_CLICKED` interaction events, whether the user interacted with a [dialog](https://developers.google.com/chat/
|
|
1731
|
+
"description": "For `CARD_CLICKED` interaction events, whether the user interacted with a [dialog](https://developers.google.com/workspace/chat/dialogs).",
|
|
1695
1732
|
"type": "boolean"
|
|
1696
1733
|
},
|
|
1697
1734
|
"message": {
|
|
@@ -1725,7 +1762,7 @@
|
|
|
1725
1762
|
"A user sends the Chat app a message, or invokes the Chat app in a space.",
|
|
1726
1763
|
"A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization.",
|
|
1727
1764
|
"A user removes the Chat app from a space.",
|
|
1728
|
-
"A user clicks an interactive element of a card or dialog from a Chat app, such as a button. If a user interacts with a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType).",
|
|
1765
|
+
"A user clicks an interactive element of a card or dialog from a Chat app, such as a button. If a user interacts with a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).",
|
|
1729
1766
|
"A user updates a widget in a card message or dialog."
|
|
1730
1767
|
],
|
|
1731
1768
|
"type": "string"
|
|
@@ -1749,16 +1786,16 @@
|
|
|
1749
1786
|
"type": "object"
|
|
1750
1787
|
},
|
|
1751
1788
|
"DialogAction": {
|
|
1752
|
-
"description": "Contains a [dialog](https://developers.google.com/chat/
|
|
1789
|
+
"description": "Contains a [dialog](https://developers.google.com/workspace/chat/dialogs) and request status code.",
|
|
1753
1790
|
"id": "DialogAction",
|
|
1754
1791
|
"properties": {
|
|
1755
1792
|
"actionStatus": {
|
|
1756
1793
|
"$ref": "ActionStatus",
|
|
1757
|
-
"description": "Input only. Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/
|
|
1794
|
+
"description": "Input only. Status for a request to either invoke or submit a [dialog](https://developers.google.com/workspace/chat/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success."
|
|
1758
1795
|
},
|
|
1759
1796
|
"dialog": {
|
|
1760
1797
|
"$ref": "Dialog",
|
|
1761
|
-
"description": "Input only. [Dialog](https://developers.google.com/chat/
|
|
1798
|
+
"description": "Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request."
|
|
1762
1799
|
}
|
|
1763
1800
|
},
|
|
1764
1801
|
"type": "object"
|
|
@@ -1780,7 +1817,7 @@
|
|
|
1780
1817
|
"properties": {
|
|
1781
1818
|
"driveDataRef": {
|
|
1782
1819
|
"$ref": "DriveDataRef",
|
|
1783
|
-
"description": "A [DriveDataRef](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file."
|
|
1820
|
+
"description": "A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file."
|
|
1784
1821
|
},
|
|
1785
1822
|
"mimeType": {
|
|
1786
1823
|
"description": "The mime type of the linked Google Drive resource.",
|
|
@@ -1850,18 +1887,18 @@
|
|
|
1850
1887
|
"id": "GoogleAppsCardV1Action",
|
|
1851
1888
|
"properties": {
|
|
1852
1889
|
"function": {
|
|
1853
|
-
"description": "A custom function to invoke when the containing element is clicked or
|
|
1890
|
+
"description": "A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).",
|
|
1854
1891
|
"type": "string"
|
|
1855
1892
|
},
|
|
1856
1893
|
"interaction": {
|
|
1857
|
-
"description": "Optional. Required when opening a [dialog](https://developers.google.com/chat/
|
|
1894
|
+
"description": "Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/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/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):",
|
|
1858
1895
|
"enum": [
|
|
1859
1896
|
"INTERACTION_UNSPECIFIED",
|
|
1860
1897
|
"OPEN_DIALOG"
|
|
1861
1898
|
],
|
|
1862
1899
|
"enumDescriptions": [
|
|
1863
1900
|
"Default value. The `action` executes as normal.",
|
|
1864
|
-
"Opens a [dialog](https://developers.google.com/chat/
|
|
1901
|
+
"Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a windowed, card-based interface that Chat apps use to interact with users. Only supported by Chat apps in response to button-clicks on card messages. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):"
|
|
1865
1902
|
],
|
|
1866
1903
|
"type": "string"
|
|
1867
1904
|
},
|
|
@@ -1885,14 +1922,14 @@
|
|
|
1885
1922
|
"type": "array"
|
|
1886
1923
|
},
|
|
1887
1924
|
"persistValues": {
|
|
1888
|
-
"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/v1/messages/create#create) 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`.",
|
|
1925
|
+
"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/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/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`.",
|
|
1889
1926
|
"type": "boolean"
|
|
1890
1927
|
}
|
|
1891
1928
|
},
|
|
1892
1929
|
"type": "object"
|
|
1893
1930
|
},
|
|
1894
1931
|
"GoogleAppsCardV1ActionParameter": {
|
|
1895
|
-
"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). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
1932
|
+
"description": "List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
1896
1933
|
"id": "GoogleAppsCardV1ActionParameter",
|
|
1897
1934
|
"properties": {
|
|
1898
1935
|
"key": {
|
|
@@ -1937,11 +1974,11 @@
|
|
|
1937
1974
|
"type": "object"
|
|
1938
1975
|
},
|
|
1939
1976
|
"GoogleAppsCardV1Button": {
|
|
1940
|
-
"description": "A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see [
|
|
1977
|
+
"description": "A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). To make an image a clickable button, specify an `Image` (not an `ImageComponent`) and set an `onClick` action. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
1941
1978
|
"id": "GoogleAppsCardV1Button",
|
|
1942
1979
|
"properties": {
|
|
1943
1980
|
"altText": {
|
|
1944
|
-
"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\".",
|
|
1981
|
+
"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/workspace/chat\".",
|
|
1945
1982
|
"type": "string"
|
|
1946
1983
|
},
|
|
1947
1984
|
"color": {
|
|
@@ -1968,7 +2005,7 @@
|
|
|
1968
2005
|
"type": "object"
|
|
1969
2006
|
},
|
|
1970
2007
|
"GoogleAppsCardV1ButtonList": {
|
|
1971
|
-
"description": "A list of buttons layed out horizontally. For an example in Google Chat apps, see [
|
|
2008
|
+
"description": "A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
1972
2009
|
"id": "GoogleAppsCardV1ButtonList",
|
|
1973
2010
|
"properties": {
|
|
1974
2011
|
"buttons": {
|
|
@@ -1982,7 +2019,7 @@
|
|
|
1982
2019
|
"type": "object"
|
|
1983
2020
|
},
|
|
1984
2021
|
"GoogleAppsCardV1Card": {
|
|
1985
|
-
"description": "A card interface displayed in a Google Chat message or Google Workspace Add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design
|
|
2022
|
+
"description": "A card interface displayed in a Google Chat message or Google Workspace Add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace Add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). **Example: Card message for a Google Chat app**  To create the sample card message in Google Chat, use the following JSON: ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\", \"imageType\": \"CIRCLE\", \"imageAltText\": \"Avatar for Sasha\" }, \"sections\": [ { \"header\": \"Contact Info\", \"collapsible\": true, \"uncollapsibleWidgetsCount\": 1, \"widgets\": [ { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\" }, \"text\": \"sasha@example.com\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PERSON\" }, \"text\": \"Online\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PHONE\" }, \"text\": \"+1 (555) 555-1234\" } }, { \"buttonList\": { \"buttons\": [ { \"text\": \"Share\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/share\" } } }, { \"text\": \"Edit\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"EDIT\" } ] } } } ] } } ] } ] } } ] } ```",
|
|
1986
2023
|
"id": "GoogleAppsCardV1Card",
|
|
1987
2024
|
"properties": {
|
|
1988
2025
|
"cardActions": {
|
|
@@ -2008,7 +2045,7 @@
|
|
|
2008
2045
|
},
|
|
2009
2046
|
"fixedFooter": {
|
|
2010
2047
|
"$ref": "GoogleAppsCardV1CardFixedFooter",
|
|
2011
|
-
"description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/
|
|
2048
|
+
"description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):"
|
|
2012
2049
|
},
|
|
2013
2050
|
"header": {
|
|
2014
2051
|
"$ref": "GoogleAppsCardV1CardHeader",
|
|
@@ -2037,7 +2074,7 @@
|
|
|
2037
2074
|
"type": "string"
|
|
2038
2075
|
},
|
|
2039
2076
|
"sections": {
|
|
2040
|
-
"description": "Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [
|
|
2077
|
+
"description": "Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).",
|
|
2041
2078
|
"items": {
|
|
2042
2079
|
"$ref": "GoogleAppsCardV1Section"
|
|
2043
2080
|
},
|
|
@@ -2062,7 +2099,7 @@
|
|
|
2062
2099
|
"type": "object"
|
|
2063
2100
|
},
|
|
2064
2101
|
"GoogleAppsCardV1CardFixedFooter": {
|
|
2065
|
-
"description": "A persistent (sticky) footer that that appears at the bottom of the card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/
|
|
2102
|
+
"description": "A persistent (sticky) footer that that appears at the bottom of the card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). For an example in Google Chat apps, see [Add a persistent footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
2066
2103
|
"id": "GoogleAppsCardV1CardFixedFooter",
|
|
2067
2104
|
"properties": {
|
|
2068
2105
|
"primaryButton": {
|
|
@@ -2077,7 +2114,7 @@
|
|
|
2077
2114
|
"type": "object"
|
|
2078
2115
|
},
|
|
2079
2116
|
"GoogleAppsCardV1CardHeader": {
|
|
2080
|
-
"description": "Represents a card header. For an example in Google Chat apps, see [
|
|
2117
|
+
"description": "Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
2081
2118
|
"id": "GoogleAppsCardV1CardHeader",
|
|
2082
2119
|
"properties": {
|
|
2083
2120
|
"imageAltText": {
|
|
@@ -2172,7 +2209,7 @@
|
|
|
2172
2209
|
"type": "object"
|
|
2173
2210
|
},
|
|
2174
2211
|
"GoogleAppsCardV1Columns": {
|
|
2175
|
-
"description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [
|
|
2212
|
+
"description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.",
|
|
2176
2213
|
"id": "GoogleAppsCardV1Columns",
|
|
2177
2214
|
"properties": {
|
|
2178
2215
|
"columnItems": {
|
|
@@ -2186,7 +2223,7 @@
|
|
|
2186
2223
|
"type": "object"
|
|
2187
2224
|
},
|
|
2188
2225
|
"GoogleAppsCardV1DateTimePicker": {
|
|
2189
|
-
"description": "Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [
|
|
2226
|
+
"description": "Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
2190
2227
|
"id": "GoogleAppsCardV1DateTimePicker",
|
|
2191
2228
|
"properties": {
|
|
2192
2229
|
"label": {
|
|
@@ -2194,7 +2231,7 @@
|
|
|
2194
2231
|
"type": "string"
|
|
2195
2232
|
},
|
|
2196
2233
|
"name": {
|
|
2197
|
-
"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/
|
|
2234
|
+
"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/workspace/chat/read-form-data).",
|
|
2198
2235
|
"type": "string"
|
|
2199
2236
|
},
|
|
2200
2237
|
"onChangeAction": {
|
|
@@ -2229,7 +2266,7 @@
|
|
|
2229
2266
|
"type": "object"
|
|
2230
2267
|
},
|
|
2231
2268
|
"GoogleAppsCardV1DecoratedText": {
|
|
2232
|
-
"description": "A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [
|
|
2269
|
+
"description": "A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
2233
2270
|
"id": "GoogleAppsCardV1DecoratedText",
|
|
2234
2271
|
"properties": {
|
|
2235
2272
|
"bottomLabel": {
|
|
@@ -2242,7 +2279,7 @@
|
|
|
2242
2279
|
},
|
|
2243
2280
|
"endIcon": {
|
|
2244
2281
|
"$ref": "GoogleAppsCardV1Icon",
|
|
2245
|
-
"description": "An icon displayed after the text. Supports [built-in](https://developers.google.com/chat/format-messages#builtinicons) and [custom](https://developers.google.com/chat/format-messages#customicons) icons."
|
|
2282
|
+
"description": "An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons."
|
|
2246
2283
|
},
|
|
2247
2284
|
"icon": {
|
|
2248
2285
|
"$ref": "GoogleAppsCardV1Icon",
|
|
@@ -2262,7 +2299,7 @@
|
|
|
2262
2299
|
"description": "A switch widget that a user can click to change its state and trigger an action."
|
|
2263
2300
|
},
|
|
2264
2301
|
"text": {
|
|
2265
|
-
"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/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
2302
|
+
"description": "Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
2266
2303
|
"type": "string"
|
|
2267
2304
|
},
|
|
2268
2305
|
"topLabel": {
|
|
@@ -2277,13 +2314,13 @@
|
|
|
2277
2314
|
"type": "object"
|
|
2278
2315
|
},
|
|
2279
2316
|
"GoogleAppsCardV1Divider": {
|
|
2280
|
-
"description": "Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [
|
|
2317
|
+
"description": "Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` \"divider\": {} ```",
|
|
2281
2318
|
"id": "GoogleAppsCardV1Divider",
|
|
2282
2319
|
"properties": {},
|
|
2283
2320
|
"type": "object"
|
|
2284
2321
|
},
|
|
2285
2322
|
"GoogleAppsCardV1Grid": {
|
|
2286
|
-
"description": "Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use `Columns`. For an example in Google Chat apps, see [Grid](https://developers.google.com/chat/
|
|
2323
|
+
"description": "Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use `Columns`. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` \"grid\": { \"title\": \"A fine collection of items\", \"columnCount\": 2, \"borderStyle\": { \"type\": \"STROKE\", \"cornerRadius\": 4 }, \"items\": [ { \"image\": { \"imageUri\": \"https://www.example.com/image.png\", \"cropStyle\": { \"type\": \"SQUARE\" }, \"borderStyle\": { \"type\": \"STROKE\" } }, \"title\": \"An item\", \"textAlignment\": \"CENTER\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```",
|
|
2287
2324
|
"id": "GoogleAppsCardV1Grid",
|
|
2288
2325
|
"properties": {
|
|
2289
2326
|
"borderStyle": {
|
|
@@ -2351,15 +2388,15 @@
|
|
|
2351
2388
|
"type": "object"
|
|
2352
2389
|
},
|
|
2353
2390
|
"GoogleAppsCardV1Icon": {
|
|
2354
|
-
"description": "An icon displayed in a widget on a card. For an example in Google Chat apps, see [
|
|
2391
|
+
"description": "An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
2355
2392
|
"id": "GoogleAppsCardV1Icon",
|
|
2356
2393
|
"properties": {
|
|
2357
2394
|
"altText": {
|
|
2358
|
-
"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.",
|
|
2395
|
+
"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/workspace/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.",
|
|
2359
2396
|
"type": "string"
|
|
2360
2397
|
},
|
|
2361
2398
|
"iconUrl": {
|
|
2362
|
-
"description": "Display a custom icon hosted at an HTTPS URL. For example: ``` \"iconUrl\": \"https://developers.google.com/chat/images/quickstart-app-avatar.png\" ``` Supported file types include `.png` and `.jpg`.",
|
|
2399
|
+
"description": "Display a custom icon hosted at an HTTPS URL. For example: ``` \"iconUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\" ``` Supported file types include `.png` and `.jpg`.",
|
|
2363
2400
|
"type": "string"
|
|
2364
2401
|
},
|
|
2365
2402
|
"imageType": {
|
|
@@ -2375,7 +2412,7 @@
|
|
|
2375
2412
|
"type": "string"
|
|
2376
2413
|
},
|
|
2377
2414
|
"knownIcon": {
|
|
2378
|
-
"description": "Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/chat/format-messages#builtinicons).",
|
|
2415
|
+
"description": "Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).",
|
|
2379
2416
|
"type": "string"
|
|
2380
2417
|
},
|
|
2381
2418
|
"materialIcon": {
|
|
@@ -2386,7 +2423,7 @@
|
|
|
2386
2423
|
"type": "object"
|
|
2387
2424
|
},
|
|
2388
2425
|
"GoogleAppsCardV1Image": {
|
|
2389
|
-
"description": "An image that is specified by a URL and can have an `onClick` action. For an example, see [
|
|
2426
|
+
"description": "An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
2390
2427
|
"id": "GoogleAppsCardV1Image",
|
|
2391
2428
|
"properties": {
|
|
2392
2429
|
"altText": {
|
|
@@ -2394,7 +2431,7 @@
|
|
|
2394
2431
|
"type": "string"
|
|
2395
2432
|
},
|
|
2396
2433
|
"imageUrl": {
|
|
2397
|
-
"description": "The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/chat/images/quickstart-app-avatar.png ```",
|
|
2434
|
+
"description": "The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```",
|
|
2398
2435
|
"type": "string"
|
|
2399
2436
|
},
|
|
2400
2437
|
"onClick": {
|
|
@@ -2572,7 +2609,7 @@
|
|
|
2572
2609
|
"type": "boolean"
|
|
2573
2610
|
},
|
|
2574
2611
|
"header": {
|
|
2575
|
-
"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/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
2612
|
+
"description": "Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
2576
2613
|
"type": "string"
|
|
2577
2614
|
},
|
|
2578
2615
|
"uncollapsibleWidgetsCount": {
|
|
@@ -2591,7 +2628,7 @@
|
|
|
2591
2628
|
"type": "object"
|
|
2592
2629
|
},
|
|
2593
2630
|
"GoogleAppsCardV1SelectionInput": {
|
|
2594
|
-
"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. For an example in Google Chat apps, see [
|
|
2631
|
+
"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. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
2595
2632
|
"id": "GoogleAppsCardV1SelectionInput",
|
|
2596
2633
|
"properties": {
|
|
2597
2634
|
"externalDataSource": {
|
|
@@ -2620,12 +2657,12 @@
|
|
|
2620
2657
|
"type": "integer"
|
|
2621
2658
|
},
|
|
2622
2659
|
"name": {
|
|
2623
|
-
"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/
|
|
2660
|
+
"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/workspace/chat/read-form-data).",
|
|
2624
2661
|
"type": "string"
|
|
2625
2662
|
},
|
|
2626
2663
|
"onChangeAction": {
|
|
2627
2664
|
"$ref": "GoogleAppsCardV1Action",
|
|
2628
|
-
"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/
|
|
2665
|
+
"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/workspace/chat/read-form-data)."
|
|
2629
2666
|
},
|
|
2630
2667
|
"platformDataSource": {
|
|
2631
2668
|
"$ref": "GoogleAppsCardV1PlatformDataSource",
|
|
@@ -2645,7 +2682,7 @@
|
|
|
2645
2682
|
"A set of radio buttons. Users can select one radio button.",
|
|
2646
2683
|
"A set of switches. Users can turn on one or more switches.",
|
|
2647
2684
|
"A dropdown menu. Users can select one item from the menu.",
|
|
2648
|
-
"A multiselect menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To populate items for a multiselect menu, you can use one of the following types of data sources: * Static data: Items are specified as `SelectionItem` objects in the widget. Up to 100 items. * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus, see
|
|
2685
|
+
"A multiselect menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To populate items for a multiselect menu, you can use one of the following types of data sources: * Static data: Items are specified as `SelectionItem` objects in the widget. Up to 100 items. * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus, see [Add a multiselect menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Multiselect for Google Workspace Add-ons are in Developer Preview."
|
|
2649
2686
|
],
|
|
2650
2687
|
"type": "string"
|
|
2651
2688
|
}
|
|
@@ -2665,7 +2702,7 @@
|
|
|
2665
2702
|
"type": "boolean"
|
|
2666
2703
|
},
|
|
2667
2704
|
"startIconUri": {
|
|
2668
|
-
"description": "For multiselect menus, the URL for the icon displayed next to the item's `text` field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For example, `https://developers.google.com/chat/images/quickstart-app-avatar.png`.",
|
|
2705
|
+
"description": "For multiselect menus, the URL for the icon displayed next to the item's `text` field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For example, `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`.",
|
|
2669
2706
|
"type": "string"
|
|
2670
2707
|
},
|
|
2671
2708
|
"text": {
|
|
@@ -2673,7 +2710,7 @@
|
|
|
2673
2710
|
"type": "string"
|
|
2674
2711
|
},
|
|
2675
2712
|
"value": {
|
|
2676
|
-
"description": "The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/
|
|
2713
|
+
"description": "The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).",
|
|
2677
2714
|
"type": "string"
|
|
2678
2715
|
}
|
|
2679
2716
|
},
|
|
@@ -2723,7 +2760,7 @@
|
|
|
2723
2760
|
"type": "string"
|
|
2724
2761
|
},
|
|
2725
2762
|
"name": {
|
|
2726
|
-
"description": "The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/
|
|
2763
|
+
"description": "The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).",
|
|
2727
2764
|
"type": "string"
|
|
2728
2765
|
},
|
|
2729
2766
|
"onChangeAction": {
|
|
@@ -2735,14 +2772,14 @@
|
|
|
2735
2772
|
"type": "boolean"
|
|
2736
2773
|
},
|
|
2737
2774
|
"value": {
|
|
2738
|
-
"description": "The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/
|
|
2775
|
+
"description": "The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).",
|
|
2739
2776
|
"type": "string"
|
|
2740
2777
|
}
|
|
2741
2778
|
},
|
|
2742
2779
|
"type": "object"
|
|
2743
2780
|
},
|
|
2744
2781
|
"GoogleAppsCardV1TextInput": {
|
|
2745
|
-
"description": "A field in which users can enter text. Supports suggestions and on-change actions. For an example in Google Chat apps, see [
|
|
2782
|
+
"description": "A field in which users can enter text. Supports suggestions and on-change actions. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
2746
2783
|
"id": "GoogleAppsCardV1TextInput",
|
|
2747
2784
|
"properties": {
|
|
2748
2785
|
"autoCompleteAction": {
|
|
@@ -2762,12 +2799,12 @@
|
|
|
2762
2799
|
"type": "string"
|
|
2763
2800
|
},
|
|
2764
2801
|
"name": {
|
|
2765
|
-
"description": "The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/
|
|
2802
|
+
"description": "The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).",
|
|
2766
2803
|
"type": "string"
|
|
2767
2804
|
},
|
|
2768
2805
|
"onChangeAction": {
|
|
2769
2806
|
"$ref": "GoogleAppsCardV1Action",
|
|
2770
|
-
"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/
|
|
2807
|
+
"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/workspace/chat/dialogs) in Google Chat."
|
|
2771
2808
|
},
|
|
2772
2809
|
"placeholderText": {
|
|
2773
2810
|
"description": "Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):",
|
|
@@ -2786,14 +2823,14 @@
|
|
|
2786
2823
|
"type": "string"
|
|
2787
2824
|
},
|
|
2788
2825
|
"value": {
|
|
2789
|
-
"description": "The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/
|
|
2826
|
+
"description": "The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).",
|
|
2790
2827
|
"type": "string"
|
|
2791
2828
|
}
|
|
2792
2829
|
},
|
|
2793
2830
|
"type": "object"
|
|
2794
2831
|
},
|
|
2795
2832
|
"GoogleAppsCardV1TextParagraph": {
|
|
2796
|
-
"description": "A paragraph of text that supports formatting. For an example in Google Chat apps, see [
|
|
2833
|
+
"description": "A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):",
|
|
2797
2834
|
"id": "GoogleAppsCardV1TextParagraph",
|
|
2798
2835
|
"properties": {
|
|
2799
2836
|
"text": {
|
|
@@ -2849,7 +2886,7 @@
|
|
|
2849
2886
|
},
|
|
2850
2887
|
"image": {
|
|
2851
2888
|
"$ref": "GoogleAppsCardV1Image",
|
|
2852
|
-
"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\" } ```"
|
|
2889
|
+
"description": "Displays an image. For example, the following JSON creates an image with alternative text: ``` \"image\": { \"imageUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\", \"altText\": \"Chat app avatar\" } ```"
|
|
2853
2890
|
},
|
|
2854
2891
|
"selectionInput": {
|
|
2855
2892
|
"$ref": "GoogleAppsCardV1SelectionInput",
|
|
@@ -2861,7 +2898,7 @@
|
|
|
2861
2898
|
},
|
|
2862
2899
|
"textParagraph": {
|
|
2863
2900
|
"$ref": "GoogleAppsCardV1TextParagraph",
|
|
2864
|
-
"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/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```"
|
|
2901
|
+
"description": "Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```"
|
|
2865
2902
|
}
|
|
2866
2903
|
},
|
|
2867
2904
|
"type": "object"
|
|
@@ -3060,7 +3097,7 @@
|
|
|
3060
3097
|
"id": "KeyValue",
|
|
3061
3098
|
"properties": {
|
|
3062
3099
|
"bottomLabel": {
|
|
3063
|
-
"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/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
3100
|
+
"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/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
3064
3101
|
"type": "string"
|
|
3065
3102
|
},
|
|
3066
3103
|
"button": {
|
|
@@ -3068,7 +3105,7 @@
|
|
|
3068
3105
|
"description": "A button that can be clicked to trigger an action."
|
|
3069
3106
|
},
|
|
3070
3107
|
"content": {
|
|
3071
|
-
"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/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
3108
|
+
"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/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
3072
3109
|
"type": "string"
|
|
3073
3110
|
},
|
|
3074
3111
|
"contentMultiline": {
|
|
@@ -3154,13 +3191,14 @@
|
|
|
3154
3191
|
"description": "The `onclick` action. Only the top label, bottom label, and content region are clickable."
|
|
3155
3192
|
},
|
|
3156
3193
|
"topLabel": {
|
|
3157
|
-
"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/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
3194
|
+
"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/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
3158
3195
|
"type": "string"
|
|
3159
3196
|
}
|
|
3160
3197
|
},
|
|
3161
3198
|
"type": "object"
|
|
3162
3199
|
},
|
|
3163
3200
|
"ListMembershipsResponse": {
|
|
3201
|
+
"description": "Response to list memberships of the space.",
|
|
3164
3202
|
"id": "ListMembershipsResponse",
|
|
3165
3203
|
"properties": {
|
|
3166
3204
|
"memberships": {
|
|
@@ -3178,6 +3216,7 @@
|
|
|
3178
3216
|
"type": "object"
|
|
3179
3217
|
},
|
|
3180
3218
|
"ListMessagesResponse": {
|
|
3219
|
+
"description": "Response message for listing messages.",
|
|
3181
3220
|
"id": "ListMessagesResponse",
|
|
3182
3221
|
"properties": {
|
|
3183
3222
|
"messages": {
|
|
@@ -3195,6 +3234,7 @@
|
|
|
3195
3234
|
"type": "object"
|
|
3196
3235
|
},
|
|
3197
3236
|
"ListReactionsResponse": {
|
|
3237
|
+
"description": "Response to a list reactions request.",
|
|
3198
3238
|
"id": "ListReactionsResponse",
|
|
3199
3239
|
"properties": {
|
|
3200
3240
|
"nextPageToken": {
|
|
@@ -3230,6 +3270,7 @@
|
|
|
3230
3270
|
"type": "object"
|
|
3231
3271
|
},
|
|
3232
3272
|
"ListSpacesResponse": {
|
|
3273
|
+
"description": "The response for a list spaces request.",
|
|
3233
3274
|
"id": "ListSpacesResponse",
|
|
3234
3275
|
"properties": {
|
|
3235
3276
|
"nextPageToken": {
|
|
@@ -3289,14 +3330,14 @@
|
|
|
3289
3330
|
},
|
|
3290
3331
|
"member": {
|
|
3291
3332
|
"$ref": "User",
|
|
3292
|
-
"description": "The Google Chat user or app the membership corresponds to. If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
3333
|
+
"description": "The Google Chat user or app the membership corresponds to. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) `name` and `type`."
|
|
3293
3334
|
},
|
|
3294
3335
|
"name": {
|
|
3295
3336
|
"description": "Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`",
|
|
3296
3337
|
"type": "string"
|
|
3297
3338
|
},
|
|
3298
3339
|
"role": {
|
|
3299
|
-
"description": "Optional. User's role within a Chat space, which determines their permitted actions in the space.
|
|
3340
|
+
"description": "Optional. User's role within a Chat space, which determines their permitted actions in the space. This field can only be used as input in `UpdateMembership`.",
|
|
3300
3341
|
"enum": [
|
|
3301
3342
|
"MEMBERSHIP_ROLE_UNSPECIFIED",
|
|
3302
3343
|
"ROLE_MEMBER",
|
|
@@ -3330,11 +3371,11 @@
|
|
|
3330
3371
|
"type": "object"
|
|
3331
3372
|
},
|
|
3332
3373
|
"MembershipBatchCreatedEventData": {
|
|
3333
|
-
"description": "
|
|
3374
|
+
"description": "Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`",
|
|
3334
3375
|
"id": "MembershipBatchCreatedEventData",
|
|
3335
3376
|
"properties": {
|
|
3336
3377
|
"memberships": {
|
|
3337
|
-
"description": "A list of
|
|
3378
|
+
"description": "A list of new memberships.",
|
|
3338
3379
|
"items": {
|
|
3339
3380
|
"$ref": "MembershipCreatedEventData"
|
|
3340
3381
|
},
|
|
@@ -3344,7 +3385,7 @@
|
|
|
3344
3385
|
"type": "object"
|
|
3345
3386
|
},
|
|
3346
3387
|
"MembershipBatchDeletedEventData": {
|
|
3347
|
-
"description": "
|
|
3388
|
+
"description": "Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`",
|
|
3348
3389
|
"id": "MembershipBatchDeletedEventData",
|
|
3349
3390
|
"properties": {
|
|
3350
3391
|
"memberships": {
|
|
@@ -3358,7 +3399,7 @@
|
|
|
3358
3399
|
"type": "object"
|
|
3359
3400
|
},
|
|
3360
3401
|
"MembershipBatchUpdatedEventData": {
|
|
3361
|
-
"description": "
|
|
3402
|
+
"description": "Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`",
|
|
3362
3403
|
"id": "MembershipBatchUpdatedEventData",
|
|
3363
3404
|
"properties": {
|
|
3364
3405
|
"memberships": {
|
|
@@ -3372,34 +3413,34 @@
|
|
|
3372
3413
|
"type": "object"
|
|
3373
3414
|
},
|
|
3374
3415
|
"MembershipCreatedEventData": {
|
|
3375
|
-
"description": "
|
|
3416
|
+
"description": "Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`.",
|
|
3376
3417
|
"id": "MembershipCreatedEventData",
|
|
3377
3418
|
"properties": {
|
|
3378
3419
|
"membership": {
|
|
3379
3420
|
"$ref": "Membership",
|
|
3380
|
-
"description": "The
|
|
3421
|
+
"description": "The new membership."
|
|
3381
3422
|
}
|
|
3382
3423
|
},
|
|
3383
3424
|
"type": "object"
|
|
3384
3425
|
},
|
|
3385
3426
|
"MembershipDeletedEventData": {
|
|
3386
|
-
"description": "
|
|
3427
|
+
"description": "Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`",
|
|
3387
3428
|
"id": "MembershipDeletedEventData",
|
|
3388
3429
|
"properties": {
|
|
3389
3430
|
"membership": {
|
|
3390
3431
|
"$ref": "Membership",
|
|
3391
|
-
"description": "The deleted membership. Only `name` and `state` are populated."
|
|
3432
|
+
"description": "The deleted membership. Only the `name` and `state` fields are populated."
|
|
3392
3433
|
}
|
|
3393
3434
|
},
|
|
3394
3435
|
"type": "object"
|
|
3395
3436
|
},
|
|
3396
3437
|
"MembershipUpdatedEventData": {
|
|
3397
|
-
"description": "
|
|
3438
|
+
"description": "Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`",
|
|
3398
3439
|
"id": "MembershipUpdatedEventData",
|
|
3399
3440
|
"properties": {
|
|
3400
3441
|
"membership": {
|
|
3401
3442
|
"$ref": "Membership",
|
|
3402
|
-
"description": "The
|
|
3443
|
+
"description": "The updated membership."
|
|
3403
3444
|
}
|
|
3404
3445
|
},
|
|
3405
3446
|
"type": "object"
|
|
@@ -3409,7 +3450,7 @@
|
|
|
3409
3450
|
"id": "Message",
|
|
3410
3451
|
"properties": {
|
|
3411
3452
|
"accessoryWidgets": {
|
|
3412
|
-
"description": "One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/
|
|
3453
|
+
"description": "One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).",
|
|
3413
3454
|
"items": {
|
|
3414
3455
|
"$ref": "AccessoryWidget"
|
|
3415
3456
|
},
|
|
@@ -3456,14 +3497,14 @@
|
|
|
3456
3497
|
"type": "array"
|
|
3457
3498
|
},
|
|
3458
3499
|
"cardsV2": {
|
|
3459
|
-
"description": "An array of [cards](https://developers.google.com/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
3500
|
+
"description": "An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn about cards and how to create them, see [Send card messages](https://developers.google.com/workspace/chat/create-messages#create). [Card builder](https://addons.gsuite.google.com/uikit/builder)",
|
|
3460
3501
|
"items": {
|
|
3461
3502
|
"$ref": "CardWithId"
|
|
3462
3503
|
},
|
|
3463
3504
|
"type": "array"
|
|
3464
3505
|
},
|
|
3465
3506
|
"clientAssignedMessageId": {
|
|
3466
|
-
"description": "Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the [`messageId`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google.com/chat/
|
|
3507
|
+
"description": "Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the [`messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).",
|
|
3467
3508
|
"type": "string"
|
|
3468
3509
|
},
|
|
3469
3510
|
"createTime": {
|
|
@@ -3495,7 +3536,7 @@
|
|
|
3495
3536
|
"type": "string"
|
|
3496
3537
|
},
|
|
3497
3538
|
"formattedText": {
|
|
3498
|
-
"description": "Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text\u2014for example, ``. * Custom emoji using the format `:{emoji_name}:`\u2014for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/chat/format-messages#view_text_formatting_sent_in_a_message)",
|
|
3539
|
+
"description": "Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text\u2014for example, ``. * Custom emoji using the format `:{emoji_name}:`\u2014for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message)",
|
|
3499
3540
|
"readOnly": true,
|
|
3500
3541
|
"type": "string"
|
|
3501
3542
|
},
|
|
@@ -3507,16 +3548,16 @@
|
|
|
3507
3548
|
},
|
|
3508
3549
|
"matchedUrl": {
|
|
3509
3550
|
"$ref": "MatchedUrl",
|
|
3510
|
-
"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/
|
|
3551
|
+
"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/workspace/chat/preview-links).",
|
|
3511
3552
|
"readOnly": true
|
|
3512
3553
|
},
|
|
3513
3554
|
"name": {
|
|
3514
|
-
"description": "Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/chat/
|
|
3555
|
+
"description": "Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).",
|
|
3515
3556
|
"type": "string"
|
|
3516
3557
|
},
|
|
3517
3558
|
"privateMessageViewer": {
|
|
3518
3559
|
"$ref": "User",
|
|
3519
|
-
"description": "Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages. Only Chat apps can send private messages. If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
3560
|
+
"description": "Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages. Only Chat apps can send private messages. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) to send a message, the message can't be private and must omit this field. For details, see [Send private messages to Google Chat users](https://developers.google.com/workspace/chat/private-messages)."
|
|
3520
3561
|
},
|
|
3521
3562
|
"quotedMessageMetadata": {
|
|
3522
3563
|
"$ref": "QuotedMessageMetadata",
|
|
@@ -3525,7 +3566,7 @@
|
|
|
3525
3566
|
},
|
|
3526
3567
|
"sender": {
|
|
3527
3568
|
"$ref": "User",
|
|
3528
|
-
"description": "Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
3569
|
+
"description": "Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) `name` and `type`.",
|
|
3529
3570
|
"readOnly": true
|
|
3530
3571
|
},
|
|
3531
3572
|
"slashCommand": {
|
|
@@ -3535,15 +3576,15 @@
|
|
|
3535
3576
|
},
|
|
3536
3577
|
"space": {
|
|
3537
3578
|
"$ref": "Space",
|
|
3538
|
-
"description": "If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
3579
|
+
"description": "If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`."
|
|
3539
3580
|
},
|
|
3540
3581
|
"text": {
|
|
3541
|
-
"description": "Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/chat/
|
|
3582
|
+
"description": "Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages).",
|
|
3542
3583
|
"type": "string"
|
|
3543
3584
|
},
|
|
3544
3585
|
"thread": {
|
|
3545
3586
|
"$ref": "Thread",
|
|
3546
|
-
"description": "The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/
|
|
3587
|
+
"description": "The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread)."
|
|
3547
3588
|
},
|
|
3548
3589
|
"threadReply": {
|
|
3549
3590
|
"description": "Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`.",
|
|
@@ -3554,11 +3595,11 @@
|
|
|
3554
3595
|
"type": "object"
|
|
3555
3596
|
},
|
|
3556
3597
|
"MessageBatchCreatedEventData": {
|
|
3557
|
-
"description": "
|
|
3598
|
+
"description": "Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`",
|
|
3558
3599
|
"id": "MessageBatchCreatedEventData",
|
|
3559
3600
|
"properties": {
|
|
3560
3601
|
"messages": {
|
|
3561
|
-
"description": "A list of
|
|
3602
|
+
"description": "A list of new messages.",
|
|
3562
3603
|
"items": {
|
|
3563
3604
|
"$ref": "MessageCreatedEventData"
|
|
3564
3605
|
},
|
|
@@ -3568,7 +3609,7 @@
|
|
|
3568
3609
|
"type": "object"
|
|
3569
3610
|
},
|
|
3570
3611
|
"MessageBatchDeletedEventData": {
|
|
3571
|
-
"description": "
|
|
3612
|
+
"description": "Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`",
|
|
3572
3613
|
"id": "MessageBatchDeletedEventData",
|
|
3573
3614
|
"properties": {
|
|
3574
3615
|
"messages": {
|
|
@@ -3582,7 +3623,7 @@
|
|
|
3582
3623
|
"type": "object"
|
|
3583
3624
|
},
|
|
3584
3625
|
"MessageBatchUpdatedEventData": {
|
|
3585
|
-
"description": "
|
|
3626
|
+
"description": "Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`",
|
|
3586
3627
|
"id": "MessageBatchUpdatedEventData",
|
|
3587
3628
|
"properties": {
|
|
3588
3629
|
"messages": {
|
|
@@ -3596,34 +3637,34 @@
|
|
|
3596
3637
|
"type": "object"
|
|
3597
3638
|
},
|
|
3598
3639
|
"MessageCreatedEventData": {
|
|
3599
|
-
"description": "
|
|
3640
|
+
"description": "Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`",
|
|
3600
3641
|
"id": "MessageCreatedEventData",
|
|
3601
3642
|
"properties": {
|
|
3602
3643
|
"message": {
|
|
3603
3644
|
"$ref": "Message",
|
|
3604
|
-
"description": "The
|
|
3645
|
+
"description": "The new message."
|
|
3605
3646
|
}
|
|
3606
3647
|
},
|
|
3607
3648
|
"type": "object"
|
|
3608
3649
|
},
|
|
3609
3650
|
"MessageDeletedEventData": {
|
|
3610
|
-
"description": "
|
|
3651
|
+
"description": "Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`",
|
|
3611
3652
|
"id": "MessageDeletedEventData",
|
|
3612
3653
|
"properties": {
|
|
3613
3654
|
"message": {
|
|
3614
3655
|
"$ref": "Message",
|
|
3615
|
-
"description": "The deleted message. Only `name`, `createTime`, `deleteTime`, and `deletionMetadata` are populated."
|
|
3656
|
+
"description": "The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated."
|
|
3616
3657
|
}
|
|
3617
3658
|
},
|
|
3618
3659
|
"type": "object"
|
|
3619
3660
|
},
|
|
3620
3661
|
"MessageUpdatedEventData": {
|
|
3621
|
-
"description": "
|
|
3662
|
+
"description": "Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`",
|
|
3622
3663
|
"id": "MessageUpdatedEventData",
|
|
3623
3664
|
"properties": {
|
|
3624
3665
|
"message": {
|
|
3625
3666
|
"$ref": "Message",
|
|
3626
|
-
"description": "The
|
|
3667
|
+
"description": "The updated message."
|
|
3627
3668
|
}
|
|
3628
3669
|
},
|
|
3629
3670
|
"type": "object"
|
|
@@ -3693,11 +3734,11 @@
|
|
|
3693
3734
|
"type": "object"
|
|
3694
3735
|
},
|
|
3695
3736
|
"ReactionBatchCreatedEventData": {
|
|
3696
|
-
"description": "
|
|
3737
|
+
"description": "Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`",
|
|
3697
3738
|
"id": "ReactionBatchCreatedEventData",
|
|
3698
3739
|
"properties": {
|
|
3699
3740
|
"reactions": {
|
|
3700
|
-
"description": "A list of
|
|
3741
|
+
"description": "A list of new reactions.",
|
|
3701
3742
|
"items": {
|
|
3702
3743
|
"$ref": "ReactionCreatedEventData"
|
|
3703
3744
|
},
|
|
@@ -3707,7 +3748,7 @@
|
|
|
3707
3748
|
"type": "object"
|
|
3708
3749
|
},
|
|
3709
3750
|
"ReactionBatchDeletedEventData": {
|
|
3710
|
-
"description": "
|
|
3751
|
+
"description": "Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`",
|
|
3711
3752
|
"id": "ReactionBatchDeletedEventData",
|
|
3712
3753
|
"properties": {
|
|
3713
3754
|
"reactions": {
|
|
@@ -3721,18 +3762,18 @@
|
|
|
3721
3762
|
"type": "object"
|
|
3722
3763
|
},
|
|
3723
3764
|
"ReactionCreatedEventData": {
|
|
3724
|
-
"description": "
|
|
3765
|
+
"description": "Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`",
|
|
3725
3766
|
"id": "ReactionCreatedEventData",
|
|
3726
3767
|
"properties": {
|
|
3727
3768
|
"reaction": {
|
|
3728
3769
|
"$ref": "Reaction",
|
|
3729
|
-
"description": "The
|
|
3770
|
+
"description": "The new reaction."
|
|
3730
3771
|
}
|
|
3731
3772
|
},
|
|
3732
3773
|
"type": "object"
|
|
3733
3774
|
},
|
|
3734
3775
|
"ReactionDeletedEventData": {
|
|
3735
|
-
"description": "
|
|
3776
|
+
"description": "Event payload for a deleted reaction. Type: `google.workspace.chat.reaction.v1.deleted`",
|
|
3736
3777
|
"id": "ReactionDeletedEventData",
|
|
3737
3778
|
"properties": {
|
|
3738
3779
|
"reaction": {
|
|
@@ -3774,7 +3815,7 @@
|
|
|
3774
3815
|
"id": "Section",
|
|
3775
3816
|
"properties": {
|
|
3776
3817
|
"header": {
|
|
3777
|
-
"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/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
3818
|
+
"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/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
3778
3819
|
"type": "string"
|
|
3779
3820
|
},
|
|
3780
3821
|
"widgets": {
|
|
@@ -3802,6 +3843,7 @@
|
|
|
3802
3843
|
"type": "object"
|
|
3803
3844
|
},
|
|
3804
3845
|
"SetUpSpaceRequest": {
|
|
3846
|
+
"description": "Request to create a space and add specified users to it.",
|
|
3805
3847
|
"id": "SetUpSpaceRequest",
|
|
3806
3848
|
"properties": {
|
|
3807
3849
|
"memberships": {
|
|
@@ -3823,7 +3865,7 @@
|
|
|
3823
3865
|
"type": "object"
|
|
3824
3866
|
},
|
|
3825
3867
|
"SlashCommand": {
|
|
3826
|
-
"description": "A [slash command](https://developers.google.com/chat/
|
|
3868
|
+
"description": "A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat.",
|
|
3827
3869
|
"id": "SlashCommand",
|
|
3828
3870
|
"properties": {
|
|
3829
3871
|
"commandId": {
|
|
@@ -3887,11 +3929,11 @@
|
|
|
3887
3929
|
"type": "string"
|
|
3888
3930
|
},
|
|
3889
3931
|
"displayName": {
|
|
3890
|
-
"description": "The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.",
|
|
3932
|
+
"description": "The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.",
|
|
3891
3933
|
"type": "string"
|
|
3892
3934
|
},
|
|
3893
3935
|
"externalUserAllowed": {
|
|
3894
|
-
"description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview)
|
|
3936
|
+
"description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only.",
|
|
3895
3937
|
"type": "boolean"
|
|
3896
3938
|
},
|
|
3897
3939
|
"importMode": {
|
|
@@ -3972,7 +4014,7 @@
|
|
|
3972
4014
|
"DM"
|
|
3973
4015
|
],
|
|
3974
4016
|
"enumDescriptions": [
|
|
3975
|
-
"",
|
|
4017
|
+
"Reserved.",
|
|
3976
4018
|
"Conversations between two or more humans.",
|
|
3977
4019
|
"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."
|
|
3978
4020
|
],
|
|
@@ -3983,7 +4025,7 @@
|
|
|
3983
4025
|
"type": "object"
|
|
3984
4026
|
},
|
|
3985
4027
|
"SpaceBatchUpdatedEventData": {
|
|
3986
|
-
"description": "
|
|
4028
|
+
"description": "Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`",
|
|
3987
4029
|
"id": "SpaceBatchUpdatedEventData",
|
|
3988
4030
|
"properties": {
|
|
3989
4031
|
"spaces": {
|
|
@@ -4023,104 +4065,104 @@
|
|
|
4023
4065
|
"type": "object"
|
|
4024
4066
|
},
|
|
4025
4067
|
"SpaceEvent": {
|
|
4026
|
-
"description": "An event that
|
|
4068
|
+
"description": "An event that represents a change or activity in a Google Chat space. To learn more, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).",
|
|
4027
4069
|
"id": "SpaceEvent",
|
|
4028
4070
|
"properties": {
|
|
4029
4071
|
"eventTime": {
|
|
4030
|
-
"description": "Time
|
|
4072
|
+
"description": "Time when the event occurred.",
|
|
4031
4073
|
"format": "google-datetime",
|
|
4032
4074
|
"type": "string"
|
|
4033
4075
|
},
|
|
4034
4076
|
"eventType": {
|
|
4035
|
-
"description": "Type of the
|
|
4077
|
+
"description": "Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For `spaceEvents.list()` requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for [messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages): * New message: `google.workspace.chat.message.v1.created` * Updated message: `google.workspace.chat.message.v1.updated` * Deleted message: `google.workspace.chat.message.v1.deleted` * Multiple new messages: `google.workspace.chat.message.v1.batchCreated` * Multiple updated messages: `google.workspace.chat.message.v1.batchUpdated` * Multiple deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported event types for [memberships](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members): * New membership: `google.workspace.chat.membership.v1.created` * Updated membership: `google.workspace.chat.membership.v1.updated` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Multiple new memberships: `google.workspace.chat.membership.v1.batchCreated` * Multiple updated memberships: `google.workspace.chat.membership.v1.batchUpdated` * Multiple deleted memberships: `google.workspace.chat.membership.v1.batchDeleted` Supported event types for [reactions](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions): * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Multiple new reactions: `google.workspace.chat.reaction.v1.batchCreated` * Multiple deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted` Supported event types about the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces): * Updated space: `google.workspace.chat.space.v1.updated` * Multiple space updates: `google.workspace.chat.space.v1.batchUpdated`",
|
|
4036
4078
|
"type": "string"
|
|
4037
4079
|
},
|
|
4038
4080
|
"membershipBatchCreatedEventData": {
|
|
4039
4081
|
"$ref": "MembershipBatchCreatedEventData",
|
|
4040
|
-
"description": "
|
|
4082
|
+
"description": "Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`"
|
|
4041
4083
|
},
|
|
4042
4084
|
"membershipBatchDeletedEventData": {
|
|
4043
4085
|
"$ref": "MembershipBatchDeletedEventData",
|
|
4044
|
-
"description": "
|
|
4086
|
+
"description": "Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`"
|
|
4045
4087
|
},
|
|
4046
4088
|
"membershipBatchUpdatedEventData": {
|
|
4047
4089
|
"$ref": "MembershipBatchUpdatedEventData",
|
|
4048
|
-
"description": "
|
|
4090
|
+
"description": "Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`"
|
|
4049
4091
|
},
|
|
4050
4092
|
"membershipCreatedEventData": {
|
|
4051
4093
|
"$ref": "MembershipCreatedEventData",
|
|
4052
|
-
"description": "
|
|
4094
|
+
"description": "Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`"
|
|
4053
4095
|
},
|
|
4054
4096
|
"membershipDeletedEventData": {
|
|
4055
4097
|
"$ref": "MembershipDeletedEventData",
|
|
4056
|
-
"description": "
|
|
4098
|
+
"description": "Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`"
|
|
4057
4099
|
},
|
|
4058
4100
|
"membershipUpdatedEventData": {
|
|
4059
4101
|
"$ref": "MembershipUpdatedEventData",
|
|
4060
|
-
"description": "
|
|
4102
|
+
"description": "Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`"
|
|
4061
4103
|
},
|
|
4062
4104
|
"messageBatchCreatedEventData": {
|
|
4063
4105
|
"$ref": "MessageBatchCreatedEventData",
|
|
4064
|
-
"description": "
|
|
4106
|
+
"description": "Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`"
|
|
4065
4107
|
},
|
|
4066
4108
|
"messageBatchDeletedEventData": {
|
|
4067
4109
|
"$ref": "MessageBatchDeletedEventData",
|
|
4068
|
-
"description": "
|
|
4110
|
+
"description": "Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`"
|
|
4069
4111
|
},
|
|
4070
4112
|
"messageBatchUpdatedEventData": {
|
|
4071
4113
|
"$ref": "MessageBatchUpdatedEventData",
|
|
4072
|
-
"description": "
|
|
4114
|
+
"description": "Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`"
|
|
4073
4115
|
},
|
|
4074
4116
|
"messageCreatedEventData": {
|
|
4075
4117
|
"$ref": "MessageCreatedEventData",
|
|
4076
|
-
"description": "
|
|
4118
|
+
"description": "Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`"
|
|
4077
4119
|
},
|
|
4078
4120
|
"messageDeletedEventData": {
|
|
4079
4121
|
"$ref": "MessageDeletedEventData",
|
|
4080
|
-
"description": "
|
|
4122
|
+
"description": "Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`"
|
|
4081
4123
|
},
|
|
4082
4124
|
"messageUpdatedEventData": {
|
|
4083
4125
|
"$ref": "MessageUpdatedEventData",
|
|
4084
|
-
"description": "
|
|
4126
|
+
"description": "Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`"
|
|
4085
4127
|
},
|
|
4086
4128
|
"name": {
|
|
4087
|
-
"description": "
|
|
4129
|
+
"description": "Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`",
|
|
4088
4130
|
"type": "string"
|
|
4089
4131
|
},
|
|
4090
4132
|
"reactionBatchCreatedEventData": {
|
|
4091
4133
|
"$ref": "ReactionBatchCreatedEventData",
|
|
4092
|
-
"description": "
|
|
4134
|
+
"description": "Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`"
|
|
4093
4135
|
},
|
|
4094
4136
|
"reactionBatchDeletedEventData": {
|
|
4095
4137
|
"$ref": "ReactionBatchDeletedEventData",
|
|
4096
|
-
"description": "
|
|
4138
|
+
"description": "Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`"
|
|
4097
4139
|
},
|
|
4098
4140
|
"reactionCreatedEventData": {
|
|
4099
4141
|
"$ref": "ReactionCreatedEventData",
|
|
4100
|
-
"description": "
|
|
4142
|
+
"description": "Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`"
|
|
4101
4143
|
},
|
|
4102
4144
|
"reactionDeletedEventData": {
|
|
4103
4145
|
"$ref": "ReactionDeletedEventData",
|
|
4104
|
-
"description": "
|
|
4146
|
+
"description": "Event payload for a deleted reaction. Event type: `google.workspace.chat.reaction.v1.deleted`"
|
|
4105
4147
|
},
|
|
4106
4148
|
"spaceBatchUpdatedEventData": {
|
|
4107
4149
|
"$ref": "SpaceBatchUpdatedEventData",
|
|
4108
|
-
"description": "
|
|
4150
|
+
"description": "Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`"
|
|
4109
4151
|
},
|
|
4110
4152
|
"spaceUpdatedEventData": {
|
|
4111
4153
|
"$ref": "SpaceUpdatedEventData",
|
|
4112
|
-
"description": "
|
|
4154
|
+
"description": "Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated`"
|
|
4113
4155
|
}
|
|
4114
4156
|
},
|
|
4115
4157
|
"type": "object"
|
|
4116
4158
|
},
|
|
4117
4159
|
"SpaceUpdatedEventData": {
|
|
4118
|
-
"description": "
|
|
4160
|
+
"description": "Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated`",
|
|
4119
4161
|
"id": "SpaceUpdatedEventData",
|
|
4120
4162
|
"properties": {
|
|
4121
4163
|
"space": {
|
|
4122
4164
|
"$ref": "Space",
|
|
4123
|
-
"description": "The
|
|
4165
|
+
"description": "The updated space."
|
|
4124
4166
|
}
|
|
4125
4167
|
},
|
|
4126
4168
|
"type": "object"
|
|
@@ -4182,7 +4224,7 @@
|
|
|
4182
4224
|
"type": "object"
|
|
4183
4225
|
},
|
|
4184
4226
|
"TextParagraph": {
|
|
4185
|
-
"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/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
4227
|
+
"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/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).",
|
|
4186
4228
|
"id": "TextParagraph",
|
|
4187
4229
|
"properties": {
|
|
4188
4230
|
"text": {
|
|
@@ -4192,7 +4234,7 @@
|
|
|
4192
4234
|
"type": "object"
|
|
4193
4235
|
},
|
|
4194
4236
|
"Thread": {
|
|
4195
|
-
"description": "A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/
|
|
4237
|
+
"description": "A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found.",
|
|
4196
4238
|
"id": "Thread",
|
|
4197
4239
|
"properties": {
|
|
4198
4240
|
"name": {
|
|
@@ -4255,6 +4297,7 @@
|
|
|
4255
4297
|
"type": "object"
|
|
4256
4298
|
},
|
|
4257
4299
|
"UploadAttachmentRequest": {
|
|
4300
|
+
"description": "Request to upload an attachment.",
|
|
4258
4301
|
"id": "UploadAttachmentRequest",
|
|
4259
4302
|
"properties": {
|
|
4260
4303
|
"filename": {
|
|
@@ -4265,6 +4308,7 @@
|
|
|
4265
4308
|
"type": "object"
|
|
4266
4309
|
},
|
|
4267
4310
|
"UploadAttachmentResponse": {
|
|
4311
|
+
"description": "Response of uploading an attachment.",
|
|
4268
4312
|
"id": "UploadAttachmentResponse",
|
|
4269
4313
|
"properties": {
|
|
4270
4314
|
"attachmentDataRef": {
|
|
@@ -4275,7 +4319,7 @@
|
|
|
4275
4319
|
"type": "object"
|
|
4276
4320
|
},
|
|
4277
4321
|
"User": {
|
|
4278
|
-
"description": "A user in Google Chat. When returned as an output from a request, if your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
4322
|
+
"description": "A user in Google Chat. When returned as an output from a request, if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource only populates the user's `name` and `type`.",
|
|
4279
4323
|
"id": "User",
|
|
4280
4324
|
"properties": {
|
|
4281
4325
|
"displayName": {
|