From ab8a30b637284a9526fae5b85e05b1c54891c609 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 13 Sep 2023 20:38:14 +0000 Subject: [PATCH] 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 --- .../analytics_admin_service/async_client.py | 16 ++++++++++++++-- .../services/analytics_admin_service/client.py | 16 ++++++++++++++-- .../analytics_admin_service/transports/grpc.py | 9 +++++++-- .../transports/grpc_asyncio.py | 9 +++++++-- .../analytics_admin_service/transports/rest.py | 6 ++++++ .../admin_v1alpha/types/analytics_admin.py | 15 +++++++++------ .../admin_v1alpha/types/event_create_and_edit.py | 1 + .../analytics/admin_v1alpha/types/resources.py | 12 ++++++++++++ .../analytics_admin_service/async_client.py | 9 +++++++-- .../services/analytics_admin_service/client.py | 9 +++++++-- .../analytics_admin_service/transports/grpc.py | 8 ++++++-- .../transports/grpc_asyncio.py | 8 ++++++-- .../admin_v1beta/types/analytics_admin.py | 14 ++++++++------ google/analytics/admin_v1beta/types/resources.py | 4 ++++ 14 files changed, 108 insertions(+), 28 deletions(-) diff --git a/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py b/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py index 3941d5fb..a19d1c4b 100644 --- a/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py +++ b/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/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py b/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py index 5a2bfc21..99b23878 100644 --- a/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py +++ b/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/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py b/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py index e8b37147..88158844 100644 --- a/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py +++ b/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/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py b/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py index 81e133db..33f4894b 100644 --- a/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py +++ b/google/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/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py b/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py index 6679cc37..b327cd74 100644 --- a/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py +++ b/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. diff --git a/google/analytics/admin_v1alpha/types/analytics_admin.py b/google/analytics/admin_v1alpha/types/analytics_admin.py index 22ae9d6e..9b15a0f6 100644 --- a/google/analytics/admin_v1alpha/types/analytics_admin.py +++ b/google/analytics/admin_v1alpha/types/analytics_admin.py @@ -214,6 +214,7 @@ class RunAccessReportRequest(proto.Message): requested at the account level, Data Access Reports include all access for all properties under that account. + To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account @@ -443,9 +444,9 @@ class ListAccountsRequest(proto.Message): token. show_deleted (bool): Whether to include soft-deleted (ie: - "trashed") Accounts in the - results. Accounts can be inspected to determine - whether they are deleted or not. + "trashed") Accounts in the results. Accounts can + be inspected to determine whether they are + deleted or not. """ page_size: int = proto.Field( @@ -620,9 +621,9 @@ class ListPropertiesRequest(proto.Message): page token. show_deleted (bool): Whether to include soft-deleted (ie: - "trashed") Properties in the - results. Properties can be inspected to - determine whether they are deleted or not. + "trashed") Properties in the results. Properties + can be inspected to determine whether they are + deleted or not. """ filter: str = proto.Field( @@ -912,6 +913,7 @@ def raw_page(self): class CreateUserLinkRequest(proto.Message): r"""Request message for CreateUserLink RPC. + Users can have multiple email addresses associated with their Google account, and one of these email addresses is the "primary" email address. Any of the email addresses associated @@ -1425,6 +1427,7 @@ class AcknowledgeUserDataCollectionRequest(proto.Message): Required. An acknowledgement that the caller of this method understands the terms of user data collection. + This field must contain the exact value: "I acknowledge that I have the necessary privacy diff --git a/google/analytics/admin_v1alpha/types/event_create_and_edit.py b/google/analytics/admin_v1alpha/types/event_create_and_edit.py index d5e09b3f..9609af50 100644 --- a/google/analytics/admin_v1alpha/types/event_create_and_edit.py +++ b/google/analytics/admin_v1alpha/types/event_create_and_edit.py @@ -69,6 +69,7 @@ class EventCreateRule(proto.Message): creation of an entirely new event based 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/google/analytics/admin_v1alpha/types/resources.py b/google/analytics/admin_v1alpha/types/resources.py index f784a250..d77de83f 100644 --- a/google/analytics/admin_v1alpha/types/resources.py +++ b/google/analytics/admin_v1alpha/types/resources.py @@ -698,6 +698,7 @@ class WebStreamData(proto.Message): Attributes: measurement_id (str): Output only. Analytics Measurement ID. + Example: "G-1A2BCD345E". firebase_app_id (str): Output only. ID of the corresponding web app @@ -871,6 +872,7 @@ class AuditUserLink(proto.Message): Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.). + Format: predefinedRoles/viewer """ @@ -962,6 +964,7 @@ class GoogleAdsLink(proto.Message): Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} + Note: googleAdsLinkId is not the Google Ads customer ID. customer_id (str): @@ -1210,6 +1213,7 @@ class SKAdNetworkConversionValueSchema(proto.Message): values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). + Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or @@ -1326,6 +1330,7 @@ class ConversionValues(proto.Message): This field is a member of `oneof`_ ``_fine_value``. coarse_value (google.analytics.admin_v1alpha.types.CoarseValue): Required. A coarse grained conversion value. + This value is not guaranteed to be unique. event_mappings (MutableSequence[google.analytics.admin_v1alpha.types.EventMapping]): Event conditions that must be met for this @@ -1816,6 +1821,7 @@ class DisplayVideo360AdvertiserLink(proto.Message): DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} + Note: linkId is not the Display & Video 360 Advertiser ID advertiser_id (str): @@ -1888,6 +1894,7 @@ class DisplayVideo360AdvertiserLinkProposal(proto.Message): Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} + Note: proposalId is not the Display & Video 360 Advertiser ID advertiser_id (str): @@ -1971,6 +1978,7 @@ class SearchAds360Link(proto.Message): Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} + Note: linkId is not the Search Ads 360 advertiser ID advertiser_id (str): @@ -2219,6 +2227,7 @@ class CustomDimension(proto.Message): disallow_ads_personalization (bool): Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. + This is currently only supported by user-scoped custom dimensions. """ @@ -2311,6 +2320,7 @@ class CustomMetric(proto.Message): class MeasurementUnit(proto.Enum): r"""Possible types of representing the custom metric's value. + Currency representation may change in the future, requiring a breaking API change. @@ -2494,6 +2504,7 @@ class AttributionSettings(proto.Message): Required. The reporting attribution model used to calculate conversion credit in this property's reports. + Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and @@ -2811,6 +2822,7 @@ class EnhancedMeasurementSettings(proto.Message): Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. + Changing this value does not affect the settings themselves, but determines whether they are respected. diff --git a/google/analytics/admin_v1beta/services/analytics_admin_service/async_client.py b/google/analytics/admin_v1beta/services/analytics_admin_service/async_client.py index 8a537a84..06c99296 100644 --- a/google/analytics/admin_v1beta/services/analytics_admin_service/async_client.py +++ b/google/analytics/admin_v1beta/services/analytics_admin_service/async_client.py @@ -392,6 +392,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 @@ -435,6 +436,7 @@ async def sample_list_accounts(): Returns: google.analytics.admin_v1beta.services.analytics_admin_service.pagers.ListAccountsAsyncPager: Request message for ListAccounts RPC. + Iterating over this object will yield results and resolve additional pages automatically. @@ -482,15 +484,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 @@ -1164,15 +1167,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. @@ -1403,6 +1407,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 diff --git a/google/analytics/admin_v1beta/services/analytics_admin_service/client.py b/google/analytics/admin_v1beta/services/analytics_admin_service/client.py index 45ce5c2d..2e917ce6 100644 --- a/google/analytics/admin_v1beta/services/analytics_admin_service/client.py +++ b/google/analytics/admin_v1beta/services/analytics_admin_service/client.py @@ -754,6 +754,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 @@ -797,6 +798,7 @@ def sample_list_accounts(): Returns: google.analytics.admin_v1beta.services.analytics_admin_service.pagers.ListAccountsPager: Request message for ListAccounts RPC. + Iterating over this object will yield results and resolve additional pages automatically. @@ -845,15 +847,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 @@ -1530,15 +1533,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. @@ -1769,6 +1773,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 diff --git a/google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc.py b/google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc.py index dc2ec4a0..d53d5c6e 100644 --- a/google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc.py +++ b/google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc.py @@ -264,6 +264,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 @@ -295,15 +296,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: @@ -504,15 +506,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. @@ -567,6 +570,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/google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc_asyncio.py b/google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc_asyncio.py index 6089b3a8..668a9e55 100644 --- a/google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc_asyncio.py +++ b/google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc_asyncio.py @@ -268,6 +268,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 @@ -299,15 +300,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: @@ -513,15 +515,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. @@ -580,6 +583,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/google/analytics/admin_v1beta/types/analytics_admin.py b/google/analytics/admin_v1beta/types/analytics_admin.py index 43132cee..c9c5b1b1 100644 --- a/google/analytics/admin_v1beta/types/analytics_admin.py +++ b/google/analytics/admin_v1beta/types/analytics_admin.py @@ -103,6 +103,7 @@ class RunAccessReportRequest(proto.Message): requested at the account level, Data Access Reports include all access for all properties under that account. + To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account @@ -332,9 +333,9 @@ class ListAccountsRequest(proto.Message): token. show_deleted (bool): Whether to include soft-deleted (ie: - "trashed") Accounts in the - results. Accounts can be inspected to determine - whether they are deleted or not. + "trashed") Accounts in the results. Accounts can + be inspected to determine whether they are + deleted or not. """ page_size: int = proto.Field( @@ -509,9 +510,9 @@ class ListPropertiesRequest(proto.Message): page token. show_deleted (bool): Whether to include soft-deleted (ie: - "trashed") Properties in the - results. Properties can be inspected to - determine whether they are deleted or not. + "trashed") Properties in the results. Properties + can be inspected to determine whether they are + deleted or not. """ filter: str = proto.Field( @@ -929,6 +930,7 @@ class AcknowledgeUserDataCollectionRequest(proto.Message): Required. An acknowledgement that the caller of this method understands the terms of user data collection. + This field must contain the exact value: "I acknowledge that I have the necessary privacy diff --git a/google/analytics/admin_v1beta/types/resources.py b/google/analytics/admin_v1beta/types/resources.py index b53cfa5a..d19e3dfe 100644 --- a/google/analytics/admin_v1beta/types/resources.py +++ b/google/analytics/admin_v1beta/types/resources.py @@ -518,6 +518,7 @@ class WebStreamData(proto.Message): Attributes: measurement_id (str): Output only. Analytics Measurement ID. + Example: "G-1A2BCD345E". firebase_app_id (str): Output only. ID of the corresponding web app @@ -673,6 +674,7 @@ class GoogleAdsLink(proto.Message): Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} + Note: googleAdsLinkId is not the Google Ads customer ID. customer_id (str): @@ -1229,6 +1231,7 @@ class CustomDimension(proto.Message): disallow_ads_personalization (bool): Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. + This is currently only supported by user-scoped custom dimensions. """ @@ -1321,6 +1324,7 @@ class CustomMetric(proto.Message): class MeasurementUnit(proto.Enum): r"""Possible types of representing the custom metric's value. + Currency representation may change in the future, requiring a breaking API change.