Skip to content

Commit eeaa63d

Browse files
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
1 parent 957090a commit eeaa63d

File tree

14 files changed

+108
-28
lines changed

14 files changed

+108
-28
lines changed

packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,7 @@ async def list_accounts(
480480
metadata: Sequence[Tuple[str, str]] = (),
481481
) -> pagers.ListAccountsAsyncPager:
482482
r"""Returns all accounts accessible by the caller.
483+
483484
Note that these accounts might not currently have GA4
484485
properties. Soft-deleted (ie: "trashed") accounts are
485486
excluded by default. Returns an empty list if no
@@ -523,6 +524,7 @@ async def sample_list_accounts():
523524
Returns:
524525
google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsAsyncPager:
525526
Request message for ListAccounts RPC.
527+
526528
Iterating over this object will yield
527529
results and resolve additional pages
528530
automatically.
@@ -570,15 +572,16 @@ async def delete_account(
570572
) -> None:
571573
r"""Marks target Account as soft-deleted (ie: "trashed")
572574
and returns it.
573-
574575
This API does not have a method to restore soft-deleted
575576
accounts. However, they can be restored using the Trash
576577
Can UI.
578+
577579
If the accounts are not restored before the expiration
578580
time, the account and all child resources (eg:
579581
Properties, GoogleAdsLinks, Streams, UserLinks) will be
580582
permanently purged.
581583
https://support.google.com/analytics/answer/6154772
584+
582585
Returns an error if the target is not found.
583586

584587
.. code-block:: python
@@ -1252,15 +1255,16 @@ async def delete_property(
12521255
) -> resources.Property:
12531256
r"""Marks target Property as soft-deleted (ie: "trashed")
12541257
and returns it.
1255-
12561258
This API does not have a method to restore soft-deleted
12571259
properties. However, they can be restored using the
12581260
Trash Can UI.
1261+
12591262
If the properties are not restored before the expiration
12601263
time, the Property and all child resources (eg:
12611264
GoogleAdsLinks, Streams, UserLinks) will be permanently
12621265
purged.
12631266
https://support.google.com/analytics/answer/6154772
1267+
12641268
Returns an error if the target is not found, or is not a
12651269
GA4 Property.
12661270

@@ -1892,6 +1896,7 @@ async def create_user_link(
18921896
metadata: Sequence[Tuple[str, str]] = (),
18931897
) -> resources.UserLink:
18941898
r"""Creates a user link on an account or property.
1899+
18951900
If the user with the specified email already has
18961901
permissions on the account or property, then the user's
18971902
existing permissions will be unioned with the
@@ -2458,6 +2463,7 @@ async def create_firebase_link(
24582463
metadata: Sequence[Tuple[str, str]] = (),
24592464
) -> resources.FirebaseLink:
24602465
r"""Creates a FirebaseLink.
2466+
24612467
Properties can have at most one FirebaseLink.
24622468

24632469
.. code-block:: python
@@ -6162,6 +6168,7 @@ async def sample_get_display_video360_advertiser_link_proposal():
61626168
A proposal for a link between a GA4
61636169
property and a Display & Video 360
61646170
advertiser.
6171+
61656172
A proposal is converted to a
61666173
DisplayVideo360AdvertiserLink once
61676174
approved. Google Analytics admins
@@ -6412,6 +6419,7 @@ async def sample_create_display_video360_advertiser_link_proposal():
64126419
A proposal for a link between a GA4
64136420
property and a Display & Video 360
64146421
advertiser.
6422+
64156423
A proposal is converted to a
64166424
DisplayVideo360AdvertiserLink once
64176425
approved. Google Analytics admins
@@ -6723,6 +6731,7 @@ async def sample_cancel_display_video360_advertiser_link_proposal():
67236731
A proposal for a link between a GA4
67246732
property and a Display & Video 360
67256733
advertiser.
6734+
67266735
A proposal is converted to a
67276736
DisplayVideo360AdvertiserLink once
67286737
approved. Google Analytics admins
@@ -13434,6 +13443,7 @@ async def sample_get_event_create_rule():
1343413443
upon matched criteria of a source event.
1343513444
Additional mutations of the parameters
1343613445
from the source event can be defined.
13446+
1343713447
Unlike Event Edit rules, Event Creation
1343813448
Rules have no defined order. They will
1343913449
all be run independently.
@@ -13681,6 +13691,7 @@ async def sample_create_event_create_rule():
1368113691
upon matched criteria of a source event.
1368213692
Additional mutations of the parameters
1368313693
from the source event can be defined.
13694+
1368413695
Unlike Event Edit rules, Event Creation
1368513696
Rules have no defined order. They will
1368613697
all be run independently.
@@ -13816,6 +13827,7 @@ async def sample_update_event_create_rule():
1381613827
upon matched criteria of a source event.
1381713828
Additional mutations of the parameters
1381813829
from the source event can be defined.
13830+
1381913831
Unlike Event Edit rules, Event Creation
1382013832
Rules have no defined order. They will
1382113833
all be run independently.

packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1068,6 +1068,7 @@ def list_accounts(
10681068
metadata: Sequence[Tuple[str, str]] = (),
10691069
) -> pagers.ListAccountsPager:
10701070
r"""Returns all accounts accessible by the caller.
1071+
10711072
Note that these accounts might not currently have GA4
10721073
properties. Soft-deleted (ie: "trashed") accounts are
10731074
excluded by default. Returns an empty list if no
@@ -1111,6 +1112,7 @@ def sample_list_accounts():
11111112
Returns:
11121113
google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsPager:
11131114
Request message for ListAccounts RPC.
1115+
11141116
Iterating over this object will yield
11151117
results and resolve additional pages
11161118
automatically.
@@ -1159,15 +1161,16 @@ def delete_account(
11591161
) -> None:
11601162
r"""Marks target Account as soft-deleted (ie: "trashed")
11611163
and returns it.
1162-
11631164
This API does not have a method to restore soft-deleted
11641165
accounts. However, they can be restored using the Trash
11651166
Can UI.
1167+
11661168
If the accounts are not restored before the expiration
11671169
time, the account and all child resources (eg:
11681170
Properties, GoogleAdsLinks, Streams, UserLinks) will be
11691171
permanently purged.
11701172
https://support.google.com/analytics/answer/6154772
1173+
11711174
Returns an error if the target is not found.
11721175

11731176
.. code-block:: python
@@ -1844,15 +1847,16 @@ def delete_property(
18441847
) -> resources.Property:
18451848
r"""Marks target Property as soft-deleted (ie: "trashed")
18461849
and returns it.
1847-
18481850
This API does not have a method to restore soft-deleted
18491851
properties. However, they can be restored using the
18501852
Trash Can UI.
1853+
18511854
If the properties are not restored before the expiration
18521855
time, the Property and all child resources (eg:
18531856
GoogleAdsLinks, Streams, UserLinks) will be permanently
18541857
purged.
18551858
https://support.google.com/analytics/answer/6154772
1859+
18561860
Returns an error if the target is not found, or is not a
18571861
GA4 Property.
18581862

@@ -2486,6 +2490,7 @@ def create_user_link(
24862490
metadata: Sequence[Tuple[str, str]] = (),
24872491
) -> resources.UserLink:
24882492
r"""Creates a user link on an account or property.
2493+
24892494
If the user with the specified email already has
24902495
permissions on the account or property, then the user's
24912496
existing permissions will be unioned with the
@@ -3055,6 +3060,7 @@ def create_firebase_link(
30553060
metadata: Sequence[Tuple[str, str]] = (),
30563061
) -> resources.FirebaseLink:
30573062
r"""Creates a FirebaseLink.
3063+
30583064
Properties can have at most one FirebaseLink.
30593065

30603066
.. code-block:: python
@@ -6847,6 +6853,7 @@ def sample_get_display_video360_advertiser_link_proposal():
68476853
A proposal for a link between a GA4
68486854
property and a Display & Video 360
68496855
advertiser.
6856+
68506857
A proposal is converted to a
68516858
DisplayVideo360AdvertiserLink once
68526859
approved. Google Analytics admins
@@ -7105,6 +7112,7 @@ def sample_create_display_video360_advertiser_link_proposal():
71057112
A proposal for a link between a GA4
71067113
property and a Display & Video 360
71077114
advertiser.
7115+
71087116
A proposal is converted to a
71097117
DisplayVideo360AdvertiserLink once
71107118
approved. Google Analytics admins
@@ -7435,6 +7443,7 @@ def sample_cancel_display_video360_advertiser_link_proposal():
74357443
A proposal for a link between a GA4
74367444
property and a Display & Video 360
74377445
advertiser.
7446+
74387447
A proposal is converted to a
74397448
DisplayVideo360AdvertiserLink once
74407449
approved. Google Analytics admins
@@ -14209,6 +14218,7 @@ def sample_get_event_create_rule():
1420914218
upon matched criteria of a source event.
1421014219
Additional mutations of the parameters
1421114220
from the source event can be defined.
14221+
1421214222
Unlike Event Edit rules, Event Creation
1421314223
Rules have no defined order. They will
1421414224
all be run independently.
@@ -14456,6 +14466,7 @@ def sample_create_event_create_rule():
1445614466
upon matched criteria of a source event.
1445714467
Additional mutations of the parameters
1445814468
from the source event can be defined.
14469+
1445914470
Unlike Event Edit rules, Event Creation
1446014471
Rules have no defined order. They will
1446114472
all be run independently.
@@ -14591,6 +14602,7 @@ def sample_update_event_create_rule():
1459114602
upon matched criteria of a source event.
1459214603
Additional mutations of the parameters
1459314604
from the source event can be defined.
14605+
1459414606
Unlike Event Edit rules, Event Creation
1459514607
Rules have no defined order. They will
1459614608
all be run independently.

packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,7 @@ def list_accounts(
274274
r"""Return a callable for the list accounts method over gRPC.
275275
276276
Returns all accounts accessible by the caller.
277+
277278
Note that these accounts might not currently have GA4
278279
properties. Soft-deleted (ie: "trashed") accounts are
279280
excluded by default. Returns an empty list if no
@@ -305,15 +306,16 @@ def delete_account(
305306
306307
Marks target Account as soft-deleted (ie: "trashed")
307308
and returns it.
308-
309309
This API does not have a method to restore soft-deleted
310310
accounts. However, they can be restored using the Trash
311311
Can UI.
312+
312313
If the accounts are not restored before the expiration
313314
time, the account and all child resources (eg:
314315
Properties, GoogleAdsLinks, Streams, UserLinks) will be
315316
permanently purged.
316317
https://support.google.com/analytics/answer/6154772
318+
317319
Returns an error if the target is not found.
318320
319321
Returns:
@@ -514,15 +516,16 @@ def delete_property(
514516
515517
Marks target Property as soft-deleted (ie: "trashed")
516518
and returns it.
517-
518519
This API does not have a method to restore soft-deleted
519520
properties. However, they can be restored using the
520521
Trash Can UI.
522+
521523
If the properties are not restored before the expiration
522524
time, the Property and all child resources (eg:
523525
GoogleAdsLinks, Streams, UserLinks) will be permanently
524526
purged.
525527
https://support.google.com/analytics/answer/6154772
528+
526529
Returns an error if the target is not found, or is not a
527530
GA4 Property.
528531
@@ -700,6 +703,7 @@ def create_user_link(
700703
r"""Return a callable for the create user link method over gRPC.
701704
702705
Creates a user link on an account or property.
706+
703707
If the user with the specified email already has
704708
permissions on the account or property, then the user's
705709
existing permissions will be unioned with the
@@ -871,6 +875,7 @@ def create_firebase_link(
871875
r"""Return a callable for the create firebase link method over gRPC.
872876
873877
Creates a FirebaseLink.
878+
874879
Properties can have at most one FirebaseLink.
875880
876881
Returns:

packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,7 @@ def list_accounts(
278278
r"""Return a callable for the list accounts method over gRPC.
279279
280280
Returns all accounts accessible by the caller.
281+
281282
Note that these accounts might not currently have GA4
282283
properties. Soft-deleted (ie: "trashed") accounts are
283284
excluded by default. Returns an empty list if no
@@ -309,15 +310,16 @@ def delete_account(
309310
310311
Marks target Account as soft-deleted (ie: "trashed")
311312
and returns it.
312-
313313
This API does not have a method to restore soft-deleted
314314
accounts. However, they can be restored using the Trash
315315
Can UI.
316+
316317
If the accounts are not restored before the expiration
317318
time, the account and all child resources (eg:
318319
Properties, GoogleAdsLinks, Streams, UserLinks) will be
319320
permanently purged.
320321
https://support.google.com/analytics/answer/6154772
322+
321323
Returns an error if the target is not found.
322324
323325
Returns:
@@ -523,15 +525,16 @@ def delete_property(
523525
524526
Marks target Property as soft-deleted (ie: "trashed")
525527
and returns it.
526-
527528
This API does not have a method to restore soft-deleted
528529
properties. However, they can be restored using the
529530
Trash Can UI.
531+
530532
If the properties are not restored before the expiration
531533
time, the Property and all child resources (eg:
532534
GoogleAdsLinks, Streams, UserLinks) will be permanently
533535
purged.
534536
https://support.google.com/analytics/answer/6154772
537+
535538
Returns an error if the target is not found, or is not a
536539
GA4 Property.
537540
@@ -715,6 +718,7 @@ def create_user_link(
715718
r"""Return a callable for the create user link method over gRPC.
716719
717720
Creates a user link on an account or property.
721+
718722
If the user with the specified email already has
719723
permissions on the account or property, then the user's
720724
existing permissions will be unioned with the
@@ -892,6 +896,7 @@ def create_firebase_link(
892896
r"""Return a callable for the create firebase link method over gRPC.
893897
894898
Creates a FirebaseLink.
899+
895900
Properties can have at most one FirebaseLink.
896901
897902
Returns:

packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5336,6 +5336,7 @@ def __call__(
53365336
A proposal for a link between a GA4
53375337
property and a Display & Video 360
53385338
advertiser.
5339+
53395340
A proposal is converted to a
53405341
DisplayVideo360AdvertiserLink once
53415342
approved. Google Analytics admins
@@ -6461,6 +6462,7 @@ def __call__(
64616462
A proposal for a link between a GA4
64626463
property and a Display & Video 360
64636464
advertiser.
6465+
64646466
A proposal is converted to a
64656467
DisplayVideo360AdvertiserLink once
64666468
approved. Google Analytics admins
@@ -6582,6 +6584,7 @@ def __call__(
65826584
upon matched criteria of a source event.
65836585
Additional mutations of the parameters
65846586
from the source event can be defined.
6587+
65856588
Unlike Event Edit rules, Event Creation
65866589
Rules have no defined order. They will
65876590
all be run independently.
@@ -10436,6 +10439,7 @@ def __call__(
1043610439
A proposal for a link between a GA4
1043710440
property and a Display & Video 360
1043810441
advertiser.
10442+
1043910443
A proposal is converted to a
1044010444
DisplayVideo360AdvertiserLink once
1044110445
approved. Google Analytics admins
@@ -10642,6 +10646,7 @@ def __call__(
1064210646
upon matched criteria of a source event.
1064310647
Additional mutations of the parameters
1064410648
from the source event can be defined.
10649+
1064510650
Unlike Event Edit rules, Event Creation
1064610651
Rules have no defined order. They will
1064710652
all be run independently.
@@ -15224,6 +15229,7 @@ def __call__(
1522415229
upon matched criteria of a source event.
1522515230
Additional mutations of the parameters
1522615231
from the source event can be defined.
15232+
1522715233
Unlike Event Edit rules, Event Creation
1522815234
Rules have no defined order. They will
1522915235
all be run independently.

0 commit comments

Comments
 (0)