docs: Minor formatting (#379)

- [ ] Regenerate this pull request now. chore: Update gapic-generator-python to v1.11.5 build: Update rules_python to 0.24.0 PiperOrigin-RevId: 563436317 Source-Link: https://togithub.com/googleapis/googleapis/commit/42fd37b18d706f6f51f52f209973b3b2c28f509a Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/280264ca02fb9316b4237a96d0af1a2343a81a56 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9
googleapis · Sep 13, 2023 · eeaa63d · eeaa63d
1 parent 957090a
commit eeaa63d
Show file tree

Hide file tree

Showing 14 changed files with 108 additions and 28 deletions.
diff --git a/...ics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py b/...ics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py
@@ -480,6 +480,7 @@ async def list_accounts(
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> pagers.ListAccountsAsyncPager:
         r"""Returns all accounts accessible by the caller.
+
         Note that these accounts might not currently have GA4
         properties. Soft-deleted (ie: "trashed") accounts are
         excluded by default. Returns an empty list if no
@@ -523,6 +524,7 @@ async def sample_list_accounts():
         Returns:
             google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsAsyncPager:
                 Request message for ListAccounts RPC.
+
                 Iterating over this object will yield
                 results and resolve additional pages
                 automatically.
@@ -570,15 +572,16 @@ async def delete_account(
     ) -> None:
         r"""Marks target Account as soft-deleted (ie: "trashed")
         and returns it.
-
         This API does not have a method to restore soft-deleted
         accounts. However, they can be restored using the Trash
         Can UI.
+
         If the accounts are not restored before the expiration
         time, the account and all child resources (eg:
         Properties, GoogleAdsLinks, Streams, UserLinks) will be
         permanently purged.
         https://support.google.com/analytics/answer/6154772
+
         Returns an error if the target is not found.
 
         .. code-block:: python
@@ -1252,15 +1255,16 @@ async def delete_property(
     ) -> resources.Property:
         r"""Marks target Property as soft-deleted (ie: "trashed")
         and returns it.
-
         This API does not have a method to restore soft-deleted
         properties. However, they can be restored using the
         Trash Can UI.
+
         If the properties are not restored before the expiration
         time, the Property and all child resources (eg:
         GoogleAdsLinks, Streams, UserLinks) will be permanently
         purged.
         https://support.google.com/analytics/answer/6154772
+
         Returns an error if the target is not found, or is not a
         GA4 Property.
 
@@ -1892,6 +1896,7 @@ async def create_user_link(
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> resources.UserLink:
         r"""Creates a user link on an account or property.
+
         If the user with the specified email already has
         permissions on the account or property, then the user's
         existing permissions will be unioned with the
@@ -2458,6 +2463,7 @@ async def create_firebase_link(
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> resources.FirebaseLink:
         r"""Creates a FirebaseLink.
+
         Properties can have at most one FirebaseLink.
 
         .. code-block:: python
@@ -6162,6 +6168,7 @@ async def sample_get_display_video360_advertiser_link_proposal():
                 A proposal for a link between a GA4
                 property and a Display & Video 360
                 advertiser.
+
                 A proposal is converted to a
                 DisplayVideo360AdvertiserLink once
                 approved. Google Analytics admins
@@ -6412,6 +6419,7 @@ async def sample_create_display_video360_advertiser_link_proposal():
                 A proposal for a link between a GA4
                 property and a Display & Video 360
                 advertiser.
+
                 A proposal is converted to a
                 DisplayVideo360AdvertiserLink once
                 approved. Google Analytics admins
@@ -6723,6 +6731,7 @@ async def sample_cancel_display_video360_advertiser_link_proposal():
                 A proposal for a link between a GA4
                 property and a Display & Video 360
                 advertiser.
+
                 A proposal is converted to a
                 DisplayVideo360AdvertiserLink once
                 approved. Google Analytics admins
@@ -13434,6 +13443,7 @@ async def sample_get_event_create_rule():
                 upon matched criteria of a source event.
                 Additional mutations of the parameters
                 from the source event can be defined.
+
                 Unlike Event Edit rules, Event Creation
                 Rules have no defined order.  They will
                 all be run independently.
@@ -13681,6 +13691,7 @@ async def sample_create_event_create_rule():
                 upon matched criteria of a source event.
                 Additional mutations of the parameters
                 from the source event can be defined.
+
                 Unlike Event Edit rules, Event Creation
                 Rules have no defined order.  They will
                 all be run independently.
@@ -13816,6 +13827,7 @@ async def sample_update_event_create_rule():
                 upon matched criteria of a source event.
                 Additional mutations of the parameters
                 from the source event can be defined.
+
                 Unlike Event Edit rules, Event Creation
                 Rules have no defined order.  They will
                 all be run independently.

diff --git a/...analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py b/...analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py
@@ -1068,6 +1068,7 @@ def list_accounts(
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> pagers.ListAccountsPager:
         r"""Returns all accounts accessible by the caller.
+
         Note that these accounts might not currently have GA4
         properties. Soft-deleted (ie: "trashed") accounts are
         excluded by default. Returns an empty list if no
@@ -1111,6 +1112,7 @@ def sample_list_accounts():
         Returns:
             google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsPager:
                 Request message for ListAccounts RPC.
+
                 Iterating over this object will yield
                 results and resolve additional pages
                 automatically.
@@ -1159,15 +1161,16 @@ def delete_account(
     ) -> None:
         r"""Marks target Account as soft-deleted (ie: "trashed")
         and returns it.
-
         This API does not have a method to restore soft-deleted
         accounts. However, they can be restored using the Trash
         Can UI.
+
         If the accounts are not restored before the expiration
         time, the account and all child resources (eg:
         Properties, GoogleAdsLinks, Streams, UserLinks) will be
         permanently purged.
         https://support.google.com/analytics/answer/6154772
+
         Returns an error if the target is not found.
 
         .. code-block:: python
@@ -1844,15 +1847,16 @@ def delete_property(
     ) -> resources.Property:
         r"""Marks target Property as soft-deleted (ie: "trashed")
         and returns it.
-
         This API does not have a method to restore soft-deleted
         properties. However, they can be restored using the
         Trash Can UI.
+
         If the properties are not restored before the expiration
         time, the Property and all child resources (eg:
         GoogleAdsLinks, Streams, UserLinks) will be permanently
         purged.
         https://support.google.com/analytics/answer/6154772
+
         Returns an error if the target is not found, or is not a
         GA4 Property.
 
@@ -2486,6 +2490,7 @@ def create_user_link(
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> resources.UserLink:
         r"""Creates a user link on an account or property.
+
         If the user with the specified email already has
         permissions on the account or property, then the user's
         existing permissions will be unioned with the
@@ -3055,6 +3060,7 @@ def create_firebase_link(
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> resources.FirebaseLink:
         r"""Creates a FirebaseLink.
+
         Properties can have at most one FirebaseLink.
 
         .. code-block:: python
@@ -6847,6 +6853,7 @@ def sample_get_display_video360_advertiser_link_proposal():
                 A proposal for a link between a GA4
                 property and a Display & Video 360
                 advertiser.
+
                 A proposal is converted to a
                 DisplayVideo360AdvertiserLink once
                 approved. Google Analytics admins
@@ -7105,6 +7112,7 @@ def sample_create_display_video360_advertiser_link_proposal():
                 A proposal for a link between a GA4
                 property and a Display & Video 360
                 advertiser.
+
                 A proposal is converted to a
                 DisplayVideo360AdvertiserLink once
                 approved. Google Analytics admins
@@ -7435,6 +7443,7 @@ def sample_cancel_display_video360_advertiser_link_proposal():
                 A proposal for a link between a GA4
                 property and a Display & Video 360
                 advertiser.
+
                 A proposal is converted to a
                 DisplayVideo360AdvertiserLink once
                 approved. Google Analytics admins
@@ -14209,6 +14218,7 @@ def sample_get_event_create_rule():
                 upon matched criteria of a source event.
                 Additional mutations of the parameters
                 from the source event can be defined.
+
                 Unlike Event Edit rules, Event Creation
                 Rules have no defined order.  They will
                 all be run independently.
@@ -14456,6 +14466,7 @@ def sample_create_event_create_rule():
                 upon matched criteria of a source event.
                 Additional mutations of the parameters
                 from the source event can be defined.
+
                 Unlike Event Edit rules, Event Creation
                 Rules have no defined order.  They will
                 all be run independently.
@@ -14591,6 +14602,7 @@ def sample_update_event_create_rule():
                 upon matched criteria of a source event.
                 Additional mutations of the parameters
                 from the source event can be defined.
+
                 Unlike Event Edit rules, Event Creation
                 Rules have no defined order.  They will
                 all be run independently.

diff --git a/...-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py b/...-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py
@@ -274,6 +274,7 @@ def list_accounts(
         r"""Return a callable for the list accounts method over gRPC.
 
         Returns all accounts accessible by the caller.
+
         Note that these accounts might not currently have GA4
         properties. Soft-deleted (ie: "trashed") accounts are
         excluded by default. Returns an empty list if no
@@ -305,15 +306,16 @@ def delete_account(
 
         Marks target Account as soft-deleted (ie: "trashed")
         and returns it.
-
         This API does not have a method to restore soft-deleted
         accounts. However, they can be restored using the Trash
         Can UI.
+
         If the accounts are not restored before the expiration
         time, the account and all child resources (eg:
         Properties, GoogleAdsLinks, Streams, UserLinks) will be
         permanently purged.
         https://support.google.com/analytics/answer/6154772
+
         Returns an error if the target is not found.
 
         Returns:
@@ -514,15 +516,16 @@ def delete_property(
 
         Marks target Property as soft-deleted (ie: "trashed")
         and returns it.
-
         This API does not have a method to restore soft-deleted
         properties. However, they can be restored using the
         Trash Can UI.
+
         If the properties are not restored before the expiration
         time, the Property and all child resources (eg:
         GoogleAdsLinks, Streams, UserLinks) will be permanently
         purged.
         https://support.google.com/analytics/answer/6154772
+
         Returns an error if the target is not found, or is not a
         GA4 Property.
 
@@ -700,6 +703,7 @@ def create_user_link(
         r"""Return a callable for the create user link method over gRPC.
 
         Creates a user link on an account or property.
+
         If the user with the specified email already has
         permissions on the account or property, then the user's
         existing permissions will be unioned with the
@@ -871,6 +875,7 @@ def create_firebase_link(
         r"""Return a callable for the create firebase link method over gRPC.
 
         Creates a FirebaseLink.
+
         Properties can have at most one FirebaseLink.
 
         Returns:

diff --git a/...oogle/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py b/...oogle/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py
@@ -278,6 +278,7 @@ def list_accounts(
         r"""Return a callable for the list accounts method over gRPC.
 
         Returns all accounts accessible by the caller.
+
         Note that these accounts might not currently have GA4
         properties. Soft-deleted (ie: "trashed") accounts are
         excluded by default. Returns an empty list if no
@@ -309,15 +310,16 @@ def delete_account(
 
         Marks target Account as soft-deleted (ie: "trashed")
         and returns it.
-
         This API does not have a method to restore soft-deleted
         accounts. However, they can be restored using the Trash
         Can UI.
+
         If the accounts are not restored before the expiration
         time, the account and all child resources (eg:
         Properties, GoogleAdsLinks, Streams, UserLinks) will be
         permanently purged.
         https://support.google.com/analytics/answer/6154772
+
         Returns an error if the target is not found.
 
         Returns:
@@ -523,15 +525,16 @@ def delete_property(
 
         Marks target Property as soft-deleted (ie: "trashed")
         and returns it.
-
         This API does not have a method to restore soft-deleted
         properties. However, they can be restored using the
         Trash Can UI.
+
         If the properties are not restored before the expiration
         time, the Property and all child resources (eg:
         GoogleAdsLinks, Streams, UserLinks) will be permanently
         purged.
         https://support.google.com/analytics/answer/6154772
+
         Returns an error if the target is not found, or is not a
         GA4 Property.
 
@@ -715,6 +718,7 @@ def create_user_link(
         r"""Return a callable for the create user link method over gRPC.
 
         Creates a user link on an account or property.
+
         If the user with the specified email already has
         permissions on the account or property, then the user's
         existing permissions will be unioned with the
@@ -892,6 +896,7 @@ def create_firebase_link(
         r"""Return a callable for the create firebase link method over gRPC.
 
         Creates a FirebaseLink.
+
         Properties can have at most one FirebaseLink.
 
         Returns:

diff --git a/...-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py b/...-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py
@@ -5336,6 +5336,7 @@ def __call__(
                         A proposal for a link between a GA4
                     property and a Display & Video 360
                     advertiser.
+
                     A proposal is converted to a
                     DisplayVideo360AdvertiserLink once
                     approved. Google Analytics admins
@@ -6461,6 +6462,7 @@ def __call__(
                         A proposal for a link between a GA4
                     property and a Display & Video 360
                     advertiser.
+
                     A proposal is converted to a
                     DisplayVideo360AdvertiserLink once
                     approved. Google Analytics admins
@@ -6582,6 +6584,7 @@ def __call__(
                 upon matched criteria of a source event.
                 Additional mutations of the parameters
                 from the source event can be defined.
+
                 Unlike Event Edit rules, Event Creation
                 Rules have no defined order.  They will
                 all be run independently.
@@ -10436,6 +10439,7 @@ def __call__(
                         A proposal for a link between a GA4
                     property and a Display & Video 360
                     advertiser.
+
                     A proposal is converted to a
                     DisplayVideo360AdvertiserLink once
                     approved. Google Analytics admins
@@ -10642,6 +10646,7 @@ def __call__(
                 upon matched criteria of a source event.
                 Additional mutations of the parameters
                 from the source event can be defined.
+
                 Unlike Event Edit rules, Event Creation
                 Rules have no defined order.  They will
                 all be run independently.
@@ -15224,6 +15229,7 @@ def __call__(
                 upon matched criteria of a source event.
                 Additional mutations of the parameters
                 from the source event can be defined.
+
                 Unlike Event Edit rules, Event Creation
                 Rules have no defined order.  They will
                 all be run independently.