diff --git a/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py b/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py index 4d98cba94992..dea7027ea6ab 100644 --- a/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py +++ b/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py @@ -6240,6 +6240,12 @@ async def update_data_retention_settings( # Done; return the response. return response + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py b/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py index a2e6849c9864..c663ff4d7139 100644 --- a/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py +++ b/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py @@ -621,10 +621,7 @@ def __init__( client_cert_source_for_mtls=client_cert_source_func, quota_project_id=client_options.quota_project_id, client_info=client_info, - always_use_jwt_access=( - Transport == type(self).get_transport_class("grpc") - or Transport == type(self).get_transport_class("grpc_asyncio") - ), + always_use_jwt_access=True, ) def get_account( @@ -6745,6 +6742,19 @@ def update_data_retention_settings( # Done; return the response. return response + def __enter__(self): + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + try: DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( diff --git a/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/base.py b/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/base.py index c1d44ccbaa87..5ab97257a70e 100644 --- a/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/base.py +++ b/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/base.py @@ -521,6 +521,15 @@ def _prep_wrapped_messages(self, client_info): ), } + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + @property def get_account( self, diff --git a/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py b/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py index c2ccb81a335f..5a96aa02ae74 100644 --- a/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py +++ b/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py @@ -2615,5 +2615,8 @@ def update_data_retention_settings( ) return self._stubs["update_data_retention_settings"] + def close(self): + self.grpc_channel.close() + __all__ = ("AnalyticsAdminServiceGrpcTransport",) diff --git a/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py b/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py index d1135a632de9..c4c92c36e376 100644 --- a/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py +++ b/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py @@ -2673,5 +2673,8 @@ def update_data_retention_settings( ) return self._stubs["update_data_retention_settings"] + def close(self): + return self.grpc_channel.close() + __all__ = ("AnalyticsAdminServiceGrpcAsyncIOTransport",) diff --git a/packages/google-analytics-admin/google/analytics/admin_v1alpha/types/analytics_admin.py b/packages/google-analytics-admin/google/analytics/admin_v1alpha/types/analytics_admin.py index 38099963424c..5a9d132e4532 100644 --- a/packages/google-analytics-admin/google/analytics/admin_v1alpha/types/analytics_admin.py +++ b/packages/google-analytics-admin/google/analytics/admin_v1alpha/types/analytics_admin.py @@ -131,6 +131,7 @@ class GetAccountRequest(proto.Message): r"""Request message for GetAccount RPC. + Attributes: name (str): Required. The name of the account to lookup. @@ -143,6 +144,7 @@ class GetAccountRequest(proto.Message): class ListAccountsRequest(proto.Message): r"""Request message for ListAccounts RPC. + Attributes: page_size (int): The maximum number of resources to return. @@ -171,6 +173,7 @@ class ListAccountsRequest(proto.Message): class ListAccountsResponse(proto.Message): r"""Request message for ListAccounts RPC. + Attributes: accounts (Sequence[google.analytics.admin_v1alpha.types.Account]): Results that were accessible to the caller. @@ -190,6 +193,7 @@ def raw_page(self): class DeleteAccountRequest(proto.Message): r"""Request message for DeleteAccount RPC. + Attributes: name (str): Required. The name of the Account to soft- @@ -202,6 +206,7 @@ class DeleteAccountRequest(proto.Message): class UpdateAccountRequest(proto.Message): r"""Request message for UpdateAccount RPC. + Attributes: account (google.analytics.admin_v1alpha.types.Account): Required. The account to update. The account's ``name`` @@ -221,6 +226,7 @@ class UpdateAccountRequest(proto.Message): class ProvisionAccountTicketRequest(proto.Message): r"""Request message for ProvisionAccountTicket RPC. + Attributes: account (google.analytics.admin_v1alpha.types.Account): The account to create. @@ -237,6 +243,7 @@ class ProvisionAccountTicketRequest(proto.Message): class ProvisionAccountTicketResponse(proto.Message): r"""Response message for ProvisionAccountTicket RPC. + Attributes: account_ticket_id (str): The param to be passed in the ToS link. @@ -247,6 +254,7 @@ class ProvisionAccountTicketResponse(proto.Message): class GetPropertyRequest(proto.Message): r"""Request message for GetProperty RPC. + Attributes: name (str): Required. The name of the property to lookup. Format: @@ -258,6 +266,7 @@ class GetPropertyRequest(proto.Message): class ListPropertiesRequest(proto.Message): r"""Request message for ListProperties RPC. + Attributes: filter (str): Required. An expression for filtering the results of the @@ -301,6 +310,7 @@ class ListPropertiesRequest(proto.Message): class ListPropertiesResponse(proto.Message): r"""Response message for ListProperties RPC. + Attributes: properties (Sequence[google.analytics.admin_v1alpha.types.Property]): Results that matched the filter criteria and @@ -323,6 +333,7 @@ def raw_page(self): class UpdatePropertyRequest(proto.Message): r"""Request message for UpdateProperty RPC. + Attributes: property (google.analytics.admin_v1alpha.types.Property): Required. The property to update. The property's ``name`` @@ -342,6 +353,7 @@ class UpdatePropertyRequest(proto.Message): class CreatePropertyRequest(proto.Message): r"""Request message for CreateProperty RPC. + Attributes: property (google.analytics.admin_v1alpha.types.Property): Required. The property to create. @@ -354,6 +366,7 @@ class CreatePropertyRequest(proto.Message): class DeletePropertyRequest(proto.Message): r"""Request message for DeleteProperty RPC. + Attributes: name (str): Required. The name of the Property to soft-delete. Format: @@ -365,6 +378,7 @@ class DeletePropertyRequest(proto.Message): class GetUserLinkRequest(proto.Message): r"""Request message for GetUserLink RPC. + Attributes: name (str): Required. Example format: @@ -376,6 +390,7 @@ class GetUserLinkRequest(proto.Message): class BatchGetUserLinksRequest(proto.Message): r"""Request message for BatchGetUserLinks RPC. + Attributes: parent (str): Required. The account or property that all @@ -396,6 +411,7 @@ class BatchGetUserLinksRequest(proto.Message): class BatchGetUserLinksResponse(proto.Message): r"""Response message for BatchGetUserLinks RPC. + Attributes: user_links (Sequence[google.analytics.admin_v1alpha.types.UserLink]): The requested user links. @@ -408,6 +424,7 @@ class BatchGetUserLinksResponse(proto.Message): class ListUserLinksRequest(proto.Message): r"""Request message for ListUserLinks RPC. + Attributes: parent (str): Required. Example format: accounts/1234 @@ -432,6 +449,7 @@ class ListUserLinksRequest(proto.Message): class ListUserLinksResponse(proto.Message): r"""Response message for ListUserLinks RPC. + Attributes: user_links (Sequence[google.analytics.admin_v1alpha.types.UserLink]): List of UserLinks. These will be ordered @@ -454,6 +472,7 @@ def raw_page(self): class AuditUserLinksRequest(proto.Message): r"""Request message for AuditUserLinks RPC. + Attributes: parent (str): Required. Example format: accounts/1234 @@ -478,6 +497,7 @@ class AuditUserLinksRequest(proto.Message): class AuditUserLinksResponse(proto.Message): r"""Response message for AuditUserLinks RPC. + Attributes: user_links (Sequence[google.analytics.admin_v1alpha.types.AuditUserLink]): List of AuditUserLinks. These will be ordered @@ -526,6 +546,7 @@ class CreateUserLinkRequest(proto.Message): class BatchCreateUserLinksRequest(proto.Message): r"""Request message for BatchCreateUserLinks RPC. + Attributes: parent (str): Required. The account or property that all @@ -554,6 +575,7 @@ class BatchCreateUserLinksRequest(proto.Message): class BatchCreateUserLinksResponse(proto.Message): r"""Response message for BatchCreateUserLinks RPC. + Attributes: user_links (Sequence[google.analytics.admin_v1alpha.types.UserLink]): The user links created. @@ -566,6 +588,7 @@ class BatchCreateUserLinksResponse(proto.Message): class UpdateUserLinkRequest(proto.Message): r"""Request message for UpdateUserLink RPC. + Attributes: user_link (google.analytics.admin_v1alpha.types.UserLink): Required. The user link to update. @@ -576,6 +599,7 @@ class UpdateUserLinkRequest(proto.Message): class BatchUpdateUserLinksRequest(proto.Message): r"""Request message for BatchUpdateUserLinks RPC. + Attributes: parent (str): Required. The account or property that all @@ -597,6 +621,7 @@ class BatchUpdateUserLinksRequest(proto.Message): class BatchUpdateUserLinksResponse(proto.Message): r"""Response message for BatchUpdateUserLinks RPC. + Attributes: user_links (Sequence[google.analytics.admin_v1alpha.types.UserLink]): The user links updated. @@ -609,6 +634,7 @@ class BatchUpdateUserLinksResponse(proto.Message): class DeleteUserLinkRequest(proto.Message): r"""Request message for DeleteUserLink RPC. + Attributes: name (str): Required. Example format: @@ -620,6 +646,7 @@ class DeleteUserLinkRequest(proto.Message): class BatchDeleteUserLinksRequest(proto.Message): r"""Request message for BatchDeleteUserLinks RPC. + Attributes: parent (str): Required. The account or property that all @@ -641,6 +668,7 @@ class BatchDeleteUserLinksRequest(proto.Message): class GetWebDataStreamRequest(proto.Message): r"""Request message for GetWebDataStream RPC. + Attributes: name (str): Required. The name of the web data stream to lookup. Format: @@ -653,6 +681,7 @@ class GetWebDataStreamRequest(proto.Message): class DeleteWebDataStreamRequest(proto.Message): r"""Request message for DeleteWebDataStream RPC. + Attributes: name (str): Required. The name of the web data stream to delete. Format: @@ -665,6 +694,7 @@ class DeleteWebDataStreamRequest(proto.Message): class UpdateWebDataStreamRequest(proto.Message): r"""Request message for UpdateWebDataStream RPC. + Attributes: web_data_stream (google.analytics.admin_v1alpha.types.WebDataStream): Required. The web stream to update. The ``name`` field is @@ -686,6 +716,7 @@ class UpdateWebDataStreamRequest(proto.Message): class CreateWebDataStreamRequest(proto.Message): r"""Request message for CreateWebDataStream RPC. + Attributes: web_data_stream (google.analytics.admin_v1alpha.types.WebDataStream): Required. The web stream to create. @@ -703,6 +734,7 @@ class CreateWebDataStreamRequest(proto.Message): class ListWebDataStreamsRequest(proto.Message): r"""Request message for ListWebDataStreams RPC. + Attributes: parent (str): Required. The name of the parent property. @@ -728,6 +760,7 @@ class ListWebDataStreamsRequest(proto.Message): class ListWebDataStreamsResponse(proto.Message): r"""Request message for ListWebDataStreams RPC. + Attributes: web_data_streams (Sequence[google.analytics.admin_v1alpha.types.WebDataStream]): Results that matched the filter criteria and @@ -750,6 +783,7 @@ def raw_page(self): class GetIosAppDataStreamRequest(proto.Message): r"""Request message for GetIosAppDataStream RPC. + Attributes: name (str): Required. The name of the iOS app data stream to lookup. @@ -763,6 +797,7 @@ class GetIosAppDataStreamRequest(proto.Message): class DeleteIosAppDataStreamRequest(proto.Message): r"""Request message for DeleteIosAppDataStream RPC. + Attributes: name (str): Required. The name of the iOS app data stream to delete. @@ -776,6 +811,7 @@ class DeleteIosAppDataStreamRequest(proto.Message): class UpdateIosAppDataStreamRequest(proto.Message): r"""Request message for UpdateIosAppDataStream RPC. + Attributes: ios_app_data_stream (google.analytics.admin_v1alpha.types.IosAppDataStream): Required. The iOS app stream to update. The ``name`` field @@ -797,6 +833,7 @@ class UpdateIosAppDataStreamRequest(proto.Message): class ListIosAppDataStreamsRequest(proto.Message): r"""Request message for ListIosAppDataStreams RPC. + Attributes: parent (str): Required. The name of the parent property. @@ -822,6 +859,7 @@ class ListIosAppDataStreamsRequest(proto.Message): class ListIosAppDataStreamsResponse(proto.Message): r"""Request message for ListIosAppDataStreams RPC. + Attributes: ios_app_data_streams (Sequence[google.analytics.admin_v1alpha.types.IosAppDataStream]): Results that matched the filter criteria and @@ -844,6 +882,7 @@ def raw_page(self): class GetAndroidAppDataStreamRequest(proto.Message): r"""Request message for GetAndroidAppDataStream RPC. + Attributes: name (str): Required. The name of the android app data stream to lookup. @@ -857,6 +896,7 @@ class GetAndroidAppDataStreamRequest(proto.Message): class DeleteAndroidAppDataStreamRequest(proto.Message): r"""Request message for DeleteAndroidAppDataStream RPC. + Attributes: name (str): Required. The name of the android app data stream to delete. @@ -870,6 +910,7 @@ class DeleteAndroidAppDataStreamRequest(proto.Message): class UpdateAndroidAppDataStreamRequest(proto.Message): r"""Request message for UpdateAndroidAppDataStream RPC. + Attributes: android_app_data_stream (google.analytics.admin_v1alpha.types.AndroidAppDataStream): Required. The android app stream to update. The ``name`` @@ -892,6 +933,7 @@ class UpdateAndroidAppDataStreamRequest(proto.Message): class ListAndroidAppDataStreamsRequest(proto.Message): r"""Request message for ListAndroidAppDataStreams RPC. + Attributes: parent (str): Required. The name of the parent property. @@ -916,6 +958,7 @@ class ListAndroidAppDataStreamsRequest(proto.Message): class ListAndroidAppDataStreamsResponse(proto.Message): r"""Request message for ListAndroidDataStreams RPC. + Attributes: android_app_data_streams (Sequence[google.analytics.admin_v1alpha.types.AndroidAppDataStream]): Results that matched the filter criteria and @@ -938,6 +981,7 @@ def raw_page(self): class GetEnhancedMeasurementSettingsRequest(proto.Message): r"""Request message for GetEnhancedMeasurementSettings RPC. + Attributes: name (str): Required. The name of the settings to lookup. Format: @@ -951,6 +995,7 @@ class GetEnhancedMeasurementSettingsRequest(proto.Message): class UpdateEnhancedMeasurementSettingsRequest(proto.Message): r"""Request message for UpdateEnhancedMeasurementSettings RPC. + Attributes: enhanced_measurement_settings (google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings): Required. The settings to update. The ``name`` field is used @@ -972,6 +1017,7 @@ class UpdateEnhancedMeasurementSettingsRequest(proto.Message): class CreateFirebaseLinkRequest(proto.Message): r"""Request message for CreateFirebaseLink RPC + Attributes: parent (str): Required. Format: properties/{property_id} Example: @@ -988,6 +1034,7 @@ class CreateFirebaseLinkRequest(proto.Message): class DeleteFirebaseLinkRequest(proto.Message): r"""Request message for DeleteFirebaseLink RPC + Attributes: name (str): Required. Format: @@ -1000,6 +1047,7 @@ class DeleteFirebaseLinkRequest(proto.Message): class ListFirebaseLinksRequest(proto.Message): r"""Request message for ListFirebaseLinks RPC + Attributes: parent (str): Required. Format: properties/{property_id} Example: @@ -1026,6 +1074,7 @@ class ListFirebaseLinksRequest(proto.Message): class ListFirebaseLinksResponse(proto.Message): r"""Response message for ListFirebaseLinks RPC + Attributes: firebase_links (Sequence[google.analytics.admin_v1alpha.types.FirebaseLink]): List of FirebaseLinks. This will have at most @@ -1049,6 +1098,7 @@ def raw_page(self): class GetGlobalSiteTagRequest(proto.Message): r"""Request message for GetGlobalSiteTag RPC. + Attributes: name (str): Required. The name of the site tag to lookup. Note that site @@ -1062,6 +1112,7 @@ class GetGlobalSiteTagRequest(proto.Message): class CreateGoogleAdsLinkRequest(proto.Message): r"""Request message for CreateGoogleAdsLink RPC + Attributes: parent (str): Required. Example format: properties/1234 @@ -1077,6 +1128,7 @@ class CreateGoogleAdsLinkRequest(proto.Message): class UpdateGoogleAdsLinkRequest(proto.Message): r"""Request message for UpdateGoogleAdsLink RPC + Attributes: google_ads_link (google.analytics.admin_v1alpha.types.GoogleAdsLink): The GoogleAdsLink to update @@ -1097,6 +1149,7 @@ class UpdateGoogleAdsLinkRequest(proto.Message): class DeleteGoogleAdsLinkRequest(proto.Message): r"""Request message for DeleteGoogleAdsLink RPC. + Attributes: name (str): Required. Example format: @@ -1108,6 +1161,7 @@ class DeleteGoogleAdsLinkRequest(proto.Message): class ListGoogleAdsLinksRequest(proto.Message): r"""Request message for ListGoogleAdsLinks RPC. + Attributes: parent (str): Required. Example format: properties/1234 @@ -1133,6 +1187,7 @@ class ListGoogleAdsLinksRequest(proto.Message): class ListGoogleAdsLinksResponse(proto.Message): r"""Response message for ListGoogleAdsLinks RPC. + Attributes: google_ads_links (Sequence[google.analytics.admin_v1alpha.types.GoogleAdsLink]): List of GoogleAdsLinks. @@ -1154,6 +1209,7 @@ def raw_page(self): class GetDataSharingSettingsRequest(proto.Message): r"""Request message for GetDataSharingSettings RPC. + Attributes: name (str): Required. The name of the settings to lookup. @@ -1166,6 +1222,7 @@ class GetDataSharingSettingsRequest(proto.Message): class ListAccountSummariesRequest(proto.Message): r"""Request message for ListAccountSummaries RPC. + Attributes: page_size (int): The maximum number of AccountSummary @@ -1189,6 +1246,7 @@ class ListAccountSummariesRequest(proto.Message): class ListAccountSummariesResponse(proto.Message): r"""Response message for ListAccountSummaries RPC. + Attributes: account_summaries (Sequence[google.analytics.admin_v1alpha.types.AccountSummary]): Account summaries of all accounts the caller @@ -1211,6 +1269,7 @@ def raw_page(self): class SearchChangeHistoryEventsRequest(proto.Message): r"""Request message for SearchChangeHistoryEvents RPC. + Attributes: account (str): Required. The account resource for which to @@ -1269,6 +1328,7 @@ class SearchChangeHistoryEventsRequest(proto.Message): class SearchChangeHistoryEventsResponse(proto.Message): r"""Response message for SearchAccounts RPC. + Attributes: change_history_events (Sequence[google.analytics.admin_v1alpha.types.ChangeHistoryEvent]): Results that were accessible to the caller. @@ -1290,6 +1350,7 @@ def raw_page(self): class GetMeasurementProtocolSecretRequest(proto.Message): r"""Request message for GetMeasurementProtocolSecret RPC. + Attributes: name (str): Required. The name of the measurement @@ -1305,6 +1366,7 @@ class GetMeasurementProtocolSecretRequest(proto.Message): class CreateMeasurementProtocolSecretRequest(proto.Message): r"""Request message for CreateMeasurementProtocolSecret RPC + Attributes: parent (str): Required. The parent resource where this @@ -1326,6 +1388,7 @@ class CreateMeasurementProtocolSecretRequest(proto.Message): class DeleteMeasurementProtocolSecretRequest(proto.Message): r"""Request message for DeleteMeasurementProtocolSecret RPC + Attributes: name (str): Required. The name of the @@ -1341,6 +1404,7 @@ class DeleteMeasurementProtocolSecretRequest(proto.Message): class UpdateMeasurementProtocolSecretRequest(proto.Message): r"""Request message for UpdateMeasurementProtocolSecret RPC + Attributes: measurement_protocol_secret (google.analytics.admin_v1alpha.types.MeasurementProtocolSecret): Required. The measurement protocol secret to @@ -1360,6 +1424,7 @@ class UpdateMeasurementProtocolSecretRequest(proto.Message): class ListMeasurementProtocolSecretsRequest(proto.Message): r"""Request message for ListMeasurementProtocolSecret RPC + Attributes: parent (str): Required. The resource name of the parent @@ -1388,6 +1453,7 @@ class ListMeasurementProtocolSecretsRequest(proto.Message): class ListMeasurementProtocolSecretsResponse(proto.Message): r"""Response message for ListMeasurementProtocolSecret RPC + Attributes: measurement_protocol_secrets (Sequence[google.analytics.admin_v1alpha.types.MeasurementProtocolSecret]): A list of secrets for the parent stream @@ -1410,6 +1476,7 @@ def raw_page(self): class GetGoogleSignalsSettingsRequest(proto.Message): r"""Request message for GetGoogleSignalsSettings RPC + Attributes: name (str): Required. The name of the google signals @@ -1422,6 +1489,7 @@ class GetGoogleSignalsSettingsRequest(proto.Message): class UpdateGoogleSignalsSettingsRequest(proto.Message): r"""Request message for UpdateGoogleSignalsSettings RPC + Attributes: google_signals_settings (google.analytics.admin_v1alpha.types.GoogleSignalsSettings): Required. The settings to update. The ``name`` field is used @@ -1443,6 +1511,7 @@ class UpdateGoogleSignalsSettingsRequest(proto.Message): class CreateConversionEventRequest(proto.Message): r"""Request message for CreateConversionEvent RPC + Attributes: conversion_event (google.analytics.admin_v1alpha.types.ConversionEvent): Required. The conversion event to create. @@ -1460,6 +1529,7 @@ class CreateConversionEventRequest(proto.Message): class GetConversionEventRequest(proto.Message): r"""Request message for GetConversionEvent RPC + Attributes: name (str): Required. The resource name of the conversion event to @@ -1473,6 +1543,7 @@ class GetConversionEventRequest(proto.Message): class DeleteConversionEventRequest(proto.Message): r"""Request message for DeleteConversionEvent RPC + Attributes: name (str): Required. The resource name of the conversion event to @@ -1486,6 +1557,7 @@ class DeleteConversionEventRequest(proto.Message): class ListConversionEventsRequest(proto.Message): r"""Request message for ListConversionEvents RPC + Attributes: parent (str): Required. The resource name of the parent @@ -1510,6 +1582,7 @@ class ListConversionEventsRequest(proto.Message): class ListConversionEventsResponse(proto.Message): r"""Response message for ListConversionEvents RPC. + Attributes: conversion_events (Sequence[google.analytics.admin_v1alpha.types.ConversionEvent]): The requested conversion events @@ -1531,6 +1604,7 @@ def raw_page(self): class GetDisplayVideo360AdvertiserLinkRequest(proto.Message): r"""Request message for GetDisplayVideo360AdvertiserLink RPC. + Attributes: name (str): Required. The name of the @@ -1544,6 +1618,7 @@ class GetDisplayVideo360AdvertiserLinkRequest(proto.Message): class ListDisplayVideo360AdvertiserLinksRequest(proto.Message): r"""Request message for ListDisplayVideo360AdvertiserLinks RPC. + Attributes: parent (str): Required. Example format: properties/1234 @@ -1569,6 +1644,7 @@ class ListDisplayVideo360AdvertiserLinksRequest(proto.Message): class ListDisplayVideo360AdvertiserLinksResponse(proto.Message): r"""Response message for ListDisplayVideo360AdvertiserLinks RPC. + Attributes: display_video_360_advertiser_links (Sequence[google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink]): List of DisplayVideo360AdvertiserLinks. @@ -1590,6 +1666,7 @@ def raw_page(self): class CreateDisplayVideo360AdvertiserLinkRequest(proto.Message): r"""Request message for CreateDisplayVideo360AdvertiserLink RPC. + Attributes: parent (str): Required. Example format: properties/1234 @@ -1606,6 +1683,7 @@ class CreateDisplayVideo360AdvertiserLinkRequest(proto.Message): class DeleteDisplayVideo360AdvertiserLinkRequest(proto.Message): r"""Request message for DeleteDisplayVideo360AdvertiserLink RPC. + Attributes: name (str): Required. The name of the @@ -1619,6 +1697,7 @@ class DeleteDisplayVideo360AdvertiserLinkRequest(proto.Message): class UpdateDisplayVideo360AdvertiserLinkRequest(proto.Message): r"""Request message for UpdateDisplayVideo360AdvertiserLink RPC. + Attributes: display_video_360_advertiser_link (google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink): The DisplayVideo360AdvertiserLink to update @@ -1786,6 +1865,7 @@ class CancelDisplayVideo360AdvertiserLinkProposalRequest(proto.Message): class CreateCustomDimensionRequest(proto.Message): r"""Request message for CreateCustomDimension RPC. + Attributes: parent (str): Required. Example format: properties/1234 @@ -1801,6 +1881,7 @@ class CreateCustomDimensionRequest(proto.Message): class UpdateCustomDimensionRequest(proto.Message): r"""Request message for UpdateCustomDimension RPC. + Attributes: custom_dimension (google.analytics.admin_v1alpha.types.CustomDimension): The CustomDimension to update @@ -1820,6 +1901,7 @@ class UpdateCustomDimensionRequest(proto.Message): class ListCustomDimensionsRequest(proto.Message): r"""Request message for ListCustomDimensions RPC. + Attributes: parent (str): Required. Example format: properties/1234 @@ -1845,6 +1927,7 @@ class ListCustomDimensionsRequest(proto.Message): class ListCustomDimensionsResponse(proto.Message): r"""Response message for ListCustomDimensions RPC. + Attributes: custom_dimensions (Sequence[google.analytics.admin_v1alpha.types.CustomDimension]): List of CustomDimensions. @@ -1866,6 +1949,7 @@ def raw_page(self): class ArchiveCustomDimensionRequest(proto.Message): r"""Request message for ArchiveCustomDimension RPC. + Attributes: name (str): Required. The name of the CustomDimension to @@ -1878,6 +1962,7 @@ class ArchiveCustomDimensionRequest(proto.Message): class GetCustomDimensionRequest(proto.Message): r"""Request message for GetCustomDimension RPC. + Attributes: name (str): Required. The name of the CustomDimension to @@ -1890,6 +1975,7 @@ class GetCustomDimensionRequest(proto.Message): class CreateCustomMetricRequest(proto.Message): r"""Request message for CreateCustomMetric RPC. + Attributes: parent (str): Required. Example format: properties/1234 @@ -1905,6 +1991,7 @@ class CreateCustomMetricRequest(proto.Message): class UpdateCustomMetricRequest(proto.Message): r"""Request message for UpdateCustomMetric RPC. + Attributes: custom_metric (google.analytics.admin_v1alpha.types.CustomMetric): The CustomMetric to update @@ -1924,6 +2011,7 @@ class UpdateCustomMetricRequest(proto.Message): class ListCustomMetricsRequest(proto.Message): r"""Request message for ListCustomMetrics RPC. + Attributes: parent (str): Required. Example format: properties/1234 @@ -1948,6 +2036,7 @@ class ListCustomMetricsRequest(proto.Message): class ListCustomMetricsResponse(proto.Message): r"""Response message for ListCustomMetrics RPC. + Attributes: custom_metrics (Sequence[google.analytics.admin_v1alpha.types.CustomMetric]): List of CustomMetrics. @@ -1969,6 +2058,7 @@ def raw_page(self): class ArchiveCustomMetricRequest(proto.Message): r"""Request message for ArchiveCustomMetric RPC. + Attributes: name (str): Required. The name of the CustomMetric to @@ -1981,6 +2071,7 @@ class ArchiveCustomMetricRequest(proto.Message): class GetCustomMetricRequest(proto.Message): r"""Request message for GetCustomMetric RPC. + Attributes: name (str): Required. The name of the CustomMetric to @@ -1993,6 +2084,7 @@ class GetCustomMetricRequest(proto.Message): class GetDataRetentionSettingsRequest(proto.Message): r"""Request message for GetDataRetentionSettings RPC. + Attributes: name (str): Required. The name of the settings to lookup. @@ -2006,6 +2098,7 @@ class GetDataRetentionSettingsRequest(proto.Message): class UpdateDataRetentionSettingsRequest(proto.Message): r"""Request message for UpdateDataRetentionSettings RPC. + Attributes: data_retention_settings (google.analytics.admin_v1alpha.types.DataRetentionSettings): Required. The settings to update. The ``name`` field is used diff --git a/packages/google-analytics-admin/google/analytics/admin_v1alpha/types/resources.py b/packages/google-analytics-admin/google/analytics/admin_v1alpha/types/resources.py index 1d1057c7c686..06a6a3d11a48 100644 --- a/packages/google-analytics-admin/google/analytics/admin_v1alpha/types/resources.py +++ b/packages/google-analytics-admin/google/analytics/admin_v1alpha/types/resources.py @@ -178,6 +178,7 @@ class LinkProposalState(proto.Enum): class Account(proto.Message): r"""A resource message representing a Google Analytics account. + Attributes: name (str): Output only. Resource name of this account. @@ -538,6 +539,7 @@ class EnhancedMeasurementSettings(proto.Message): class FirebaseLink(proto.Message): r"""A link between an GA4 property and a Firebase project. + Attributes: name (str): Output only. Example format: @@ -581,6 +583,7 @@ class GlobalSiteTag(proto.Message): class GoogleAdsLink(proto.Message): r"""A link between an GA4 property and a Google Ads account. + Attributes: name (str): Output only. Format: @@ -692,6 +695,7 @@ class AccountSummary(proto.Message): class PropertySummary(proto.Message): r"""A virtual resource representing metadata for an GA4 property. + Attributes: property (str): Resource name of property referred to by this property @@ -708,6 +712,7 @@ class PropertySummary(proto.Message): class MeasurementProtocolSecret(proto.Message): r"""A secret value used for sending hits to Measurement Protocol. + Attributes: name (str): Output only. Resource name of this secret. @@ -1031,6 +1036,7 @@ class DisplayVideo360AdvertiserLinkProposal(proto.Message): class LinkProposalStatusDetails(proto.Message): r"""Status information for a link proposal. + Attributes: link_proposal_initiating_product (google.analytics.admin_v1alpha.types.LinkProposalInitiatingProduct): Output only. The source of this proposal. @@ -1050,6 +1056,7 @@ class LinkProposalStatusDetails(proto.Message): class ConversionEvent(proto.Message): r"""A conversion event in a Google Analytics property. + Attributes: name (str): Output only. Resource name of this conversion event. Format: @@ -1105,6 +1112,7 @@ class GoogleSignalsSettings(proto.Message): class CustomDimension(proto.Message): r"""A definition for a CustomDimension. + Attributes: name (str): Output only. Resource name for this @@ -1159,6 +1167,7 @@ class DimensionScope(proto.Enum): class CustomMetric(proto.Message): r"""A definition for a custom metric. + Attributes: name (str): Output only. Resource name for this diff --git a/packages/google-analytics-admin/tests/unit/gapic/admin_v1alpha/test_analytics_admin_service.py b/packages/google-analytics-admin/tests/unit/gapic/admin_v1alpha/test_analytics_admin_service.py index 18c19fadccfd..c739fa56cafe 100644 --- a/packages/google-analytics-admin/tests/unit/gapic/admin_v1alpha/test_analytics_admin_service.py +++ b/packages/google-analytics-admin/tests/unit/gapic/admin_v1alpha/test_analytics_admin_service.py @@ -42,6 +42,7 @@ from google.api_core import gapic_v1 from google.api_core import grpc_helpers from google.api_core import grpc_helpers_async +from google.api_core import path_template from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.oauth2 import service_account @@ -21437,6 +21438,9 @@ def test_analytics_admin_service_base_transport(): with pytest.raises(NotImplementedError): getattr(transport, method)(request=object()) + with pytest.raises(NotImplementedError): + transport.close() + @requires_google_auth_gte_1_25_0 def test_analytics_admin_service_base_transport_with_credentials_file(): @@ -22366,3 +22370,49 @@ def test_client_withDEFAULT_CLIENT_INFO(): credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, ) prep.assert_called_once_with(client_info) + + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = AnalyticsAdminServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio", + ) + with mock.patch.object( + type(getattr(client.transport, "grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = AnalyticsAdminServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + with mock.patch.object( + type(getattr(client.transport, close_name)), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "grpc", + ] + for transport in transports: + client = AnalyticsAdminServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called()