Skip to content

Commit 7b23175

Browse files
docs: [google-apps-meet] improve docs for GetSpaceRequest, EndActiveConferenceRequest, ListConferenceRecordsRequest (#13471)
- [ ] Regenerate this pull request now. BEGIN_COMMIT_OVERRIDE docs: improve docs for GetSpaceRequest, EndActiveConferenceRequest, ListConferenceRecordsRequest 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` END_COMMIT_OVERRIDE 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 BEGIN_NESTED_COMMIT feat: [google-apps-meet] 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 END_NESTED_COMMIT --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent f699e5f commit 7b23175

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+8725
-1399
lines changed

packages/google-apps-meet/docs/meet_v2beta/spaces_service.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ SpacesService
44
.. automodule:: google.apps.meet_v2beta.services.spaces_service
55
:members:
66
:inherited-members:
7+
8+
.. automodule:: google.apps.meet_v2beta.services.spaces_service.pagers
9+
:members:
10+
:inherited-members:

packages/google-apps-meet/google/apps/meet/gapic_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.1.11" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

packages/google-apps-meet/google/apps/meet_v2/gapic_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.1.11" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

packages/google-apps-meet/google/apps/meet_v2/services/spaces_service/async_client.py

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,10 @@ async def get_space(
403403
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
404404
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
405405
) -> resource.Space:
406-
r"""Gets a space by ``space_id`` or ``meeting_code``.
406+
r"""Gets details about a meeting space.
407+
408+
For an example, see `Get a meeting
409+
space <https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space>`__.
407410
408411
.. code-block:: python
409412
@@ -436,6 +439,29 @@ async def sample_get_space():
436439
The request object. Request to get a space.
437440
name (:class:`str`):
438441
Required. Resource name of the space.
442+
443+
Format: ``spaces/{space}`` or ``spaces/{meetingCode}``.
444+
445+
``{space}`` is the resource identifier for the space.
446+
It's a unique, server-generated ID and is case
447+
sensitive. For example, ``jQCFfuBOdN5z``.
448+
449+
``{meetingCode}`` is an alias for the space. It's a
450+
typeable, unique character string and is non-case
451+
sensitive. For example, ``abc-mnop-xyz``. The maximum
452+
length is 128 characters.
453+
454+
A ``meetingCode`` shouldn't be stored long term as it
455+
can become dissociated from a meeting space and can be
456+
reused for different meeting spaces in the future.
457+
Generally, a ``meetingCode`` expires 365 days after last
458+
use. For more information, see `Learn about meeting
459+
codes in Google
460+
Meet <https://support.google.com/meet/answer/10710509>`__.
461+
462+
For more information, see `How Meet identifies a meeting
463+
space <https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space>`__.
464+
439465
This corresponds to the ``name`` field
440466
on the ``request`` instance; if ``request`` is provided, this
441467
should not be set.
@@ -510,7 +536,10 @@ async def update_space(
510536
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
511537
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
512538
) -> resource.Space:
513-
r"""Updates a space.
539+
r"""Updates details about a meeting space.
540+
541+
For an example, see `Update a meeting
542+
space <https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space>`__.
514543
515544
.. code-block:: python
516545
@@ -547,9 +576,11 @@ async def sample_update_space():
547576
should not be set.
548577
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
549578
Optional. Field mask used to specify the fields to be
550-
updated in the space. If update_mask isn't provided, it
551-
defaults to '*' and updates all fields provided in the
552-
request, including deleting fields not set in the
579+
updated in the space. If update_mask isn't provided(not
580+
set, set with empty paths, or only has "" as paths), it
581+
defaults to update all fields provided with values in
582+
the request. Using "*" as update_mask will update all
583+
fields, including deleting fields not set in the
553584
request.
554585
555586
This corresponds to the ``update_mask`` field
@@ -631,6 +662,9 @@ async def end_active_conference(
631662
) -> None:
632663
r"""Ends an active conference (if there's one).
633664
665+
For an example, see `End active
666+
conference <https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference>`__.
667+
634668
.. code-block:: python
635669
636670
# This snippet has been automatically generated and should be regarded as a
@@ -660,6 +694,16 @@ async def sample_end_active_conference():
660694
of a space.
661695
name (:class:`str`):
662696
Required. Resource name of the space.
697+
698+
Format: ``spaces/{space}``.
699+
700+
``{space}`` is the resource identifier for the space.
701+
It's a unique, server-generated ID and is case
702+
sensitive. For example, ``jQCFfuBOdN5z``.
703+
704+
For more information, see `How Meet identifies a meeting
705+
space <https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space>`__.
706+
663707
This corresponds to the ``name`` field
664708
on the ``request`` instance; if ``request`` is provided, this
665709
should not be set.

packages/google-apps-meet/google/apps/meet_v2/services/spaces_service/client.py

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -796,7 +796,10 @@ def get_space(
796796
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
797797
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
798798
) -> resource.Space:
799-
r"""Gets a space by ``space_id`` or ``meeting_code``.
799+
r"""Gets details about a meeting space.
800+
801+
For an example, see `Get a meeting
802+
space <https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space>`__.
800803
801804
.. code-block:: python
802805
@@ -829,6 +832,29 @@ def sample_get_space():
829832
The request object. Request to get a space.
830833
name (str):
831834
Required. Resource name of the space.
835+
836+
Format: ``spaces/{space}`` or ``spaces/{meetingCode}``.
837+
838+
``{space}`` is the resource identifier for the space.
839+
It's a unique, server-generated ID and is case
840+
sensitive. For example, ``jQCFfuBOdN5z``.
841+
842+
``{meetingCode}`` is an alias for the space. It's a
843+
typeable, unique character string and is non-case
844+
sensitive. For example, ``abc-mnop-xyz``. The maximum
845+
length is 128 characters.
846+
847+
A ``meetingCode`` shouldn't be stored long term as it
848+
can become dissociated from a meeting space and can be
849+
reused for different meeting spaces in the future.
850+
Generally, a ``meetingCode`` expires 365 days after last
851+
use. For more information, see `Learn about meeting
852+
codes in Google
853+
Meet <https://support.google.com/meet/answer/10710509>`__.
854+
855+
For more information, see `How Meet identifies a meeting
856+
space <https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space>`__.
857+
832858
This corresponds to the ``name`` field
833859
on the ``request`` instance; if ``request`` is provided, this
834860
should not be set.
@@ -900,7 +926,10 @@ def update_space(
900926
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
901927
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
902928
) -> resource.Space:
903-
r"""Updates a space.
929+
r"""Updates details about a meeting space.
930+
931+
For an example, see `Update a meeting
932+
space <https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space>`__.
904933
905934
.. code-block:: python
906935
@@ -937,9 +966,11 @@ def sample_update_space():
937966
should not be set.
938967
update_mask (google.protobuf.field_mask_pb2.FieldMask):
939968
Optional. Field mask used to specify the fields to be
940-
updated in the space. If update_mask isn't provided, it
941-
defaults to '*' and updates all fields provided in the
942-
request, including deleting fields not set in the
969+
updated in the space. If update_mask isn't provided(not
970+
set, set with empty paths, or only has "" as paths), it
971+
defaults to update all fields provided with values in
972+
the request. Using "*" as update_mask will update all
973+
fields, including deleting fields not set in the
943974
request.
944975
945976
This corresponds to the ``update_mask`` field
@@ -1018,6 +1049,9 @@ def end_active_conference(
10181049
) -> None:
10191050
r"""Ends an active conference (if there's one).
10201051
1052+
For an example, see `End active
1053+
conference <https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference>`__.
1054+
10211055
.. code-block:: python
10221056
10231057
# This snippet has been automatically generated and should be regarded as a
@@ -1047,6 +1081,16 @@ def sample_end_active_conference():
10471081
of a space.
10481082
name (str):
10491083
Required. Resource name of the space.
1084+
1085+
Format: ``spaces/{space}``.
1086+
1087+
``{space}`` is the resource identifier for the space.
1088+
It's a unique, server-generated ID and is case
1089+
sensitive. For example, ``jQCFfuBOdN5z``.
1090+
1091+
For more information, see `How Meet identifies a meeting
1092+
space <https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space>`__.
1093+
10501094
This corresponds to the ``name`` field
10511095
on the ``request`` instance; if ``request`` is provided, this
10521096
should not be set.

packages/google-apps-meet/google/apps/meet_v2/services/spaces_service/transports/base.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ class SpacesServiceTransport(abc.ABC):
3939
AUTH_SCOPES = (
4040
"https://www.googleapis.com/auth/meetings.space.created",
4141
"https://www.googleapis.com/auth/meetings.space.readonly",
42+
"https://www.googleapis.com/auth/meetings.space.settings",
4243
)
4344

4445
DEFAULT_HOST: str = "meet.googleapis.com"

packages/google-apps-meet/google/apps/meet_v2/services/spaces_service/transports/grpc.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,10 @@ def create_space(self) -> Callable[[service.CreateSpaceRequest], resource.Space]
349349
def get_space(self) -> Callable[[service.GetSpaceRequest], resource.Space]:
350350
r"""Return a callable for the get space method over gRPC.
351351
352-
Gets a space by ``space_id`` or ``meeting_code``.
352+
Gets details about a meeting space.
353+
354+
For an example, see `Get a meeting
355+
space <https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space>`__.
353356
354357
Returns:
355358
Callable[[~.GetSpaceRequest],
@@ -373,7 +376,10 @@ def get_space(self) -> Callable[[service.GetSpaceRequest], resource.Space]:
373376
def update_space(self) -> Callable[[service.UpdateSpaceRequest], resource.Space]:
374377
r"""Return a callable for the update space method over gRPC.
375378
376-
Updates a space.
379+
Updates details about a meeting space.
380+
381+
For an example, see `Update a meeting
382+
space <https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space>`__.
377383
378384
Returns:
379385
Callable[[~.UpdateSpaceRequest],
@@ -401,6 +407,9 @@ def end_active_conference(
401407
402408
Ends an active conference (if there's one).
403409
410+
For an example, see `End active
411+
conference <https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference>`__.
412+
404413
Returns:
405414
Callable[[~.EndActiveConferenceRequest],
406415
~.Empty]:

packages/google-apps-meet/google/apps/meet_v2/services/spaces_service/transports/grpc_asyncio.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,10 @@ def get_space(
360360
) -> Callable[[service.GetSpaceRequest], Awaitable[resource.Space]]:
361361
r"""Return a callable for the get space method over gRPC.
362362
363-
Gets a space by ``space_id`` or ``meeting_code``.
363+
Gets details about a meeting space.
364+
365+
For an example, see `Get a meeting
366+
space <https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space>`__.
364367
365368
Returns:
366369
Callable[[~.GetSpaceRequest],
@@ -386,7 +389,10 @@ def update_space(
386389
) -> Callable[[service.UpdateSpaceRequest], Awaitable[resource.Space]]:
387390
r"""Return a callable for the update space method over gRPC.
388391
389-
Updates a space.
392+
Updates details about a meeting space.
393+
394+
For an example, see `Update a meeting
395+
space <https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space>`__.
390396
391397
Returns:
392398
Callable[[~.UpdateSpaceRequest],
@@ -414,6 +420,9 @@ def end_active_conference(
414420
415421
Ends an active conference (if there's one).
416422
423+
For an example, see `End active
424+
conference <https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference>`__.
425+
417426
Returns:
418427
Callable[[~.EndActiveConferenceRequest],
419428
Awaitable[~.Empty]]:

packages/google-apps-meet/google/apps/meet_v2/types/resource.py

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,32 @@ class Space(proto.Message):
4747
4848
Attributes:
4949
name (str):
50-
Immutable. Resource name of the space. Format:
51-
``spaces/{space}``
50+
Immutable. Resource name of the space.
51+
52+
Format: ``spaces/{space}``.
53+
54+
``{space}`` is the resource identifier for the space. It's a
55+
unique, server-generated ID and is case sensitive. For
56+
example, ``jQCFfuBOdN5z``.
57+
58+
For more information, see `How Meet identifies a meeting
59+
space <https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space>`__.
5260
meeting_uri (str):
53-
Output only. URI used to join meetings, such as
61+
Output only. URI used to join meetings consisting of
62+
``https://meet.google.com/`` followed by the
63+
``meeting_code``. For example,
5464
``https://meet.google.com/abc-mnop-xyz``.
5565
meeting_code (str):
56-
Output only. Type friendly code to join the meeting. Format:
57-
``[a-z]+-[a-z]+-[a-z]+`` such as ``abc-mnop-xyz``. The
58-
maximum length is 128 characters. Can only be used as an
59-
alias of the space ID to get the space.
66+
Output only. Type friendly unique string used to join the
67+
meeting.
68+
69+
Format: ``[a-z]+-[a-z]+-[a-z]+``. For example,
70+
``abc-mnop-xyz``.
71+
72+
The maximum length is 128 characters.
73+
74+
Can only be used as an alias of the space name to get the
75+
space.
6076
config (google.apps.meet_v2.types.SpaceConfig):
6177
Configuration pertaining to the meeting
6278
space.

0 commit comments

Comments
 (0)