Skip to content

Commit 6dedc05

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: improve docs for GetSpaceRequest, EndActiveConferenceRequest, ListConferenceRecordsRequest
feat: Add new OAuth scope `https://www.googleapis.com/auth/meetings.space.settings` to service `SpacesService` PiperOrigin-RevId: 720567690
1 parent 60bab91 commit 6dedc05

3 files changed

Lines changed: 79 additions & 13 deletions

File tree

‎google/apps/meet/v2/meet_v2.yaml‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,25 @@ authentication:
1717
canonical_scopes: |-
1818
https://www.googleapis.com/auth/meetings.space.created,
1919
https://www.googleapis.com/auth/meetings.space.readonly
20-
- selector: 'google.apps.meet.v2.SpacesService.*'
20+
- selector: google.apps.meet.v2.SpacesService.CreateSpace
21+
oauth:
22+
canonical_scopes: |-
23+
https://www.googleapis.com/auth/meetings.space.created
24+
- selector: google.apps.meet.v2.SpacesService.EndActiveConference
2125
oauth:
2226
canonical_scopes: |-
2327
https://www.googleapis.com/auth/meetings.space.created
2428
- selector: google.apps.meet.v2.SpacesService.GetSpace
2529
oauth:
2630
canonical_scopes: |-
2731
https://www.googleapis.com/auth/meetings.space.created,
28-
https://www.googleapis.com/auth/meetings.space.readonly
32+
https://www.googleapis.com/auth/meetings.space.readonly,
33+
https://www.googleapis.com/auth/meetings.space.settings
34+
- selector: google.apps.meet.v2.SpacesService.UpdateSpace
35+
oauth:
36+
canonical_scopes: |-
37+
https://www.googleapis.com/auth/meetings.space.created,
38+
https://www.googleapis.com/auth/meetings.space.settings
2939
3040
publishing:
3141
new_issue_uri: https://issuetracker.google.com/issues/new?component=1216362&template=1766418

‎google/apps/meet/v2/resource.proto‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,28 @@ message Space {
3737
};
3838

3939
// Immutable. Resource name of the space.
40-
// Format: `spaces/{space}`
40+
//
41+
// Format: `spaces/{space}`.
42+
//
43+
// `{space}` is the resource identifier for the space. It's a unique,
44+
// server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`.
45+
//
46+
// For more information, see [How Meet identifies a meeting
47+
// space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
4148
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
4249

43-
// Output only. URI used to join meetings, such as
50+
// Output only. URI used to join meetings consisting of
51+
// `https://meet.google.com/` followed by the `meeting_code`. For example,
4452
// `https://meet.google.com/abc-mnop-xyz`.
4553
string meeting_uri = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
4654

47-
// Output only. Type friendly code to join the meeting. Format:
48-
// `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128
49-
// characters. Can only be used as an alias of the space ID to get the space.
55+
// Output only. Type friendly unique string used to join the meeting.
56+
//
57+
// Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`.
58+
//
59+
// The maximum length is 128 characters.
60+
//
61+
// Can only be used as an alias of the space name to get the space.
5062
string meeting_code = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
5163

5264
// Configuration pertaining to the meeting space.

‎google/apps/meet/v2/service.proto‎

Lines changed: 50 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ service SpacesService {
3737
option (google.api.default_host) = "meet.googleapis.com";
3838
option (google.api.oauth_scopes) =
3939
"https://www.googleapis.com/auth/meetings.space.created,"
40-
"https://www.googleapis.com/auth/meetings.space.readonly";
40+
"https://www.googleapis.com/auth/meetings.space.readonly,"
41+
"https://www.googleapis.com/auth/meetings.space.settings";
4142

4243
// Creates a space.
4344
rpc CreateSpace(CreateSpaceRequest) returns (Space) {
@@ -48,15 +49,21 @@ service SpacesService {
4849
option (google.api.method_signature) = "space";
4950
}
5051

51-
// Gets a space by `space_id` or `meeting_code`.
52+
// Gets details about a meeting space.
53+
//
54+
// For an example, see [Get a meeting
55+
// space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).
5256
rpc GetSpace(GetSpaceRequest) returns (Space) {
5357
option (google.api.http) = {
5458
get: "/v2/{name=spaces/*}"
5559
};
5660
option (google.api.method_signature) = "name";
5761
}
5862

59-
// Updates a space.
63+
// Updates details about a meeting space.
64+
//
65+
// For an example, see [Update a meeting
66+
// space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).
6067
rpc UpdateSpace(UpdateSpaceRequest) returns (Space) {
6168
option (google.api.http) = {
6269
patch: "/v2/{space.name=spaces/*}"
@@ -66,6 +73,9 @@ service SpacesService {
6673
}
6774

6875
// Ends an active conference (if there's one).
76+
//
77+
// For an example, see [End active
78+
// conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).
6979
rpc EndActiveConference(EndActiveConferenceRequest)
7080
returns (google.protobuf.Empty) {
7181
option (google.api.http) = {
@@ -216,6 +226,24 @@ message CreateSpaceRequest {
216226
// Request to get a space.
217227
message GetSpaceRequest {
218228
// Required. Resource name of the space.
229+
//
230+
// Format: `spaces/{space}` or `spaces/{meetingCode}`.
231+
//
232+
// `{space}` is the resource identifier for the space. It's a unique,
233+
// server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`.
234+
//
235+
// `{meetingCode}` is an alias for the space. It's a typeable, unique
236+
// character string and is non-case sensitive. For example, `abc-mnop-xyz`.
237+
// The maximum length is 128 characters.
238+
//
239+
// A `meetingCode` shouldn't be stored long term as it can become
240+
// dissociated from a meeting space and can be reused for different meeting
241+
// spaces in the future. Generally, a `meetingCode` expires 365 days after
242+
// last use. For more information, see [Learn about meeting codes in Google
243+
// Meet](https://support.google.com/meet/answer/10710509).
244+
//
245+
// For more information, see [How Meet identifies a meeting
246+
// space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
219247
string name = 1 [
220248
(google.api.field_behavior) = REQUIRED,
221249
(google.api.resource_reference) = { type: "meet.googleapis.com/Space" }
@@ -228,16 +256,26 @@ message UpdateSpaceRequest {
228256
Space space = 1 [(google.api.field_behavior) = REQUIRED];
229257

230258
// Optional. Field mask used to specify the fields to be updated in the space.
231-
// If update_mask isn't provided, it defaults to '*' and updates all
232-
// fields provided in the request, including deleting fields not set in the
259+
// If update_mask isn't provided(not set, set with empty paths, or only has ""
260+
// as paths), it defaults to update all fields provided with values in the
233261
// request.
262+
// Using "*" as update_mask will update all fields, including deleting fields
263+
// not set in the request.
234264
google.protobuf.FieldMask update_mask = 2
235265
[(google.api.field_behavior) = OPTIONAL];
236266
}
237267

238268
// Request to end an ongoing conference of a space.
239269
message EndActiveConferenceRequest {
240270
// Required. Resource name of the space.
271+
//
272+
// Format: `spaces/{space}`.
273+
//
274+
// `{space}` is the resource identifier for the space. It's a unique,
275+
// server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`.
276+
//
277+
// For more information, see [How Meet identifies a meeting
278+
// space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
241279
string name = 1 [
242280
(google.api.field_behavior) = REQUIRED,
243281
(google.api.resource_reference) = { type: "meet.googleapis.com/Space" }
@@ -275,7 +313,13 @@ message ListConferenceRecordsRequest {
275313
// * `start_time`
276314
// * `end_time`
277315
//
278-
// For example, `space.meeting_code = "abc-mnop-xyz"`.
316+
// For example, consider the following filters:
317+
//
318+
// * `space.name = "spaces/NAME"`
319+
// * `space.meeting_code = "abc-mnop-xyz"`
320+
// * `start_time>="2024-01-01T00:00:00.000Z" AND
321+
// start_time<="2024-01-02T00:00:00.000Z"`
322+
// * `end_time IS NULL`
279323
string filter = 3 [(google.api.field_behavior) = OPTIONAL];
280324
}
281325

0 commit comments

Comments
 (0)