Skip to content

Commit

Permalink
docs: [meet] improve docs for GetSpaceRequest, EndActiveConferenceReq…
Browse files Browse the repository at this point in the history 
…uest, ListConferenceRecordsRequest (#5986)

* feat: Add methods for [configuring meeting spaces and members](https://developers.google.com/meet/api/guides/beta/configuration-beta)
docs: Improve docs for `GetSpaceRequest`, `EndActiveConferenceRequest`, `ListConferenceRecordsRequest`
docs: Remove *Developer Preview* label from methods that are now generally available
feat: Add new OAuth scope `https://www.googleapis.com/auth/meetings.space.settings` to service `SpacesService`

PiperOrigin-RevId: 720295894

Source-Link: googleapis/googleapis@137b7e6

Source-Link: googleapis/googleapis-gen@f8d8ba2
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwcHMtbWVldC8uT3dsQm90LnlhbWwiLCJoIjoiZjhkOGJhMjFmZDdmMDNmMmFhOGE1NDA2ZGY4ZTE4YTM3OTFiYzcyYyJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 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

Source-Link: googleapis/googleapis@6dedc05

Source-Link: googleapis/googleapis-gen@cb6d86d
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwcHMtbWVldC8uT3dsQm90LnlhbWwiLCJoIjoiY2I2ZDg2ZDIzNTI2NThiYmZjNTQzYzQ0ZTQzZTRkYzM4MjdmZGIwYiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Jan 28, 2025
1 parent e958ab7 commit 891a80f
Show file tree
Hide file tree
Showing 33 changed files with 7,703 additions and 432 deletions.
4 changes: 4 additions & 0 deletions packages/google-apps-meet/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,13 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
| Conference_records_service.list_recordings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/conference_records_service.list_recordings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/conference_records_service.list_recordings.js,packages/google-apps-meet/samples/README.md) |
| Conference_records_service.list_transcript_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/conference_records_service.list_transcript_entries.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/conference_records_service.list_transcript_entries.js,packages/google-apps-meet/samples/README.md) |
| Conference_records_service.list_transcripts | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/conference_records_service.list_transcripts.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/conference_records_service.list_transcripts.js,packages/google-apps-meet/samples/README.md) |
| Spaces_service.create_member | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/spaces_service.create_member.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/spaces_service.create_member.js,packages/google-apps-meet/samples/README.md) |
| Spaces_service.create_space | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/spaces_service.create_space.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/spaces_service.create_space.js,packages/google-apps-meet/samples/README.md) |
| Spaces_service.delete_member | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/spaces_service.delete_member.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/spaces_service.delete_member.js,packages/google-apps-meet/samples/README.md) |
| Spaces_service.end_active_conference | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/spaces_service.end_active_conference.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/spaces_service.end_active_conference.js,packages/google-apps-meet/samples/README.md) |
| Spaces_service.get_member | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/spaces_service.get_member.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/spaces_service.get_member.js,packages/google-apps-meet/samples/README.md) |
| Spaces_service.get_space | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/spaces_service.get_space.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/spaces_service.get_space.js,packages/google-apps-meet/samples/README.md) |
| Spaces_service.list_members | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/spaces_service.list_members.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/spaces_service.list_members.js,packages/google-apps-meet/samples/README.md) |
| Spaces_service.update_space | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/generated/v2beta/spaces_service.update_space.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/generated/v2beta/spaces_service.update_space.js,packages/google-apps-meet/samples/README.md) |
| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-apps-meet/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-apps-meet/samples/quickstart.js,packages/google-apps-meet/samples/README.md) |

Expand Down
22 changes: 17 additions & 5 deletions packages/google-apps-meet/protos/google/apps/meet/v2/resource.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,28 @@ message Space {
};

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

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

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

// Configuration pertaining to the meeting space.
Expand Down
56 changes: 50 additions & 6 deletions packages/google-apps-meet/protos/google/apps/meet/v2/service.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ service SpacesService {
option (google.api.default_host) = "meet.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/meetings.space.created,"
"https://www.googleapis.com/auth/meetings.space.readonly";
"https://www.googleapis.com/auth/meetings.space.readonly,"
"https://www.googleapis.com/auth/meetings.space.settings";

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

// Gets a space by `space_id` or `meeting_code`.
// Gets details about a meeting space.
//
// For an example, see [Get a meeting
// space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).
rpc GetSpace(GetSpaceRequest) returns (Space) {
option (google.api.http) = {
get: "/v2/{name=spaces/*}"
};
option (google.api.method_signature) = "name";
}

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

// Ends an active conference (if there's one).
//
// For an example, see [End active
// conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).
rpc EndActiveConference(EndActiveConferenceRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
Expand Down Expand Up @@ -216,6 +226,24 @@ message CreateSpaceRequest {
// Request to get a space.
message GetSpaceRequest {
// Required. Resource name of the space.
//
// Format: `spaces/{space}` or `spaces/{meetingCode}`.
//
// `{space}` is the resource identifier for the space. It's a unique,
// server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`.
//
// `{meetingCode}` is an alias for the space. It's a typeable, unique
// character string and is non-case sensitive. For example, `abc-mnop-xyz`.
// The maximum length is 128 characters.
//
// A `meetingCode` shouldn't be stored long term as it can become
// dissociated from a meeting space and can be reused for different meeting
// spaces in the future. Generally, a `meetingCode` expires 365 days after
// last use. For more information, see [Learn about meeting codes in Google
// Meet](https://support.google.com/meet/answer/10710509).
//
// For more information, see [How Meet identifies a meeting
// space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "meet.googleapis.com/Space" }
Expand All @@ -228,16 +256,26 @@ message UpdateSpaceRequest {
Space space = 1 [(google.api.field_behavior) = REQUIRED];

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

// Request to end an ongoing conference of a space.
message EndActiveConferenceRequest {
// Required. Resource name of the space.
//
// Format: `spaces/{space}`.
//
// `{space}` is the resource identifier for the space. It's a unique,
// server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`.
//
// For more information, see [How Meet identifies a meeting
// space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "meet.googleapis.com/Space" }
Expand Down Expand Up @@ -275,7 +313,13 @@ message ListConferenceRecordsRequest {
// * `start_time`
// * `end_time`
//
// For example, `space.meeting_code = "abc-mnop-xyz"`.
// For example, consider the following filters:
//
// * `space.name = "spaces/NAME"`
// * `space.meeting_code = "abc-mnop-xyz"`
// * `start_time>="2024-01-01T00:00:00.000Z" AND
// start_time<="2024-01-02T00:00:00.000Z"`
// * `end_time IS NULL`
string filter = 3 [(google.api.field_behavior) = OPTIONAL];
}

Expand Down
Loading

0 comments on commit 891a80f

Please sign in to comment.