google-adk 0.0.3__py3-none-any.whl → 0.0.5__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.
Files changed (185) hide show
  1. google/adk/agents/run_config.py +4 -0
  2. google/adk/auth/auth_preprocessor.py +19 -16
  3. google/adk/cli/browser/index.html +1 -1
  4. google/adk/cli/browser/{main-SY2WYYGV.js → main-SLIAU2JL.js} +46 -30
  5. google/adk/cli/cli.py +8 -8
  6. google/adk/cli/cli_deploy.py +2 -4
  7. google/adk/cli/cli_tools_click.py +6 -6
  8. google/adk/flows/llm_flows/base_llm_flow.py +1 -1
  9. google/adk/flows/llm_flows/contents.py +21 -1
  10. google/adk/flows/llm_flows/functions.py +3 -1
  11. google/adk/models/google_llm.py +0 -1
  12. google/adk/runners.py +13 -2
  13. google/adk/version.py +1 -1
  14. {google_adk-0.0.3.dist-info → google_adk-0.0.5.dist-info}/METADATA +4 -2
  15. google_adk-0.0.5.dist-info/RECORD +175 -0
  16. {google_adk-0.0.3.dist-info → google_adk-0.0.5.dist-info}/WHEEL +1 -1
  17. google_adk-0.0.5.dist-info/licenses/LICENSE +202 -0
  18. google/adk/._version.py +0 -0
  19. google/adk/docs/Makefile +0 -20
  20. google/adk/docs/build/doctrees/google-adk.doctree +0 -0
  21. google/adk/docs/build/html/_sources/google-adk.rst.txt +0 -98
  22. google/adk/docs/build/html/_sources/index.rst.txt +0 -7
  23. google/adk/docs/build/html/_static/autodoc_pydantic.css +0 -27
  24. google/adk/docs/build/html/_static/basic.css +0 -925
  25. google/adk/docs/build/html/_static/debug.css +0 -85
  26. google/adk/docs/build/html/_static/doctools.js +0 -156
  27. google/adk/docs/build/html/_static/documentation_options.js +0 -29
  28. google/adk/docs/build/html/_static/file.png +0 -0
  29. google/adk/docs/build/html/_static/language_data.js +0 -199
  30. google/adk/docs/build/html/_static/minus.png +0 -0
  31. google/adk/docs/build/html/_static/plus.png +0 -0
  32. google/adk/docs/build/html/_static/pygments.css +0 -274
  33. google/adk/docs/build/html/_static/scripts/furo-extensions.js +0 -16
  34. google/adk/docs/build/html/_static/scripts/furo.js +0 -19
  35. google/adk/docs/build/html/_static/scripts/furo.js.LICENSE.txt +0 -7
  36. google/adk/docs/build/html/_static/scripts/furo.js.map +0 -1
  37. google/adk/docs/build/html/_static/searchtools.js +0 -620
  38. google/adk/docs/build/html/_static/skeleton.css +0 -312
  39. google/adk/docs/build/html/_static/sphinx_highlight.js +0 -170
  40. google/adk/docs/build/html/_static/styles/furo-extensions.css +0 -18
  41. google/adk/docs/build/html/_static/styles/furo-extensions.css.map +0 -1
  42. google/adk/docs/build/html/_static/styles/furo.css +0 -18
  43. google/adk/docs/build/html/_static/styles/furo.css.map +0 -1
  44. google/adk/docs/build/html/genindex.html +0 -861
  45. google/adk/docs/build/html/google-adk.html +0 -5461
  46. google/adk/docs/build/html/index.html +0 -567
  47. google/adk/docs/build/html/objects.inv +0 -0
  48. google/adk/docs/build/html/py-modindex.html +0 -373
  49. google/adk/docs/build/html/search.html +0 -333
  50. google/adk/docs/build/html/searchindex.js +0 -17
  51. google/adk/docs/source/conf.py +0 -133
  52. google/adk/docs/source/google-adk.rst +0 -98
  53. google/adk/docs/source/index.rst +0 -7
  54. google/adk/tests/__init__.py +0 -14
  55. google/adk/tests/integration/.env.example +0 -10
  56. google/adk/tests/integration/__init__.py +0 -18
  57. google/adk/tests/integration/conftest.py +0 -119
  58. google/adk/tests/integration/fixture/__init__.py +0 -14
  59. google/adk/tests/integration/fixture/agent_with_config/__init__.py +0 -15
  60. google/adk/tests/integration/fixture/agent_with_config/agent.py +0 -88
  61. google/adk/tests/integration/fixture/callback_agent/__init__.py +0 -15
  62. google/adk/tests/integration/fixture/callback_agent/agent.py +0 -105
  63. google/adk/tests/integration/fixture/context_update_test/OWNERS +0 -1
  64. google/adk/tests/integration/fixture/context_update_test/__init__.py +0 -15
  65. google/adk/tests/integration/fixture/context_update_test/agent.py +0 -43
  66. google/adk/tests/integration/fixture/context_update_test/successful_test.session.json +0 -582
  67. google/adk/tests/integration/fixture/context_variable_agent/__init__.py +0 -15
  68. google/adk/tests/integration/fixture/context_variable_agent/agent.py +0 -115
  69. google/adk/tests/integration/fixture/customer_support_ma/__init__.py +0 -15
  70. google/adk/tests/integration/fixture/customer_support_ma/agent.py +0 -172
  71. google/adk/tests/integration/fixture/ecommerce_customer_service_agent/__init__.py +0 -15
  72. google/adk/tests/integration/fixture/ecommerce_customer_service_agent/agent.py +0 -338
  73. google/adk/tests/integration/fixture/ecommerce_customer_service_agent/order_query.test.json +0 -69
  74. google/adk/tests/integration/fixture/ecommerce_customer_service_agent/test_config.json +0 -6
  75. google/adk/tests/integration/fixture/flow_complex_spark/__init__.py +0 -15
  76. google/adk/tests/integration/fixture/flow_complex_spark/agent.py +0 -182
  77. google/adk/tests/integration/fixture/flow_complex_spark/sample.session.json +0 -190
  78. google/adk/tests/integration/fixture/hello_world_agent/__init__.py +0 -15
  79. google/adk/tests/integration/fixture/hello_world_agent/agent.py +0 -95
  80. google/adk/tests/integration/fixture/hello_world_agent/roll_die.test.json +0 -24
  81. google/adk/tests/integration/fixture/hello_world_agent/test_config.json +0 -6
  82. google/adk/tests/integration/fixture/home_automation_agent/__init__.py +0 -15
  83. google/adk/tests/integration/fixture/home_automation_agent/agent.py +0 -304
  84. google/adk/tests/integration/fixture/home_automation_agent/simple_test.test.json +0 -5
  85. google/adk/tests/integration/fixture/home_automation_agent/simple_test2.test.json +0 -5
  86. google/adk/tests/integration/fixture/home_automation_agent/test_config.json +0 -5
  87. google/adk/tests/integration/fixture/home_automation_agent/test_files/dependent_tool_calls.test.json +0 -18
  88. google/adk/tests/integration/fixture/home_automation_agent/test_files/memorizing_past_events/eval_data.test.json +0 -17
  89. google/adk/tests/integration/fixture/home_automation_agent/test_files/memorizing_past_events/test_config.json +0 -6
  90. google/adk/tests/integration/fixture/home_automation_agent/test_files/simple_multi_turn_conversation.test.json +0 -18
  91. google/adk/tests/integration/fixture/home_automation_agent/test_files/simple_test.test.json +0 -17
  92. google/adk/tests/integration/fixture/home_automation_agent/test_files/simple_test2.test.json +0 -5
  93. google/adk/tests/integration/fixture/home_automation_agent/test_files/test_config.json +0 -5
  94. google/adk/tests/integration/fixture/tool_agent/__init__.py +0 -15
  95. google/adk/tests/integration/fixture/tool_agent/agent.py +0 -218
  96. google/adk/tests/integration/fixture/tool_agent/files/Agent_test_plan.pdf +0 -0
  97. google/adk/tests/integration/fixture/trip_planner_agent/__init__.py +0 -15
  98. google/adk/tests/integration/fixture/trip_planner_agent/agent.py +0 -110
  99. google/adk/tests/integration/fixture/trip_planner_agent/initial.session.json +0 -13
  100. google/adk/tests/integration/fixture/trip_planner_agent/test_config.json +0 -5
  101. google/adk/tests/integration/fixture/trip_planner_agent/test_files/initial.session.json +0 -13
  102. google/adk/tests/integration/fixture/trip_planner_agent/test_files/test_config.json +0 -5
  103. google/adk/tests/integration/fixture/trip_planner_agent/test_files/trip_inquiry_sub_agent.test.json +0 -7
  104. google/adk/tests/integration/fixture/trip_planner_agent/trip_inquiry.test.json +0 -19
  105. google/adk/tests/integration/models/__init__.py +0 -14
  106. google/adk/tests/integration/models/test_google_llm.py +0 -65
  107. google/adk/tests/integration/test_callback.py +0 -70
  108. google/adk/tests/integration/test_context_variable.py +0 -67
  109. google/adk/tests/integration/test_evalute_agent_in_fixture.py +0 -76
  110. google/adk/tests/integration/test_multi_agent.py +0 -28
  111. google/adk/tests/integration/test_multi_turn.py +0 -42
  112. google/adk/tests/integration/test_single_agent.py +0 -23
  113. google/adk/tests/integration/test_sub_agent.py +0 -26
  114. google/adk/tests/integration/test_system_instruction.py +0 -177
  115. google/adk/tests/integration/test_tools.py +0 -287
  116. google/adk/tests/integration/test_with_test_file.py +0 -34
  117. google/adk/tests/integration/tools/__init__.py +0 -14
  118. google/adk/tests/integration/utils/__init__.py +0 -16
  119. google/adk/tests/integration/utils/asserts.py +0 -75
  120. google/adk/tests/integration/utils/test_runner.py +0 -97
  121. google/adk/tests/unittests/__init__.py +0 -14
  122. google/adk/tests/unittests/agents/__init__.py +0 -14
  123. google/adk/tests/unittests/agents/test_base_agent.py +0 -407
  124. google/adk/tests/unittests/agents/test_langgraph_agent.py +0 -191
  125. google/adk/tests/unittests/agents/test_llm_agent_callbacks.py +0 -138
  126. google/adk/tests/unittests/agents/test_llm_agent_fields.py +0 -231
  127. google/adk/tests/unittests/agents/test_loop_agent.py +0 -136
  128. google/adk/tests/unittests/agents/test_parallel_agent.py +0 -92
  129. google/adk/tests/unittests/agents/test_sequential_agent.py +0 -114
  130. google/adk/tests/unittests/artifacts/__init__.py +0 -14
  131. google/adk/tests/unittests/artifacts/test_artifact_service.py +0 -276
  132. google/adk/tests/unittests/auth/test_auth_handler.py +0 -575
  133. google/adk/tests/unittests/conftest.py +0 -73
  134. google/adk/tests/unittests/fast_api/__init__.py +0 -14
  135. google/adk/tests/unittests/fast_api/test_fast_api.py +0 -269
  136. google/adk/tests/unittests/flows/__init__.py +0 -14
  137. google/adk/tests/unittests/flows/llm_flows/__init__.py +0 -14
  138. google/adk/tests/unittests/flows/llm_flows/_test_examples.py +0 -142
  139. google/adk/tests/unittests/flows/llm_flows/test_agent_transfer.py +0 -311
  140. google/adk/tests/unittests/flows/llm_flows/test_functions_long_running.py +0 -244
  141. google/adk/tests/unittests/flows/llm_flows/test_functions_request_euc.py +0 -346
  142. google/adk/tests/unittests/flows/llm_flows/test_functions_sequential.py +0 -93
  143. google/adk/tests/unittests/flows/llm_flows/test_functions_simple.py +0 -258
  144. google/adk/tests/unittests/flows/llm_flows/test_identity.py +0 -66
  145. google/adk/tests/unittests/flows/llm_flows/test_instructions.py +0 -164
  146. google/adk/tests/unittests/flows/llm_flows/test_model_callbacks.py +0 -142
  147. google/adk/tests/unittests/flows/llm_flows/test_other_configs.py +0 -46
  148. google/adk/tests/unittests/flows/llm_flows/test_tool_callbacks.py +0 -269
  149. google/adk/tests/unittests/models/__init__.py +0 -14
  150. google/adk/tests/unittests/models/test_google_llm.py +0 -224
  151. google/adk/tests/unittests/models/test_litellm.py +0 -804
  152. google/adk/tests/unittests/models/test_models.py +0 -60
  153. google/adk/tests/unittests/sessions/__init__.py +0 -14
  154. google/adk/tests/unittests/sessions/test_session_service.py +0 -227
  155. google/adk/tests/unittests/sessions/test_vertex_ai_session_service.py +0 -246
  156. google/adk/tests/unittests/streaming/__init__.py +0 -14
  157. google/adk/tests/unittests/streaming/test_streaming.py +0 -50
  158. google/adk/tests/unittests/tools/__init__.py +0 -14
  159. google/adk/tests/unittests/tools/apihub_tool/clients/test_apihub_client.py +0 -499
  160. google/adk/tests/unittests/tools/apihub_tool/test_apihub_toolset.py +0 -204
  161. google/adk/tests/unittests/tools/application_integration_tool/clients/test_connections_client.py +0 -600
  162. google/adk/tests/unittests/tools/application_integration_tool/clients/test_integration_client.py +0 -630
  163. google/adk/tests/unittests/tools/application_integration_tool/test_application_integration_toolset.py +0 -345
  164. google/adk/tests/unittests/tools/google_api_tool/__init__.py +0 -13
  165. google/adk/tests/unittests/tools/google_api_tool/test_googleapi_to_openapi_converter.py +0 -657
  166. google/adk/tests/unittests/tools/openapi_tool/auth/credential_exchangers/test_auto_auth_credential_exchanger.py +0 -145
  167. google/adk/tests/unittests/tools/openapi_tool/auth/credential_exchangers/test_base_auth_credential_exchanger.py +0 -68
  168. google/adk/tests/unittests/tools/openapi_tool/auth/credential_exchangers/test_oauth2_exchanger.py +0 -153
  169. google/adk/tests/unittests/tools/openapi_tool/auth/credential_exchangers/test_service_account_exchanger.py +0 -196
  170. google/adk/tests/unittests/tools/openapi_tool/auth/test_auth_helper.py +0 -573
  171. google/adk/tests/unittests/tools/openapi_tool/common/test_common.py +0 -436
  172. google/adk/tests/unittests/tools/openapi_tool/openapi_spec_parser/test.yaml +0 -1367
  173. google/adk/tests/unittests/tools/openapi_tool/openapi_spec_parser/test_openapi_spec_parser.py +0 -628
  174. google/adk/tests/unittests/tools/openapi_tool/openapi_spec_parser/test_openapi_toolset.py +0 -139
  175. google/adk/tests/unittests/tools/openapi_tool/openapi_spec_parser/test_operation_parser.py +0 -406
  176. google/adk/tests/unittests/tools/openapi_tool/openapi_spec_parser/test_rest_api_tool.py +0 -966
  177. google/adk/tests/unittests/tools/openapi_tool/openapi_spec_parser/test_tool_auth_handler.py +0 -201
  178. google/adk/tests/unittests/tools/retrieval/__init__.py +0 -14
  179. google/adk/tests/unittests/tools/retrieval/test_vertex_ai_rag_retrieval.py +0 -147
  180. google/adk/tests/unittests/tools/test_agent_tool.py +0 -167
  181. google/adk/tests/unittests/tools/test_base_tool.py +0 -141
  182. google/adk/tests/unittests/tools/test_build_function_declaration.py +0 -277
  183. google/adk/tests/unittests/utils.py +0 -304
  184. google_adk-0.0.3.dist-info/RECORD +0 -340
  185. {google_adk-0.0.3.dist-info → google_adk-0.0.5.dist-info}/entry_points.txt +0 -0
@@ -1,1367 +0,0 @@
1
- # Copyright 2025 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # http://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
- openapi: 3.0.0
16
- servers:
17
- - url: https://www.googleapis.com/calendar/v3
18
- info:
19
- contact:
20
- name: Google
21
- url: https://google.com
22
- x-twitter: youtube
23
- description: Manipulates events and other calendar data.
24
- license:
25
- name: Creative Commons Attribution 3.0
26
- url: http://creativecommons.org/licenses/by/3.0/
27
- termsOfService: https://developers.google.com/terms/
28
- title: Calendar API
29
- version: v3
30
- x-apiClientRegistration:
31
- url: https://console.developers.google.com
32
- x-apisguru-categories:
33
- - analytics
34
- - media
35
- x-logo:
36
- url: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png
37
- x-origin:
38
- - format: google
39
- url: https://calendar-json.googleapis.com/$discovery/rest?version=v3
40
- version: v1
41
- x-providerName: googleapis.com
42
- x-serviceName: calendar
43
- externalDocs:
44
- url: https://developers.google.com/google-apps/calendar/firstapp
45
- tags:
46
- - name: acl
47
- - name: calendarList
48
- - name: calendars
49
- - name: channels
50
- - name: colors
51
- - name: events
52
- - name: freebusy
53
- - name: settings
54
- paths:
55
- /calendars:
56
- parameters:
57
- - $ref: "#/components/parameters/alt"
58
- - $ref: "#/components/parameters/fields"
59
- - $ref: "#/components/parameters/key"
60
- - $ref: "#/components/parameters/oauth_token"
61
- - $ref: "#/components/parameters/prettyPrint"
62
- - $ref: "#/components/parameters/quotaUser"
63
- - $ref: "#/components/parameters/userIp"
64
- post:
65
- description: Creates a secondary calendar.
66
- operationId: calendar.calendars.insert
67
- requestBody:
68
- content:
69
- application/json:
70
- schema:
71
- $ref: "#/components/schemas/Calendar"
72
- responses:
73
- "200":
74
- content:
75
- application/json:
76
- schema:
77
- $ref: "#/components/schemas/Calendar"
78
- description: Successful response
79
- security:
80
- - Oauth2:
81
- - https://www.googleapis.com/auth/calendar
82
- Oauth2c:
83
- - https://www.googleapis.com/auth/calendar
84
- tags:
85
- - calendars
86
- /calendars/{calendarId}:
87
- delete:
88
- description: Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
89
- operationId: calendar.calendars.delete
90
- parameters:
91
- - description: Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
92
- in: path
93
- name: calendarId
94
- required: true
95
- schema:
96
- type: string
97
- responses:
98
- "200":
99
- description: Successful response
100
- security:
101
- - Oauth2:
102
- - https://www.googleapis.com/auth/calendar
103
- Oauth2c:
104
- - https://www.googleapis.com/auth/calendar
105
- tags:
106
- - calendars
107
- get:
108
- description: Returns metadata for a calendar.
109
- operationId: calendar.calendars.get
110
- parameters:
111
- - description: Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
112
- in: path
113
- name: calendarId
114
- required: true
115
- schema:
116
- type: string
117
- responses:
118
- "200":
119
- content:
120
- application/json:
121
- schema:
122
- $ref: "#/components/schemas/Calendar"
123
- description: Successful response
124
- security:
125
- - Oauth2:
126
- - https://www.googleapis.com/auth/calendar
127
- Oauth2c:
128
- - https://www.googleapis.com/auth/calendar
129
- - Oauth2:
130
- - https://www.googleapis.com/auth/calendar.readonly
131
- Oauth2c:
132
- - https://www.googleapis.com/auth/calendar.readonly
133
- tags:
134
- - calendars
135
- parameters:
136
- - $ref: "#/components/parameters/alt"
137
- - $ref: "#/components/parameters/fields"
138
- - $ref: "#/components/parameters/key"
139
- - $ref: "#/components/parameters/oauth_token"
140
- - $ref: "#/components/parameters/prettyPrint"
141
- - $ref: "#/components/parameters/quotaUser"
142
- - $ref: "#/components/parameters/userIp"
143
- patch:
144
- description: Updates metadata for a calendar. This method supports patch semantics.
145
- operationId: calendar.calendars.patch
146
- parameters:
147
- - description: Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
148
- in: path
149
- name: calendarId
150
- required: true
151
- schema:
152
- type: string
153
- requestBody:
154
- content:
155
- application/json:
156
- schema:
157
- $ref: "#/components/schemas/Calendar"
158
- responses:
159
- "200":
160
- content:
161
- application/json:
162
- schema:
163
- $ref: "#/components/schemas/Calendar"
164
- description: Successful response
165
- security:
166
- - Oauth2:
167
- - https://www.googleapis.com/auth/calendar
168
- Oauth2c:
169
- - https://www.googleapis.com/auth/calendar
170
- tags:
171
- - calendars
172
- put:
173
- description: Updates metadata for a calendar.
174
- operationId: calendar.calendars.update
175
- parameters:
176
- - description: Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
177
- in: path
178
- name: calendarId
179
- required: true
180
- schema:
181
- type: string
182
- requestBody:
183
- content:
184
- application/json:
185
- schema:
186
- $ref: "#/components/schemas/Calendar"
187
- responses:
188
- "200":
189
- content:
190
- application/json:
191
- schema:
192
- $ref: "#/components/schemas/Calendar"
193
- description: Successful response
194
- security:
195
- - Oauth2:
196
- - https://www.googleapis.com/auth/calendar
197
- Oauth2c:
198
- - https://www.googleapis.com/auth/calendar
199
- tags:
200
- - calendars
201
- components:
202
- parameters:
203
- alt:
204
- description: Data format for the response.
205
- in: query
206
- name: alt
207
- schema:
208
- enum:
209
- - json
210
- type: string
211
- fields:
212
- description: Selector specifying which fields to include in a partial response.
213
- in: query
214
- name: fields
215
- schema:
216
- type: string
217
- key:
218
- description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
219
- in: query
220
- name: key
221
- schema:
222
- type: string
223
- oauth_token:
224
- description: OAuth 2.0 token for the current user.
225
- in: query
226
- name: oauth_token
227
- schema:
228
- type: string
229
- prettyPrint:
230
- description: Returns response with indentations and line breaks.
231
- in: query
232
- name: prettyPrint
233
- schema:
234
- type: boolean
235
- quotaUser:
236
- description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
237
- in: query
238
- name: quotaUser
239
- schema:
240
- type: string
241
- userIp:
242
- description: Deprecated. Please use quotaUser instead.
243
- in: query
244
- name: userIp
245
- schema:
246
- type: string
247
- schemas:
248
- Acl:
249
- properties:
250
- etag:
251
- description: ETag of the collection.
252
- type: string
253
- items:
254
- description: List of rules on the access control list.
255
- items:
256
- $ref: "#/components/schemas/AclRule"
257
- type: array
258
- kind:
259
- default: calendar#acl
260
- description: Type of the collection ("calendar#acl").
261
- type: string
262
- nextPageToken:
263
- description: Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
264
- type: string
265
- nextSyncToken:
266
- description: Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
267
- type: string
268
- type: object
269
- AclRule:
270
- properties:
271
- etag:
272
- description: ETag of the resource.
273
- type: string
274
- id:
275
- description: Identifier of the Access Control List (ACL) rule. See Sharing calendars.
276
- type: string
277
- kind:
278
- default: calendar#aclRule
279
- description: Type of the resource ("calendar#aclRule").
280
- type: string
281
- role:
282
- description: |-
283
- The role assigned to the scope. Possible values are:
284
- - "none" - Provides no access.
285
- - "freeBusyReader" - Provides read access to free/busy information.
286
- - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
287
- - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
288
- - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
289
- type: string
290
- scope:
291
- description: The extent to which calendar access is granted by this ACL rule.
292
- properties:
293
- type:
294
- description: |-
295
- The type of the scope. Possible values are:
296
- - "default" - The public scope. This is the default value.
297
- - "user" - Limits the scope to a single user.
298
- - "group" - Limits the scope to a group.
299
- - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
300
- type: string
301
- value:
302
- description: The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
303
- type: string
304
- type: object
305
- type: object
306
- Calendar:
307
- properties:
308
- conferenceProperties:
309
- $ref: "#/components/schemas/ConferenceProperties"
310
- description: Conferencing properties for this calendar, for example what types of conferences are allowed.
311
- description:
312
- description: Description of the calendar. Optional.
313
- type: string
314
- etag:
315
- description: ETag of the resource.
316
- type: string
317
- id:
318
- description: Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
319
- type: string
320
- kind:
321
- default: calendar#calendar
322
- description: Type of the resource ("calendar#calendar").
323
- type: string
324
- location:
325
- description: Geographic location of the calendar as free-form text. Optional.
326
- type: string
327
- summary:
328
- description: Title of the calendar.
329
- type: string
330
- timeZone:
331
- description: The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
332
- type: string
333
- type: object
334
- CalendarList:
335
- properties:
336
- etag:
337
- description: ETag of the collection.
338
- type: string
339
- items:
340
- description: Calendars that are present on the user's calendar list.
341
- items:
342
- $ref: "#/components/schemas/CalendarListEntry"
343
- type: array
344
- kind:
345
- default: calendar#calendarList
346
- description: Type of the collection ("calendar#calendarList").
347
- type: string
348
- nextPageToken:
349
- description: Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
350
- type: string
351
- nextSyncToken:
352
- description: Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
353
- type: string
354
- type: object
355
- CalendarListEntry:
356
- properties:
357
- accessRole:
358
- description: |-
359
- The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
360
- - "freeBusyReader" - Provides read access to free/busy information.
361
- - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
362
- - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
363
- - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
364
- type: string
365
- backgroundColor:
366
- description: The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
367
- type: string
368
- colorId:
369
- description: The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
370
- type: string
371
- conferenceProperties:
372
- $ref: "#/components/schemas/ConferenceProperties"
373
- description: Conferencing properties for this calendar, for example what types of conferences are allowed.
374
- defaultReminders:
375
- description: The default reminders that the authenticated user has for this calendar.
376
- items:
377
- $ref: "#/components/schemas/EventReminder"
378
- type: array
379
- deleted:
380
- default: false
381
- description: Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
382
- type: boolean
383
- description:
384
- description: Description of the calendar. Optional. Read-only.
385
- type: string
386
- etag:
387
- description: ETag of the resource.
388
- type: string
389
- foregroundColor:
390
- description: The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
391
- type: string
392
- hidden:
393
- default: false
394
- description: Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
395
- type: boolean
396
- id:
397
- description: Identifier of the calendar.
398
- type: string
399
- kind:
400
- default: calendar#calendarListEntry
401
- description: Type of the resource ("calendar#calendarListEntry").
402
- type: string
403
- location:
404
- description: Geographic location of the calendar as free-form text. Optional. Read-only.
405
- type: string
406
- notificationSettings:
407
- description: The notifications that the authenticated user is receiving for this calendar.
408
- properties:
409
- notifications:
410
- description: The list of notifications set for this calendar.
411
- items:
412
- $ref: "#/components/schemas/CalendarNotification"
413
- type: array
414
- type: object
415
- primary:
416
- default: false
417
- description: Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
418
- type: boolean
419
- selected:
420
- default: false
421
- description: Whether the calendar content shows up in the calendar UI. Optional. The default is False.
422
- type: boolean
423
- summary:
424
- description: Title of the calendar. Read-only.
425
- type: string
426
- summaryOverride:
427
- description: The summary that the authenticated user has set for this calendar. Optional.
428
- type: string
429
- timeZone:
430
- description: The time zone of the calendar. Optional. Read-only.
431
- type: string
432
- type: object
433
- CalendarNotification:
434
- properties:
435
- method:
436
- description: |-
437
- The method used to deliver the notification. The possible value is:
438
- - "email" - Notifications are sent via email.
439
- Required when adding a notification.
440
- type: string
441
- type:
442
- description: |-
443
- The type of notification. Possible values are:
444
- - "eventCreation" - Notification sent when a new event is put on the calendar.
445
- - "eventChange" - Notification sent when an event is changed.
446
- - "eventCancellation" - Notification sent when an event is cancelled.
447
- - "eventResponse" - Notification sent when an attendee responds to the event invitation.
448
- - "agenda" - An agenda with the events of the day (sent out in the morning).
449
- Required when adding a notification.
450
- type: string
451
- type: object
452
- Channel:
453
- properties:
454
- address:
455
- description: The address where notifications are delivered for this channel.
456
- type: string
457
- expiration:
458
- description: Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
459
- format: int64
460
- type: string
461
- id:
462
- description: A UUID or similar unique string that identifies this channel.
463
- type: string
464
- kind:
465
- default: api#channel
466
- description: Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
467
- type: string
468
- params:
469
- additionalProperties:
470
- description: Declares a new parameter by name.
471
- type: string
472
- description: Additional parameters controlling delivery channel behavior. Optional.
473
- type: object
474
- payload:
475
- description: A Boolean value to indicate whether payload is wanted. Optional.
476
- type: boolean
477
- resourceId:
478
- description: An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
479
- type: string
480
- resourceUri:
481
- description: A version-specific identifier for the watched resource.
482
- type: string
483
- token:
484
- description: An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
485
- type: string
486
- type:
487
- description: The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
488
- type: string
489
- type: object
490
- ColorDefinition:
491
- properties:
492
- background:
493
- description: The background color associated with this color definition.
494
- type: string
495
- foreground:
496
- description: The foreground color that can be used to write on top of a background with 'background' color.
497
- type: string
498
- type: object
499
- Colors:
500
- properties:
501
- calendar:
502
- additionalProperties:
503
- $ref: "#/components/schemas/ColorDefinition"
504
- description: A calendar color definition.
505
- description: A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its colorId field. Read-only.
506
- type: object
507
- event:
508
- additionalProperties:
509
- $ref: "#/components/schemas/ColorDefinition"
510
- description: An event color definition.
511
- description: A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its colorId field. Read-only.
512
- type: object
513
- kind:
514
- default: calendar#colors
515
- description: Type of the resource ("calendar#colors").
516
- type: string
517
- updated:
518
- description: Last modification time of the color palette (as a RFC3339 timestamp). Read-only.
519
- format: date-time
520
- type: string
521
- type: object
522
- ConferenceData:
523
- properties:
524
- conferenceId:
525
- description: |-
526
- The ID of the conference.
527
- Can be used by developers to keep track of conferences, should not be displayed to users.
528
- The ID value is formed differently for each conference solution type:
529
- - eventHangout: ID is not set. (This conference type is deprecated.)
530
- - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)
531
- - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.
532
- - addOn: ID is defined by the third-party provider. Optional.
533
- type: string
534
- conferenceSolution:
535
- $ref: "#/components/schemas/ConferenceSolution"
536
- description: |-
537
- The conference solution, such as Google Meet.
538
- Unset for a conference with a failed create request.
539
- Either conferenceSolution and at least one entryPoint, or createRequest is required.
540
- createRequest:
541
- $ref: "#/components/schemas/CreateConferenceRequest"
542
- description: |-
543
- A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
544
- Either conferenceSolution and at least one entryPoint, or createRequest is required.
545
- entryPoints:
546
- description: |-
547
- Information about individual conference entry points, such as URLs or phone numbers.
548
- All of them must belong to the same conference.
549
- Either conferenceSolution and at least one entryPoint, or createRequest is required.
550
- items:
551
- $ref: "#/components/schemas/EntryPoint"
552
- type: array
553
- notes:
554
- description: Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
555
- type: string
556
- parameters:
557
- $ref: "#/components/schemas/ConferenceParameters"
558
- description: Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
559
- signature:
560
- description: |-
561
- The signature of the conference data.
562
- Generated on server side.
563
- Unset for a conference with a failed create request.
564
- Optional for a conference with a pending create request.
565
- type: string
566
- type: object
567
- ConferenceParameters:
568
- properties:
569
- addOnParameters:
570
- $ref: "#/components/schemas/ConferenceParametersAddOnParameters"
571
- description: Additional add-on specific data.
572
- type: object
573
- ConferenceParametersAddOnParameters:
574
- properties:
575
- parameters:
576
- additionalProperties:
577
- type: string
578
- type: object
579
- type: object
580
- ConferenceProperties:
581
- properties:
582
- allowedConferenceSolutionTypes:
583
- description: |-
584
- The types of conference solutions that are supported for this calendar.
585
- The possible values are:
586
- - "eventHangout"
587
- - "eventNamedHangout"
588
- - "hangoutsMeet" Optional.
589
- items:
590
- type: string
591
- type: array
592
- type: object
593
- ConferenceRequestStatus:
594
- properties:
595
- statusCode:
596
- description: |-
597
- The current status of the conference create request. Read-only.
598
- The possible values are:
599
- - "pending": the conference create request is still being processed.
600
- - "success": the conference create request succeeded, the entry points are populated.
601
- - "failure": the conference create request failed, there are no entry points.
602
- type: string
603
- type: object
604
- ConferenceSolution:
605
- properties:
606
- iconUri:
607
- description: The user-visible icon for this solution.
608
- type: string
609
- key:
610
- $ref: "#/components/schemas/ConferenceSolutionKey"
611
- description: The key which can uniquely identify the conference solution for this event.
612
- name:
613
- description: The user-visible name of this solution. Not localized.
614
- type: string
615
- type: object
616
- ConferenceSolutionKey:
617
- properties:
618
- type:
619
- description: |-
620
- The conference solution type.
621
- If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
622
- The possible values are:
623
- - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)
624
- - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)
625
- - "hangoutsMeet" for Google Meet (http://meet.google.com)
626
- - "addOn" for 3P conference providers
627
- type: string
628
- type: object
629
- CreateConferenceRequest:
630
- properties:
631
- conferenceSolutionKey:
632
- $ref: "#/components/schemas/ConferenceSolutionKey"
633
- description: The conference solution, such as Hangouts or Google Meet.
634
- requestId:
635
- description: |-
636
- The client-generated unique ID for this request.
637
- Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
638
- type: string
639
- status:
640
- $ref: "#/components/schemas/ConferenceRequestStatus"
641
- description: The status of the conference create request.
642
- type: object
643
- EntryPoint:
644
- properties:
645
- accessCode:
646
- description: |-
647
- The access code to access the conference. The maximum length is 128 characters.
648
- When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
649
- Optional.
650
- type: string
651
- entryPointFeatures:
652
- description: Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
653
- items:
654
- type: string
655
- type: array
656
- entryPointType:
657
- description: |-
658
- The type of the conference entry point.
659
- Possible values are:
660
- - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
661
- - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
662
- - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
663
- - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
664
- type: string
665
- label:
666
- description: |-
667
- The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
668
- Examples:
669
- - for video: meet.google.com/aaa-bbbb-ccc
670
- - for phone: +1 123 268 2601
671
- - for sip: 12345678@altostrat.com
672
- - for more: should not be filled
673
- Optional.
674
- type: string
675
- meetingCode:
676
- description: |-
677
- The meeting code to access the conference. The maximum length is 128 characters.
678
- When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
679
- Optional.
680
- type: string
681
- passcode:
682
- description: |-
683
- The passcode to access the conference. The maximum length is 128 characters.
684
- When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
685
- type: string
686
- password:
687
- description: |-
688
- The password to access the conference. The maximum length is 128 characters.
689
- When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
690
- Optional.
691
- type: string
692
- pin:
693
- description: |-
694
- The PIN to access the conference. The maximum length is 128 characters.
695
- When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
696
- Optional.
697
- type: string
698
- regionCode:
699
- description: |-
700
- The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
701
- Calendar backend will populate this field only for EntryPointType.PHONE.
702
- type: string
703
- uri:
704
- description: |-
705
- The URI of the entry point. The maximum length is 1300 characters.
706
- Format:
707
- - for video, http: or https: schema is required.
708
- - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
709
- - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
710
- - for more, http: or https: schema is required.
711
- type: string
712
- type: object
713
- Error:
714
- properties:
715
- domain:
716
- description: Domain, or broad category, of the error.
717
- type: string
718
- reason:
719
- description: |-
720
- Specific reason for the error. Some of the possible values are:
721
- - "groupTooBig" - The group of users requested is too large for a single query.
722
- - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query.
723
- - "notFound" - The requested resource was not found.
724
- - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.
725
- type: string
726
- type: object
727
- Event:
728
- properties:
729
- anyoneCanAddSelf:
730
- default: false
731
- description: Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.
732
- type: boolean
733
- attachments:
734
- description: |-
735
- File attachments for the event.
736
- In order to modify attachments the supportsAttachments request parameter should be set to true.
737
- There can be at most 25 attachments per event,
738
- items:
739
- $ref: "#/components/schemas/EventAttachment"
740
- type: array
741
- attendees:
742
- description: The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.
743
- items:
744
- $ref: "#/components/schemas/EventAttendee"
745
- type: array
746
- attendeesOmitted:
747
- default: false
748
- description: Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
749
- type: boolean
750
- colorId:
751
- description: The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
752
- type: string
753
- conferenceData:
754
- $ref: "#/components/schemas/ConferenceData"
755
- description: The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
756
- created:
757
- description: Creation time of the event (as a RFC3339 timestamp). Read-only.
758
- format: date-time
759
- type: string
760
- creator:
761
- description: The creator of the event. Read-only.
762
- properties:
763
- displayName:
764
- description: The creator's name, if available.
765
- type: string
766
- email:
767
- description: The creator's email address, if available.
768
- type: string
769
- id:
770
- description: The creator's Profile ID, if available.
771
- type: string
772
- self:
773
- default: false
774
- description: Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
775
- type: boolean
776
- type: object
777
- description:
778
- description: Description of the event. Can contain HTML. Optional.
779
- type: string
780
- end:
781
- $ref: "#/components/schemas/EventDateTime"
782
- description: The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
783
- endTimeUnspecified:
784
- default: false
785
- description: Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
786
- type: boolean
787
- etag:
788
- description: ETag of the resource.
789
- type: string
790
- eventType:
791
- default: default
792
- description: |-
793
- Specific type of the event. This cannot be modified after the event is created. Possible values are:
794
- - "default" - A regular event or not further specified.
795
- - "outOfOffice" - An out-of-office event.
796
- - "focusTime" - A focus-time event.
797
- - "workingLocation" - A working location event. Currently, only "default " and "workingLocation" events can be created using the API. Extended support for other event types will be made available in later releases.
798
- type: string
799
- extendedProperties:
800
- description: Extended properties of the event.
801
- properties:
802
- private:
803
- additionalProperties:
804
- description: The name of the private property and the corresponding value.
805
- type: string
806
- description: Properties that are private to the copy of the event that appears on this calendar.
807
- type: object
808
- shared:
809
- additionalProperties:
810
- description: The name of the shared property and the corresponding value.
811
- type: string
812
- description: Properties that are shared between copies of the event on other attendees' calendars.
813
- type: object
814
- type: object
815
- focusTimeProperties:
816
- $ref: "#/components/schemas/EventFocusTimeProperties"
817
- description: Focus Time event data. Used if eventType is focusTime.
818
- gadget:
819
- description: A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.
820
- properties:
821
- display:
822
- description: |-
823
- The gadget's display mode. Deprecated. Possible values are:
824
- - "icon" - The gadget displays next to the event's title in the calendar view.
825
- - "chip" - The gadget displays when the event is clicked.
826
- type: string
827
- height:
828
- description: The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.
829
- format: int32
830
- type: integer
831
- iconLink:
832
- description: The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.
833
- type: string
834
- link:
835
- description: The gadget's URL. The URL scheme must be HTTPS. Deprecated.
836
- type: string
837
- preferences:
838
- additionalProperties:
839
- description: The preference name and corresponding value.
840
- type: string
841
- description: Preferences.
842
- type: object
843
- title:
844
- description: The gadget's title. Deprecated.
845
- type: string
846
- type:
847
- description: The gadget's type. Deprecated.
848
- type: string
849
- width:
850
- description: The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.
851
- format: int32
852
- type: integer
853
- type: object
854
- guestsCanInviteOthers:
855
- default: true
856
- description: Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
857
- type: boolean
858
- guestsCanModify:
859
- default: false
860
- description: Whether attendees other than the organizer can modify the event. Optional. The default is False.
861
- type: boolean
862
- guestsCanSeeOtherGuests:
863
- default: true
864
- description: Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
865
- type: boolean
866
- hangoutLink:
867
- description: An absolute link to the Google Hangout associated with this event. Read-only.
868
- type: string
869
- htmlLink:
870
- description: An absolute link to this event in the Google Calendar Web UI. Read-only.
871
- type: string
872
- iCalUID:
873
- description: |-
874
- Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
875
- Note that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.
876
- type: string
877
- id:
878
- description: |-
879
- Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
880
- - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
881
- - the length of the ID must be between 5 and 1024 characters
882
- - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
883
- If you do not specify an ID, it will be automatically generated by the server.
884
- Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
885
- type: string
886
- kind:
887
- default: calendar#event
888
- description: Type of the resource ("calendar#event").
889
- type: string
890
- location:
891
- description: Geographic location of the event as free-form text. Optional.
892
- type: string
893
- locked:
894
- default: false
895
- description: Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
896
- type: boolean
897
- organizer:
898
- description: The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.
899
- properties:
900
- displayName:
901
- description: The organizer's name, if available.
902
- type: string
903
- email:
904
- description: The organizer's email address, if available. It must be a valid email address as per RFC5322.
905
- type: string
906
- id:
907
- description: The organizer's Profile ID, if available.
908
- type: string
909
- self:
910
- default: false
911
- description: Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
912
- type: boolean
913
- type: object
914
- originalStartTime:
915
- $ref: "#/components/schemas/EventDateTime"
916
- description: For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
917
- outOfOfficeProperties:
918
- $ref: "#/components/schemas/EventOutOfOfficeProperties"
919
- description: Out of office event data. Used if eventType is outOfOffice.
920
- privateCopy:
921
- default: false
922
- description: If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
923
- type: boolean
924
- recurrence:
925
- description: List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
926
- items:
927
- type: string
928
- type: array
929
- recurringEventId:
930
- description: For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
931
- type: string
932
- reminders:
933
- description: Information about the event's reminders for the authenticated user.
934
- properties:
935
- overrides:
936
- description: If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.
937
- items:
938
- $ref: "#/components/schemas/EventReminder"
939
- type: array
940
- useDefault:
941
- description: Whether the default reminders of the calendar apply to the event.
942
- type: boolean
943
- type: object
944
- sequence:
945
- description: Sequence number as per iCalendar.
946
- format: int32
947
- type: integer
948
- source:
949
- description: Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
950
- properties:
951
- title:
952
- description: Title of the source; for example a title of a web page or an email subject.
953
- type: string
954
- url:
955
- description: URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
956
- type: string
957
- type: object
958
- start:
959
- $ref: "#/components/schemas/EventDateTime"
960
- description: The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
961
- status:
962
- description: |-
963
- Status of the event. Optional. Possible values are:
964
- - "confirmed" - The event is confirmed. This is the default status.
965
- - "tentative" - The event is tentatively confirmed.
966
- - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
967
- A cancelled status represents two different states depending on the event type:
968
- - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
969
- Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
970
- - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
971
- Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
972
- If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
973
- type: string
974
- summary:
975
- description: Title of the event.
976
- type: string
977
- transparency:
978
- default: opaque
979
- description: |-
980
- Whether the event blocks time on the calendar. Optional. Possible values are:
981
- - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
982
- - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
983
- type: string
984
- updated:
985
- description: Last modification time of the event (as a RFC3339 timestamp). Read-only.
986
- format: date-time
987
- type: string
988
- visibility:
989
- default: default
990
- description: |-
991
- Visibility of the event. Optional. Possible values are:
992
- - "default" - Uses the default visibility for events on the calendar. This is the default value.
993
- - "public" - The event is public and event details are visible to all readers of the calendar.
994
- - "private" - The event is private and only event attendees may view event details.
995
- - "confidential" - The event is private. This value is provided for compatibility reasons.
996
- type: string
997
- workingLocationProperties:
998
- $ref: "#/components/schemas/EventWorkingLocationProperties"
999
- description: Working location event data.
1000
- type: object
1001
- EventAttachment:
1002
- properties:
1003
- fileId:
1004
- description: |-
1005
- ID of the attached file. Read-only.
1006
- For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
1007
- type: string
1008
- fileUrl:
1009
- description: |-
1010
- URL link to the attachment.
1011
- For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
1012
- Required when adding an attachment.
1013
- type: string
1014
- iconLink:
1015
- description: URL link to the attachment's icon. This field can only be modified for custom third-party attachments.
1016
- type: string
1017
- mimeType:
1018
- description: Internet media type (MIME type) of the attachment.
1019
- type: string
1020
- title:
1021
- description: Attachment title.
1022
- type: string
1023
- type: object
1024
- EventAttendee:
1025
- properties:
1026
- additionalGuests:
1027
- default: 0
1028
- description: Number of additional guests. Optional. The default is 0.
1029
- format: int32
1030
- type: integer
1031
- comment:
1032
- description: The attendee's response comment. Optional.
1033
- type: string
1034
- displayName:
1035
- description: The attendee's name, if available. Optional.
1036
- type: string
1037
- email:
1038
- description: |-
1039
- The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
1040
- Required when adding an attendee.
1041
- type: string
1042
- id:
1043
- description: The attendee's Profile ID, if available.
1044
- type: string
1045
- optional:
1046
- default: false
1047
- description: Whether this is an optional attendee. Optional. The default is False.
1048
- type: boolean
1049
- organizer:
1050
- description: Whether the attendee is the organizer of the event. Read-only. The default is False.
1051
- type: boolean
1052
- resource:
1053
- default: false
1054
- description: Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
1055
- type: boolean
1056
- responseStatus:
1057
- description: |-
1058
- The attendee's response status. Possible values are:
1059
- - "needsAction" - The attendee has not responded to the invitation (recommended for new events).
1060
- - "declined" - The attendee has declined the invitation.
1061
- - "tentative" - The attendee has tentatively accepted the invitation.
1062
- - "accepted" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the "Add invitations to my calendar" setting set to "When I respond to invitation in email" won't see an event on their calendar unless they choose to change their invitation response in the event invitation email.
1063
- type: string
1064
- self:
1065
- default: false
1066
- description: Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1067
- type: boolean
1068
- type: object
1069
- EventDateTime:
1070
- properties:
1071
- date:
1072
- description: The date, in the format "yyyy-mm-dd", if this is an all-day event.
1073
- format: date
1074
- type: string
1075
- dateTime:
1076
- description: The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
1077
- format: date-time
1078
- type: string
1079
- timeZone:
1080
- description: The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
1081
- type: string
1082
- type: object
1083
- EventFocusTimeProperties:
1084
- properties:
1085
- autoDeclineMode:
1086
- description: Whether to decline meeting invitations which overlap Focus Time events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Focus Time event is present are to be declined.
1087
- type: string
1088
- chatStatus:
1089
- description: The status to mark the user in Chat and related products. This can be available or doNotDisturb.
1090
- type: string
1091
- declineMessage:
1092
- description: Response message to set if an existing event or new invitation is automatically declined by Calendar.
1093
- type: string
1094
- type: object
1095
- EventOutOfOfficeProperties:
1096
- properties:
1097
- autoDeclineMode:
1098
- description: Whether to decline meeting invitations which overlap Out of office events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Out of office event is present are to be declined.
1099
- type: string
1100
- declineMessage:
1101
- description: Response message to set if an existing event or new invitation is automatically declined by Calendar.
1102
- type: string
1103
- type: object
1104
- EventReminder:
1105
- properties:
1106
- method:
1107
- description: |-
1108
- The method used by this reminder. Possible values are:
1109
- - "email" - Reminders are sent via email.
1110
- - "popup" - Reminders are sent via a UI popup.
1111
- Required when adding a reminder.
1112
- type: string
1113
- minutes:
1114
- description: |-
1115
- Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
1116
- Required when adding a reminder.
1117
- format: int32
1118
- type: integer
1119
- type: object
1120
- EventWorkingLocationProperties:
1121
- properties:
1122
- customLocation:
1123
- description: If present, specifies that the user is working from a custom location.
1124
- properties:
1125
- label:
1126
- description: An optional extra label for additional information.
1127
- type: string
1128
- type: object
1129
- homeOffice:
1130
- description: If present, specifies that the user is working at home.
1131
- officeLocation:
1132
- description: If present, specifies that the user is working from an office.
1133
- properties:
1134
- buildingId:
1135
- description: An optional building identifier. This should reference a building ID in the organization's Resources database.
1136
- type: string
1137
- deskId:
1138
- description: An optional desk identifier.
1139
- type: string
1140
- floorId:
1141
- description: An optional floor identifier.
1142
- type: string
1143
- floorSectionId:
1144
- description: An optional floor section identifier.
1145
- type: string
1146
- label:
1147
- description: The office name that's displayed in Calendar Web and Mobile clients. We recommend you reference a building name in the organization's Resources database.
1148
- type: string
1149
- type: object
1150
- type:
1151
- description: |-
1152
- Type of the working location. Possible values are:
1153
- - "homeOffice" - The user is working at home.
1154
- - "officeLocation" - The user is working from an office.
1155
- - "customLocation" - The user is working from a custom location. Any details are specified in a sub-field of the specified name, but this field may be missing if empty. Any other fields are ignored.
1156
- Required when adding working location properties.
1157
- type: string
1158
- type: object
1159
- Events:
1160
- properties:
1161
- accessRole:
1162
- description: |-
1163
- The user's access role for this calendar. Read-only. Possible values are:
1164
- - "none" - The user has no access.
1165
- - "freeBusyReader" - The user has read access to free/busy information.
1166
- - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
1167
- - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
1168
- - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
1169
- type: string
1170
- defaultReminders:
1171
- description: The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).
1172
- items:
1173
- $ref: "#/components/schemas/EventReminder"
1174
- type: array
1175
- description:
1176
- description: Description of the calendar. Read-only.
1177
- type: string
1178
- etag:
1179
- description: ETag of the collection.
1180
- type: string
1181
- items:
1182
- description: List of events on the calendar.
1183
- items:
1184
- $ref: "#/components/schemas/Event"
1185
- type: array
1186
- kind:
1187
- default: calendar#events
1188
- description: Type of the collection ("calendar#events").
1189
- type: string
1190
- nextPageToken:
1191
- description: Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
1192
- type: string
1193
- nextSyncToken:
1194
- description: Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
1195
- type: string
1196
- summary:
1197
- description: Title of the calendar. Read-only.
1198
- type: string
1199
- timeZone:
1200
- description: The time zone of the calendar. Read-only.
1201
- type: string
1202
- updated:
1203
- description: Last modification time of the calendar (as a RFC3339 timestamp). Read-only.
1204
- format: date-time
1205
- type: string
1206
- type: object
1207
- FreeBusyCalendar:
1208
- properties:
1209
- busy:
1210
- description: List of time ranges during which this calendar should be regarded as busy.
1211
- items:
1212
- $ref: "#/components/schemas/TimePeriod"
1213
- type: array
1214
- errors:
1215
- description: Optional error(s) (if computation for the calendar failed).
1216
- items:
1217
- $ref: "#/components/schemas/Error"
1218
- type: array
1219
- type: object
1220
- FreeBusyGroup:
1221
- properties:
1222
- calendars:
1223
- description: List of calendars' identifiers within a group.
1224
- items:
1225
- type: string
1226
- type: array
1227
- errors:
1228
- description: Optional error(s) (if computation for the group failed).
1229
- items:
1230
- $ref: "#/components/schemas/Error"
1231
- type: array
1232
- type: object
1233
- FreeBusyRequest:
1234
- properties:
1235
- calendarExpansionMax:
1236
- description: Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.
1237
- format: int32
1238
- type: integer
1239
- groupExpansionMax:
1240
- description: Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.
1241
- format: int32
1242
- type: integer
1243
- items:
1244
- description: List of calendars and/or groups to query.
1245
- items:
1246
- $ref: "#/components/schemas/FreeBusyRequestItem"
1247
- type: array
1248
- timeMax:
1249
- description: The end of the interval for the query formatted as per RFC3339.
1250
- format: date-time
1251
- type: string
1252
- timeMin:
1253
- description: The start of the interval for the query formatted as per RFC3339.
1254
- format: date-time
1255
- type: string
1256
- timeZone:
1257
- default: UTC
1258
- description: Time zone used in the response. Optional. The default is UTC.
1259
- type: string
1260
- type: object
1261
- FreeBusyRequestItem:
1262
- properties:
1263
- id:
1264
- description: The identifier of a calendar or a group.
1265
- type: string
1266
- type: object
1267
- FreeBusyResponse:
1268
- properties:
1269
- calendars:
1270
- additionalProperties:
1271
- $ref: "#/components/schemas/FreeBusyCalendar"
1272
- description: Free/busy expansions for a single calendar.
1273
- description: List of free/busy information for calendars.
1274
- type: object
1275
- groups:
1276
- additionalProperties:
1277
- $ref: "#/components/schemas/FreeBusyGroup"
1278
- description: List of calendars that are members of this group.
1279
- description: Expansion of groups.
1280
- type: object
1281
- kind:
1282
- default: calendar#freeBusy
1283
- description: Type of the resource ("calendar#freeBusy").
1284
- type: string
1285
- timeMax:
1286
- description: The end of the interval.
1287
- format: date-time
1288
- type: string
1289
- timeMin:
1290
- description: The start of the interval.
1291
- format: date-time
1292
- type: string
1293
- type: object
1294
- Setting:
1295
- properties:
1296
- etag:
1297
- description: ETag of the resource.
1298
- type: string
1299
- id:
1300
- description: The id of the user setting.
1301
- type: string
1302
- kind:
1303
- default: calendar#setting
1304
- description: Type of the resource ("calendar#setting").
1305
- type: string
1306
- value:
1307
- description: Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.
1308
- type: string
1309
- type: object
1310
- Settings:
1311
- properties:
1312
- etag:
1313
- description: Etag of the collection.
1314
- type: string
1315
- items:
1316
- description: List of user settings.
1317
- items:
1318
- $ref: "#/components/schemas/Setting"
1319
- type: array
1320
- kind:
1321
- default: calendar#settings
1322
- description: Type of the collection ("calendar#settings").
1323
- type: string
1324
- nextPageToken:
1325
- description: Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
1326
- type: string
1327
- nextSyncToken:
1328
- description: Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
1329
- type: string
1330
- type: object
1331
- TimePeriod:
1332
- properties:
1333
- end:
1334
- description: The (exclusive) end of the time period.
1335
- format: date-time
1336
- type: string
1337
- start:
1338
- description: The (inclusive) start of the time period.
1339
- format: date-time
1340
- type: string
1341
- type: object
1342
- securitySchemes:
1343
- Oauth2:
1344
- description: Oauth 2.0 implicit authentication
1345
- flows:
1346
- implicit:
1347
- authorizationUrl: https://accounts.google.com/o/oauth2/auth
1348
- scopes:
1349
- https://www.googleapis.com/auth/calendar: See, edit, share, and permanently delete all the calendars you can access using Google Calendar
1350
- https://www.googleapis.com/auth/calendar.events: View and edit events on all your calendars
1351
- https://www.googleapis.com/auth/calendar.events.readonly: View events on all your calendars
1352
- https://www.googleapis.com/auth/calendar.readonly: See and download any calendar you can access using your Google Calendar
1353
- https://www.googleapis.com/auth/calendar.settings.readonly: View your Calendar settings
1354
- type: oauth2
1355
- Oauth2c:
1356
- description: Oauth 2.0 authorizationCode authentication
1357
- flows:
1358
- authorizationCode:
1359
- authorizationUrl: https://accounts.google.com/o/oauth2/auth
1360
- scopes:
1361
- https://www.googleapis.com/auth/calendar: See, edit, share, and permanently delete all the calendars you can access using Google Calendar
1362
- https://www.googleapis.com/auth/calendar.events: View and edit events on all your calendars
1363
- https://www.googleapis.com/auth/calendar.events.readonly: View events on all your calendars
1364
- https://www.googleapis.com/auth/calendar.readonly: See and download any calendar you can access using your Google Calendar
1365
- https://www.googleapis.com/auth/calendar.settings.readonly: View your Calendar settings
1366
- tokenUrl: https://accounts.google.com/o/oauth2/token
1367
- type: oauth2