google-analytics-admin 0.24.0__tar.gz → 0.24.1__tar.gz

{google_analytics_admin-0.24.0/google_analytics_admin.egg-info → google_analytics_admin-0.24.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: google-analytics-admin
-Version: 0.24.0
+Version: 0.24.1
 Summary: Google Analytics Admin API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-analytics-admin
 Author: Google LLC
@@ -28,6 +28,17 @@ Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
 Requires-Dist: proto-plus<2.0.0,>=1.22.3
 Requires-Dist: proto-plus<2.0.0,>=1.25.0; python_version >= "3.13"
 Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<7.0.0,>=3.20.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 Python Client for Analytics Admin
 =================================

{google_analytics_admin-0.24.0 → google_analytics_admin-0.24.1}/google/analytics/admin/__init__.py

@@ -149,6 +149,7 @@ from google.analytics.admin_v1alpha.types.analytics_admin import (
     GetSearchAds360LinkRequest,
     GetSKAdNetworkConversionValueSchemaRequest,
     GetSubpropertyEventFilterRequest,
+    GetSubpropertySyncConfigRequest,
     ListAccessBindingsRequest,
     ListAccessBindingsResponse,
     ListAccountsRequest,
@@ -205,6 +206,8 @@ from google.analytics.admin_v1alpha.types.analytics_admin import (
     ListSKAdNetworkConversionValueSchemasResponse,
     ListSubpropertyEventFiltersRequest,
     ListSubpropertyEventFiltersResponse,
+    ListSubpropertySyncConfigsRequest,
+    ListSubpropertySyncConfigsResponse,
     ProvisionAccountTicketRequest,
     ProvisionAccountTicketResponse,
     ProvisionSubpropertyRequest,
@@ -245,6 +248,7 @@ from google.analytics.admin_v1alpha.types.analytics_admin import (
     UpdateSearchAds360LinkRequest,
     UpdateSKAdNetworkConversionValueSchemaRequest,
     UpdateSubpropertyEventFilterRequest,
+    UpdateSubpropertySyncConfigRequest,
 )
 from google.analytics.admin_v1alpha.types.audience import (
     Audience,
@@ -325,6 +329,7 @@ from google.analytics.admin_v1alpha.types.resources import (
     SearchAds360Link,
     ServiceLevel,
     SKAdNetworkConversionValueSchema,
+    SubpropertySyncConfig,
 )
 from google.analytics.admin_v1alpha.types.subproperty_event_filter import (
     SubpropertyEventFilter,
@@ -459,6 +464,7 @@ __all__ = (
     "GetSearchAds360LinkRequest",
     "GetSKAdNetworkConversionValueSchemaRequest",
     "GetSubpropertyEventFilterRequest",
+    "GetSubpropertySyncConfigRequest",
     "ListAccessBindingsRequest",
     "ListAccessBindingsResponse",
     "ListAccountsRequest",
@@ -515,6 +521,8 @@ __all__ = (
     "ListSKAdNetworkConversionValueSchemasResponse",
     "ListSubpropertyEventFiltersRequest",
     "ListSubpropertyEventFiltersResponse",
+    "ListSubpropertySyncConfigsRequest",
+    "ListSubpropertySyncConfigsResponse",
     "ProvisionAccountTicketRequest",
     "ProvisionAccountTicketResponse",
     "ProvisionSubpropertyRequest",
@@ -555,6 +563,7 @@ __all__ = (
     "UpdateSearchAds360LinkRequest",
     "UpdateSKAdNetworkConversionValueSchemaRequest",
     "UpdateSubpropertyEventFilterRequest",
+    "UpdateSubpropertySyncConfigRequest",
     "Audience",
     "AudienceDimensionOrMetricFilter",
     "AudienceEventFilter",
@@ -614,6 +623,7 @@ __all__ = (
     "RollupPropertySourceLink",
     "SearchAds360Link",
     "SKAdNetworkConversionValueSchema",
+    "SubpropertySyncConfig",
     "ActionType",
     "ActorType",
     "ChangeHistoryResourceType",

{google_analytics_admin-0.24.0 → google_analytics_admin-0.24.1}/google/analytics/admin/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.24.0"  # {x-release-please-version}
+__version__ = "0.24.1"  # {x-release-please-version}

{google_analytics_admin-0.24.0 → google_analytics_admin-0.24.1}/google/analytics/admin_v1alpha/__init__.py

@@ -147,6 +147,7 @@ from .types.analytics_admin import (
     GetSearchAds360LinkRequest,
     GetSKAdNetworkConversionValueSchemaRequest,
     GetSubpropertyEventFilterRequest,
+    GetSubpropertySyncConfigRequest,
     ListAccessBindingsRequest,
     ListAccessBindingsResponse,
     ListAccountsRequest,
@@ -203,6 +204,8 @@ from .types.analytics_admin import (
     ListSKAdNetworkConversionValueSchemasResponse,
     ListSubpropertyEventFiltersRequest,
     ListSubpropertyEventFiltersResponse,
+    ListSubpropertySyncConfigsRequest,
+    ListSubpropertySyncConfigsResponse,
     ProvisionAccountTicketRequest,
     ProvisionAccountTicketResponse,
     ProvisionSubpropertyRequest,
@@ -243,6 +246,7 @@ from .types.analytics_admin import (
     UpdateSearchAds360LinkRequest,
     UpdateSKAdNetworkConversionValueSchemaRequest,
     UpdateSubpropertyEventFilterRequest,
+    UpdateSubpropertySyncConfigRequest,
 )
 from .types.audience import (
     Audience,
@@ -323,6 +327,7 @@ from .types.resources import (
     SearchAds360Link,
     ServiceLevel,
     SKAdNetworkConversionValueSchema,
+    SubpropertySyncConfig,
 )
 from .types.subproperty_event_filter import (
     SubpropertyEventFilter,
@@ -503,6 +508,7 @@ __all__ = (
     "GetSKAdNetworkConversionValueSchemaRequest",
     "GetSearchAds360LinkRequest",
     "GetSubpropertyEventFilterRequest",
+    "GetSubpropertySyncConfigRequest",
     "GlobalSiteTag",
     "GoogleAdsLink",
     "GoogleSignalsConsent",
@@ -570,6 +576,8 @@ __all__ = (
     "ListSearchAds360LinksResponse",
     "ListSubpropertyEventFiltersRequest",
     "ListSubpropertyEventFiltersResponse",
+    "ListSubpropertySyncConfigsRequest",
+    "ListSubpropertySyncConfigsResponse",
     "MatchingCondition",
     "MeasurementProtocolSecret",
     "NumericValue",
@@ -601,6 +609,7 @@ __all__ = (
     "SubpropertyEventFilterCondition",
     "SubpropertyEventFilterExpression",
     "SubpropertyEventFilterExpressionList",
+    "SubpropertySyncConfig",
     "UpdateAccessBindingRequest",
     "UpdateAccountRequest",
     "UpdateAttributionSettingsRequest",
@@ -628,4 +637,5 @@ __all__ = (
     "UpdateSKAdNetworkConversionValueSchemaRequest",
     "UpdateSearchAds360LinkRequest",
     "UpdateSubpropertyEventFilterRequest",
+    "UpdateSubpropertySyncConfigRequest",
 )

{google_analytics_admin-0.24.0 → google_analytics_admin-0.24.1}/google/analytics/admin_v1alpha/gapic_metadata.json

@@ -480,6 +480,11 @@
                 "get_subproperty_event_filter"
               ]
             },
+            "GetSubpropertySyncConfig": {
+              "methods": [
+                "get_subproperty_sync_config"
+              ]
+            },
             "ListAccessBindings": {
               "methods": [
                 "list_access_bindings"
@@ -620,6 +625,11 @@
                 "list_subproperty_event_filters"
               ]
             },
+            "ListSubpropertySyncConfigs": {
+              "methods": [
+                "list_subproperty_sync_configs"
+              ]
+            },
             "ProvisionAccountTicket": {
               "methods": [
                 "provision_account_ticket"
@@ -789,6 +799,11 @@
               "methods": [
                 "update_subproperty_event_filter"
               ]
+            },
+            "UpdateSubpropertySyncConfig": {
+              "methods": [
+                "update_subproperty_sync_config"
+              ]
             }
           }
         },
@@ -1265,6 +1280,11 @@
                 "get_subproperty_event_filter"
               ]
             },
+            "GetSubpropertySyncConfig": {
+              "methods": [
+                "get_subproperty_sync_config"
+              ]
+            },
             "ListAccessBindings": {
               "methods": [
                 "list_access_bindings"
@@ -1405,6 +1425,11 @@
                 "list_subproperty_event_filters"
               ]
             },
+            "ListSubpropertySyncConfigs": {
+              "methods": [
+                "list_subproperty_sync_configs"
+              ]
+            },
             "ProvisionAccountTicket": {
               "methods": [
                 "provision_account_ticket"
@@ -1574,6 +1599,11 @@
               "methods": [
                 "update_subproperty_event_filter"
               ]
+            },
+            "UpdateSubpropertySyncConfig": {
+              "methods": [
+                "update_subproperty_sync_config"
+              ]
             }
           }
         },
@@ -2050,6 +2080,11 @@
                 "get_subproperty_event_filter"
               ]
             },
+            "GetSubpropertySyncConfig": {
+              "methods": [
+                "get_subproperty_sync_config"
+              ]
+            },
             "ListAccessBindings": {
               "methods": [
                 "list_access_bindings"
@@ -2190,6 +2225,11 @@
                 "list_subproperty_event_filters"
               ]
             },
+            "ListSubpropertySyncConfigs": {
+              "methods": [
+                "list_subproperty_sync_configs"
+              ]
+            },
             "ProvisionAccountTicket": {
               "methods": [
                 "provision_account_ticket"
@@ -2359,6 +2399,11 @@
               "methods": [
                 "update_subproperty_event_filter"
               ]
+            },
+            "UpdateSubpropertySyncConfig": {
+              "methods": [
+                "update_subproperty_sync_config"
+              ]
             }
           }
         }

{google_analytics_admin-0.24.0/google/analytics/admin_v1beta → google_analytics_admin-0.24.1/google/analytics/admin_v1alpha}/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.24.0"  # {x-release-please-version}
+__version__ = "0.24.1"  # {x-release-please-version}

{google_analytics_admin-0.24.0 → google_analytics_admin-0.24.1}/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py

@@ -36,6 +36,7 @@ from google.api_core import retry_async as retries
 from google.api_core.client_options import ClientOptions
 from google.auth import credentials as ga_credentials  # type: ignore
 from google.oauth2 import service_account  # type: ignore
+import google.protobuf
 
 from google.analytics.admin_v1alpha import gapic_version as package_version
 
@@ -272,6 +273,12 @@ class AnalyticsAdminServiceAsyncClient:
     parse_subproperty_event_filter_path = staticmethod(
         AnalyticsAdminServiceClient.parse_subproperty_event_filter_path
     )
+    subproperty_sync_config_path = staticmethod(
+        AnalyticsAdminServiceClient.subproperty_sync_config_path
+    )
+    parse_subproperty_sync_config_path = staticmethod(
+        AnalyticsAdminServiceClient.parse_subproperty_sync_config_path
+    )
     common_billing_account_path = staticmethod(
         AnalyticsAdminServiceClient.common_billing_account_path
     )
@@ -14685,6 +14692,311 @@ class AnalyticsAdminServiceAsyncClient:
         # Done; return the response.
         return response
 
+    async def list_subproperty_sync_configs(
+        self,
+        request: Optional[
+            Union[analytics_admin.ListSubpropertySyncConfigsRequest, dict]
+        ] = None,
+        *,
+        parent: Optional[str] = None,
+        retry: OptionalRetry = gapic_v1.method.DEFAULT,
+        timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
+    ) -> pagers.ListSubpropertySyncConfigsAsyncPager:
+        r"""List all Subproperty Sync Configs on a property.
+
+        Args:
+            request (Optional[Union[google.analytics.admin_v1alpha.types.ListSubpropertySyncConfigsRequest, dict]]):
+                The request object. Request message for
+                ListSubpropertySyncConfigs RPC.
+            parent (:class:`str`):
+                Required. Resource name of the property. Format:
+                properties/property_id Example: properties/123
+
+                This corresponds to the ``parent`` field
+                on the ``request`` instance; if ``request`` is provided, this
+                should not be set.
+            retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any,
+                should be retried.
+            timeout (float): The timeout for this request.
+            metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be
+                sent along with the request as metadata. Normally, each value must be of type `str`,
+                but for metadata keys ending with the suffix `-bin`, the corresponding values must
+                be of type `bytes`.
+
+        Returns:
+            google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListSubpropertySyncConfigsAsyncPager:
+                Response message for
+                ListSubpropertySyncConfigs RPC.
+                Iterating over this object will yield
+                results and resolve additional pages
+                automatically.
+
+        """
+        # Create or coerce a protobuf request object.
+        # - Quick check: If we got a request object, we should *not* have
+        #   gotten any keyword arguments that map to the request.
+        flattened_params = [parent]
+        has_flattened_params = (
+            len([param for param in flattened_params if param is not None]) > 0
+        )
+        if request is not None and has_flattened_params:
+            raise ValueError(
+                "If the `request` argument is set, then none of "
+                "the individual field arguments should be set."
+            )
+
+        # - Use the request object if provided (there's no risk of modifying the input as
+        #   there are no flattened fields), or create one.
+        if not isinstance(request, analytics_admin.ListSubpropertySyncConfigsRequest):
+            request = analytics_admin.ListSubpropertySyncConfigsRequest(request)
+
+        # If we have keyword arguments corresponding to fields on the
+        # request, apply these.
+        if parent is not None:
+            request.parent = parent
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = self._client._transport._wrapped_methods[
+            self._client._transport.list_subproperty_sync_configs
+        ]
+
+        # Certain fields should be provided within the metadata header;
+        # add these here.
+        metadata = tuple(metadata) + (
+            gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
+        )
+
+        # Validate the universe domain.
+        self._client._validate_universe_domain()
+
+        # Send the request.
+        response = await rpc(
+            request,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # This method is paged; wrap the response in a pager, which provides
+        # an `__aiter__` convenience method.
+        response = pagers.ListSubpropertySyncConfigsAsyncPager(
+            method=rpc,
+            request=request,
+            response=response,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # Done; return the response.
+        return response
+
+    async def update_subproperty_sync_config(
+        self,
+        request: Optional[
+            Union[analytics_admin.UpdateSubpropertySyncConfigRequest, dict]
+        ] = None,
+        *,
+        subproperty_sync_config: Optional[resources.SubpropertySyncConfig] = None,
+        update_mask: Optional[field_mask_pb2.FieldMask] = None,
+        retry: OptionalRetry = gapic_v1.method.DEFAULT,
+        timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
+    ) -> resources.SubpropertySyncConfig:
+        r"""Updates a Subproperty Sync Config.
+
+        Args:
+            request (Optional[Union[google.analytics.admin_v1alpha.types.UpdateSubpropertySyncConfigRequest, dict]]):
+                The request object. Request message for
+                UpdateSubpropertySyncConfig RPC.
+            subproperty_sync_config (:class:`google.analytics.admin_v1alpha.types.SubpropertySyncConfig`):
+                Required. The SubpropertySyncConfig
+                to update.
+
+                This corresponds to the ``subproperty_sync_config`` field
+                on the ``request`` instance; if ``request`` is provided, this
+                should not be set.
+            update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
+                Optional. The list of fields to update. Field names must
+                be in snake case (for example, "field_to_update").
+                Omitted fields will not be updated. To replace the
+                entire entity, use one path with the string "*" to match
+                all fields.
+
+                This corresponds to the ``update_mask`` field
+                on the ``request`` instance; if ``request`` is provided, this
+                should not be set.
+            retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any,
+                should be retried.
+            timeout (float): The timeout for this request.
+            metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be
+                sent along with the request as metadata. Normally, each value must be of type `str`,
+                but for metadata keys ending with the suffix `-bin`, the corresponding values must
+                be of type `bytes`.
+
+        Returns:
+            google.analytics.admin_v1alpha.types.SubpropertySyncConfig:
+                Subproperty synchronization
+                configuration controls how ordinary
+                property configurations are synchronized
+                to subproperties. This resource is
+                provisioned automatically for each
+                subproperty.
+
+        """
+        # Create or coerce a protobuf request object.
+        # - Quick check: If we got a request object, we should *not* have
+        #   gotten any keyword arguments that map to the request.
+        flattened_params = [subproperty_sync_config, update_mask]
+        has_flattened_params = (
+            len([param for param in flattened_params if param is not None]) > 0
+        )
+        if request is not None and has_flattened_params:
+            raise ValueError(
+                "If the `request` argument is set, then none of "
+                "the individual field arguments should be set."
+            )
+
+        # - Use the request object if provided (there's no risk of modifying the input as
+        #   there are no flattened fields), or create one.
+        if not isinstance(request, analytics_admin.UpdateSubpropertySyncConfigRequest):
+            request = analytics_admin.UpdateSubpropertySyncConfigRequest(request)
+
+        # If we have keyword arguments corresponding to fields on the
+        # request, apply these.
+        if subproperty_sync_config is not None:
+            request.subproperty_sync_config = subproperty_sync_config
+        if update_mask is not None:
+            request.update_mask = update_mask
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = self._client._transport._wrapped_methods[
+            self._client._transport.update_subproperty_sync_config
+        ]
+
+        # Certain fields should be provided within the metadata header;
+        # add these here.
+        metadata = tuple(metadata) + (
+            gapic_v1.routing_header.to_grpc_metadata(
+                (
+                    (
+                        "subproperty_sync_config.name",
+                        request.subproperty_sync_config.name,
+                    ),
+                )
+            ),
+        )
+
+        # Validate the universe domain.
+        self._client._validate_universe_domain()
+
+        # Send the request.
+        response = await rpc(
+            request,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # Done; return the response.
+        return response
+
+    async def get_subproperty_sync_config(
+        self,
+        request: Optional[
+            Union[analytics_admin.GetSubpropertySyncConfigRequest, dict]
+        ] = None,
+        *,
+        name: Optional[str] = None,
+        retry: OptionalRetry = gapic_v1.method.DEFAULT,
+        timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
+    ) -> resources.SubpropertySyncConfig:
+        r"""Lookup for a single Subproperty Sync Config.
+
+        Args:
+            request (Optional[Union[google.analytics.admin_v1alpha.types.GetSubpropertySyncConfigRequest, dict]]):
+                The request object. Request message for
+                GetSubpropertySyncConfig RPC.
+            name (:class:`str`):
+                Required. Resource name of the SubpropertySyncConfig to
+                lookup. Format:
+                properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id}
+                Example: properties/1234/subpropertySyncConfigs/5678
+
+                This corresponds to the ``name`` field
+                on the ``request`` instance; if ``request`` is provided, this
+                should not be set.
+            retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any,
+                should be retried.
+            timeout (float): The timeout for this request.
+            metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be
+                sent along with the request as metadata. Normally, each value must be of type `str`,
+                but for metadata keys ending with the suffix `-bin`, the corresponding values must
+                be of type `bytes`.
+
+        Returns:
+            google.analytics.admin_v1alpha.types.SubpropertySyncConfig:
+                Subproperty synchronization
+                configuration controls how ordinary
+                property configurations are synchronized
+                to subproperties. This resource is
+                provisioned automatically for each
+                subproperty.
+
+        """
+        # Create or coerce a protobuf request object.
+        # - Quick check: If we got a request object, we should *not* have
+        #   gotten any keyword arguments that map to the request.
+        flattened_params = [name]
+        has_flattened_params = (
+            len([param for param in flattened_params if param is not None]) > 0
+        )
+        if request is not None and has_flattened_params:
+            raise ValueError(
+                "If the `request` argument is set, then none of "
+                "the individual field arguments should be set."
+            )
+
+        # - Use the request object if provided (there's no risk of modifying the input as
+        #   there are no flattened fields), or create one.
+        if not isinstance(request, analytics_admin.GetSubpropertySyncConfigRequest):
+            request = analytics_admin.GetSubpropertySyncConfigRequest(request)
+
+        # If we have keyword arguments corresponding to fields on the
+        # request, apply these.
+        if name is not None:
+            request.name = name
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = self._client._transport._wrapped_methods[
+            self._client._transport.get_subproperty_sync_config
+        ]
+
+        # Certain fields should be provided within the metadata header;
+        # add these here.
+        metadata = tuple(metadata) + (
+            gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
+        )
+
+        # Validate the universe domain.
+        self._client._validate_universe_domain()
+
+        # Send the request.
+        response = await rpc(
+            request,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # Done; return the response.
+        return response
+
     async def __aenter__(self) -> "AnalyticsAdminServiceAsyncClient":
         return self
 
@@ -14696,5 +15008,8 @@ DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
     gapic_version=package_version.__version__
 )
 
+if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"):  # pragma: NO COVER
+    DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
+
 
 __all__ = ("AnalyticsAdminServiceAsyncClient",)