google-api-python-client 2.122.0__py2.py3-none-any.whl → 2.124.0__py2.py3-none-any.whl

googleapiclient/discovery.py

@@ -53,6 +53,13 @@ try:
 except ImportError:  # pragma: NO COVER
     google_auth_httplib2 = None
 
+try:
+    from google.api_core import universe
+
+    HAS_UNIVERSE = True
+except ImportError:
+    HAS_UNIVERSE = False
+
 # Local imports
 from googleapiclient import _auth, mimeparse
 from googleapiclient._helpers import _add_query_parameter, positional
@@ -116,12 +123,22 @@ _PAGE_TOKEN_NAMES = ("pageToken", "nextPageToken")
 # Parameters controlling mTLS behavior. See https://google.aip.dev/auth/4114.
 GOOGLE_API_USE_CLIENT_CERTIFICATE = "GOOGLE_API_USE_CLIENT_CERTIFICATE"
 GOOGLE_API_USE_MTLS_ENDPOINT = "GOOGLE_API_USE_MTLS_ENDPOINT"
-
+GOOGLE_CLOUD_UNIVERSE_DOMAIN = "GOOGLE_CLOUD_UNIVERSE_DOMAIN"
+DEFAULT_UNIVERSE = "googleapis.com"
 # Parameters accepted by the stack, but not visible via discovery.
 # TODO(dhermes): Remove 'userip' in 'v2'.
 STACK_QUERY_PARAMETERS = frozenset(["trace", "pp", "userip", "strict"])
 STACK_QUERY_PARAMETER_DEFAULT_VALUE = {"type": "string", "location": "query"}
 
+
+class APICoreVersionError(ValueError):
+    def __init__(self):
+        message = (
+            "google-api-core >= 2.18.0 is required to use the universe domain feature."
+        )
+        super().__init__(message)
+
+
 # Library-specific reserved words beyond Python keywords.
 RESERVED_WORDS = frozenset(["body"])
 
@@ -436,6 +453,13 @@ def _retrieve_discovery_doc(
     return content
 
 
+def _check_api_core_compatible_with_credentials_universe(credentials):
+    if not HAS_UNIVERSE:
+        credentials_universe = getattr(credentials, "universe_domain", None)
+        if credentials_universe and credentials_universe != DEFAULT_UNIVERSE:
+            raise APICoreVersionError
+
+
 @positional(1)
 def build_from_document(
     service,
@@ -544,6 +568,18 @@ def build_from_document(
 
     # If an API Endpoint is provided on client options, use that as the base URL
     base = urllib.parse.urljoin(service["rootUrl"], service["servicePath"])
+    universe_domain = None
+    if HAS_UNIVERSE:
+        universe_domain_env = os.getenv(GOOGLE_CLOUD_UNIVERSE_DOMAIN, None)
+        universe_domain = universe.determine_domain(
+            client_options.universe_domain, universe_domain_env
+        )
+        base = base.replace(universe.DEFAULT_UNIVERSE, universe_domain)
+    else:
+        client_universe = getattr(client_options, "universe_domain", None)
+        if client_universe:
+            raise APICoreVersionError
+
     audience_for_self_signed_jwt = base
     if client_options.api_endpoint:
         base = client_options.api_endpoint
@@ -582,6 +618,9 @@ def build_from_document(
                     quota_project_id=client_options.quota_project_id,
                 )
 
+            # Check google-api-core >= 2.18.0 if credentials' universe != "googleapis.com".
+            _check_api_core_compatible_with_credentials_universe(credentials)
+
             # The credentials need to be scoped.
             # If the user provided scopes via client_options don't override them
             if not client_options.scopes:
@@ -666,7 +705,15 @@ def build_from_document(
             if use_mtls_endpoint == "always" or (
                 use_mtls_endpoint == "auto" and client_cert_to_use
             ):
+                if HAS_UNIVERSE and universe_domain != universe.DEFAULT_UNIVERSE:
+                    raise MutualTLSChannelError(
+                        f"mTLS is not supported in any universe other than {universe.DEFAULT_UNIVERSE}."
+                    )
                 base = mtls_endpoint
+    else:
+        # Check google-api-core >= 2.18.0 if credentials' universe != "googleapis.com".
+        http_credentials = getattr(http, "credentials", None)
+        _check_api_core_compatible_with_credentials_universe(http_credentials)
 
     if model is None:
         features = service.get("features", [])
@@ -681,6 +728,7 @@ def build_from_document(
         resourceDesc=service,
         rootDesc=service,
         schema=schema,
+        universe_domain=universe_domain,
     )
 
 
@@ -1043,6 +1091,9 @@ def createMethod(methodName, methodDesc, rootDesc, schema):
     def method(self, **kwargs):
         # Don't bother with doc string, it will be over-written by createMethod.
 
+        # Validate credentials for the configured universe.
+        self._validate_credentials()
+
         for name in kwargs:
             if name not in parameters.argmap:
                 raise TypeError("Got an unexpected keyword argument {}".format(name))
@@ -1352,6 +1403,7 @@ class Resource(object):
         resourceDesc,
         rootDesc,
         schema,
+        universe_domain=universe.DEFAULT_UNIVERSE if HAS_UNIVERSE else "",
     ):
         """Build a Resource from the API description.
 
@@ -1369,6 +1421,8 @@ class Resource(object):
               is considered a resource.
           rootDesc: object, the entire deserialized discovery document.
           schema: object, mapping of schema names to schema descriptions.
+          universe_domain: string, the universe for the API. The default universe
+          is "googleapis.com".
         """
         self._dynamic_attrs = []
 
@@ -1380,6 +1434,8 @@ class Resource(object):
         self._resourceDesc = resourceDesc
         self._rootDesc = rootDesc
         self._schema = schema
+        self._universe_domain = universe_domain
+        self._credentials_validated = False
 
         self._set_service_methods()
 
@@ -1502,6 +1558,7 @@ class Resource(object):
                         resourceDesc=methodDesc,
                         rootDesc=rootDesc,
                         schema=schema,
+                        universe_domain=self._universe_domain,
                     )
 
                 setattr(methodResource, "__doc__", "A collection resource.")
@@ -1546,6 +1603,27 @@ class Resource(object):
                 fixedMethodName, method.__get__(self, self.__class__)
             )
 
+    def _validate_credentials(self):
+        """Validates client's and credentials' universe domains are consistent.
+
+        Returns:
+            bool: True iff the configured universe domain is valid.
+
+        Raises:
+            UniverseMismatchError: If the configured universe domain is not valid.
+        """
+        credentials = getattr(self._http, "credentials", None)
+
+        self._credentials_validated = (
+            (
+                self._credentials_validated
+                or universe.compare_domains(self._universe_domain, credentials)
+            )
+            if HAS_UNIVERSE
+            else True
+        )
+        return self._credentials_validated
+
 
 def _findPageTokenName(fields):
     """Search field names for one like a page token.

googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json

@@ -115,7 +115,7 @@
 }
 }
 },
-"revision": "20240310",
+"revision": "20240324",
 "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
 "schemas": {
 "AmpUrl": {

googleapiclient/discovery_cache/documents/accessapproval.v1.json

@@ -913,7 +913,7 @@
 }
 }
 },
-"revision": "20240311",
+"revision": "20240322",
 "rootUrl": "https://accessapproval.googleapis.com/",
 "schemas": {
 "AccessApprovalServiceAccount": {

googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json

@@ -1290,7 +1290,7 @@
 }
 }
 },
-"revision": "20240226",
+"revision": "20240318",
 "rootUrl": "https://accesscontextmanager.googleapis.com/",
 "schemas": {
 "AccessContextManagerOperationMetadata": {

googleapiclient/discovery_cache/documents/acmedns.v1.json

@@ -146,7 +146,7 @@
 }
 }
 },
-"revision": "20240310",
+"revision": "20240324",
 "rootUrl": "https://acmedns.googleapis.com/",
 "schemas": {
 "AcmeChallengeSet": {

googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json

@@ -3115,7 +3115,7 @@
 }
 }
 },
-"revision": "20240311",
+"revision": "20240325",
 "rootUrl": "https://adexchangebuyer.googleapis.com/",
 "schemas": {
 "AbsoluteDateRange": {

googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json

@@ -272,7 +272,7 @@
 }
 }
 },
-"revision": "20240304",
+"revision": "20240321",
 "rootUrl": "https://admin.googleapis.com/",
 "schemas": {
 "Application": {

googleapiclient/discovery_cache/documents/admin.datatransferv1.json

@@ -272,7 +272,7 @@
 }
 }
 },
-"revision": "20240304",
+"revision": "20240321",
 "rootUrl": "https://admin.googleapis.com/",
 "schemas": {
 "Application": {

googleapiclient/discovery_cache/documents/admin.directory_v1.json

@@ -4671,7 +4671,7 @@
 }
 }
 },
-"revision": "20240304",
+"revision": "20240321",
 "rootUrl": "https://admin.googleapis.com/",
 "schemas": {
 "Alias": {

googleapiclient/discovery_cache/documents/admin.directoryv1.json

@@ -4671,7 +4671,7 @@
 }
 }
 },
-"revision": "20240304",
+"revision": "20240321",
 "rootUrl": "https://admin.googleapis.com/",
 "schemas": {
 "Alias": {

googleapiclient/discovery_cache/documents/admin.reports_v1.json

@@ -626,7 +626,7 @@
 }
 }
 },
-"revision": "20240304",
+"revision": "20240321",
 "rootUrl": "https://admin.googleapis.com/",
 "schemas": {
 "Activities": {

googleapiclient/discovery_cache/documents/admin.reportsv1.json

@@ -626,7 +626,7 @@
 }
 }
 },
-"revision": "20240304",
+"revision": "20240321",
 "rootUrl": "https://admin.googleapis.com/",
 "schemas": {
 "Activities": {

googleapiclient/discovery_cache/documents/admob.v1.json

@@ -321,7 +321,7 @@
 }
 }
 },
-"revision": "20240311",
+"revision": "20240325",
 "rootUrl": "https://admob.googleapis.com/",
 "schemas": {
 "AdUnit": {

googleapiclient/discovery_cache/documents/admob.v1beta.json

@@ -758,7 +758,7 @@
 }
 }
 },
-"revision": "20240311",
+"revision": "20240325",
 "rootUrl": "https://admob.googleapis.com/",
 "schemas": {
 "AdSource": {

googleapiclient/discovery_cache/documents/adsense.v2.json

@@ -324,7 +324,7 @@
 "adunits": {
 "methods": {
 "create": {
-"description": "Creates an ad unit. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. Note that ad units can only be created for ad clients with an \"AFC\" product code. For more info see the [AdClient resource](/adsense/management/reference/rest/v2/accounts.adclients). For now, this method can only be used to create `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566",
+"description": "Creates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. Note that ad units can only be created for ad clients with an \"AFC\" product code. For more info see the [AdClient resource](/adsense/management/reference/rest/v2/accounts.adclients). For now, this method can only be used to create `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566",
 "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits",
 "httpMethod": "POST",
 "id": "adsense.accounts.adclients.adunits.create",
@@ -478,7 +478,7 @@
 ]
 },
 "patch": {
-"description": "Updates an ad unit. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. For now, this method can only be used to update `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566",
+"description": "Updates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. For now, this method can only be used to update `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566",
 "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits/{adunitsId}",
 "httpMethod": "PATCH",
 "id": "adsense.accounts.adclients.adunits.patch",
@@ -516,7 +516,7 @@
 "customchannels": {
 "methods": {
 "create": {
-"description": "Creates a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.",
+"description": "Creates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.",
 "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels",
 "httpMethod": "POST",
 "id": "adsense.accounts.adclients.customchannels.create",
@@ -544,7 +544,7 @@
 ]
 },
 "delete": {
-"description": "Deletes a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.",
+"description": "Deletes a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.",
 "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels/{customchannelsId}",
 "httpMethod": "DELETE",
 "id": "adsense.accounts.adclients.customchannels.delete",
@@ -669,7 +669,7 @@
 ]
 },
 "patch": {
-"description": "Updates a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.",
+"description": "Updates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.",
 "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels/{customchannelsId}",
 "httpMethod": "PATCH",
 "id": "adsense.accounts.adclients.customchannels.patch",
@@ -838,6 +838,73 @@
 }
 }
 },
+"policyIssues": {
+"methods": {
+"get": {
+"description": "Gets information about the selected policy issue.",
+"flatPath": "v2/accounts/{accountsId}/policyIssues/{policyIssuesId}",
+"httpMethod": "GET",
+"id": "adsense.accounts.policyIssues.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the policy issue. Format: accounts/{account}/policyIssues/{policy_issue}",
+"location": "path",
+"pattern": "^accounts/[^/]+/policyIssues/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+name}",
+"response": {
+"$ref": "PolicyIssue"
+},
+"scopes": [
+"https://www.googleapis.com/auth/adsense",
+"https://www.googleapis.com/auth/adsense.readonly"
+]
+},
+"list": {
+"description": "Lists all the policy issues for the specified account.",
+"flatPath": "v2/accounts/{accountsId}/policyIssues",
+"httpMethod": "GET",
+"id": "adsense.accounts.policyIssues.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "The maximum number of policy issues to include in the response, used for paging. If unspecified, at most 10000 policy issues will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous `ListPolicyIssues` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPolicyIssues` must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The account for which policy issues are being retrieved. Format: accounts/{account}",
+"location": "path",
+"pattern": "^accounts/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+parent}/policyIssues",
+"response": {
+"$ref": "ListPolicyIssuesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/adsense",
+"https://www.googleapis.com/auth/adsense.readonly"
+]
+}
+}
+},
 "reports": {
 "methods": {
 "generate": {
@@ -1845,7 +1912,7 @@
 }
 }
 },
-"revision": "20240311",
+"revision": "20240324",
 "rootUrl": "https://adsense.googleapis.com/",
 "schemas": {
 "Account": {
@@ -2392,6 +2459,24 @@ true
 },
 "type": "object"
 },
+"ListPolicyIssuesResponse": {
+"description": "Response definition for the policy issues list rpc. Policy issues are reported only if the publisher has at least one AFC ad client in READY or GETTING_READY state. If the publisher has no such AFC ad client, the response will be an empty list.",
+"id": "ListPolicyIssuesResponse",
+"properties": {
+"nextPageToken": {
+"description": "Continuation token used to page through policy issues. To retrieve the next page of the results, set the next request's \"page_token\" value to this.",
+"type": "string"
+},
+"policyIssues": {
+"description": "The policy issues returned in the list response.",
+"items": {
+"$ref": "PolicyIssue"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "ListSavedReportsResponse": {
 "description": "Response definition for the saved reports list rpc.",
 "id": "ListSavedReportsResponse",
@@ -2468,6 +2553,111 @@ true
 },
 "type": "object"
 },
+"PolicyIssue": {
+"description": "Representation of a policy issue for a single entity (site, site-section, or page). All issues for a single entity are represented by a single PolicyIssue resource, though that PolicyIssue can have multiple causes (or \"topics\") that can change over time. Policy issues are removed if there are no issues detected recently or if there's a recent successful appeal for the entity.",
+"id": "PolicyIssue",
+"properties": {
+"action": {
+"description": "Required. The most severe action taken on the entity over the past seven days.",
+"enum": [
+"ENFORCEMENT_ACTION_UNSPECIFIED",
+"WARNED",
+"AD_SERVING_RESTRICTED",
+"AD_SERVING_DISABLED",
+"AD_SERVED_WITH_CLICK_CONFIRMATION",
+"AD_PERSONALIZATION_RESTRICTED"
+],
+"enumDescriptions": [
+"The action is unspecified.",
+"No ad serving enforcement is currently present, but enforcement will start on the `warning_escalation_date` if the issue is not resolved.",
+"Ad serving demand has been restricted on the entity.",
+"Ad serving has been disabled on the entity.",
+"Ads are being served for the entity but Confirmed Click is being applied to the ads. See https://support.google.com/adsense/answer/10025624.",
+"Ad personalization is restricted because the ad requests coming from the EEA and UK do not have a TCF string or the Consent Management Platform (CMP) indicated by the TCF string is not Google certified. As a result, basic/limited ads will be served. See https://support.google.com/adsense/answer/13554116"
+],
+"type": "string"
+},
+"adClients": {
+"description": "Optional. List of ad clients associated with the policy issue (either as the primary ad client or an associated host/secondary ad client). In the latter case, this will be an ad client that is not owned by the current account.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"adRequestCount": {
+"description": "Required. Total number of ad requests affected by the policy violations over the past seven days.",
+"format": "int64",
+"type": "string"
+},
+"entityType": {
+"description": "Required. Type of the entity indicating if the entity is a site, site-section, or page.",
+"enum": [
+"ENTITY_TYPE_UNSPECIFIED",
+"SITE",
+"SITE_SECTION",
+"PAGE"
+],
+"enumDescriptions": [
+"The entity type is unspecified.",
+"The enforced entity is an entire website.",
+"The enforced entity is a particular section of a website. All the pages with this prefix are enforced.",
+"The enforced entity is a single web page."
+],
+"type": "string"
+},
+"firstDetectedDate": {
+"$ref": "Date",
+"description": "Required. The date (in the America/Los_Angeles timezone) when policy violations were first detected on the entity."
+},
+"lastDetectedDate": {
+"$ref": "Date",
+"description": "Required. The date (in the America/Los_Angeles timezone) when policy violations were last detected on the entity."
+},
+"name": {
+"description": "Required. Resource name of the entity with policy issues. Format: accounts/{account}/policyIssues/{policy_issue}",
+"type": "string"
+},
+"policyTopics": {
+"description": "Required. Unordered list. The policy topics that this entity was found to violate over the past seven days.",
+"items": {
+"$ref": "PolicyTopic"
+},
+"type": "array"
+},
+"site": {
+"description": "Required. Hostname/domain of the entity (for example \"foo.com\" or \"www.foo.com\"). This _should_ be a bare domain/host name without any protocol. This will be present for all policy issues.",
+"type": "string"
+},
+"siteSection": {
+"description": "Optional. Prefix of the site-section having policy issues (For example \"foo.com/bar-section\"). This will be present if the `entity_type` is `SITE_SECTION` and will be absent for other entity types.",
+"type": "string"
+},
+"uri": {
+"description": "Optional. URI of the page having policy violations (for example \"foo.com/bar\" or \"www.foo.com/bar\"). This will be present if the `entity_type` is `PAGE` and will be absent for other entity types.",
+"type": "string"
+},
+"warningEscalationDate": {
+"$ref": "Date",
+"description": "Optional. The date (in the America/Los_Angeles timezone) when the entity will have ad serving demand restricted or ad serving disabled. This is present only for issues with a `WARNED` enforcement action. See https://support.google.com/adsense/answer/11066888."
+}
+},
+"type": "object"
+},
+"PolicyTopic": {
+"description": "Information about a particular policy topic. A policy topic represents a single class of policy issue that can impact ad serving for your site. For example, sexual content or having ads that obscure your content. A single policy issue can have multiple policy topics for a single entity.",
+"id": "PolicyTopic",
+"properties": {
+"mustFix": {
+"description": "Required. Indicates if this is a policy violation or not. When the value is true, issues that are instances of this topic must be addressed to remain in compliance with the partner's agreements with Google. A false value indicates that it's not mandatory to fix the issues but advertising demand might be restricted.",
+"type": "boolean"
+},
+"topic": {
+"description": "Required. The policy topic. For example, \"sexual-content\" or \"ads-obscuring-content\".\"",
+"type": "string"
+}
+},
+"type": "object"
+},
 "ReportResult": {
 "description": "Result of a generated report.",
 "id": "ReportResult",

googleapiclient/discovery_cache/documents/advisorynotifications.v1.json

@@ -357,7 +357,7 @@
 }
 }
 },
-"revision": "20240303",
+"revision": "20240317",
 "rootUrl": "https://advisorynotifications.googleapis.com/",
 "schemas": {
 "GoogleCloudAdvisorynotificationsV1Attachment": {