Filter out bad enums and add annotations to OCI example

Change-Id: I0f8a25f8bc62b3f9b9cc20a2683ab231f777cbbb

Author: BenRKarl

examples/remarketing/add_customer_match_user_list.py

@@ -671,7 +671,11 @@ def normalize_and_hash(s: str, remove_all_whitespace: bool) -> str:
         "-d",
         "--ad_user_data_consent",
         type=str,
-        choices=[e.name for e in googleads_client.enums.ConsentStatusEnum],
+        choices=[
+            e.name
+            for e in googleads_client.enums.ConsentStatusEnum
+            if e.name not in ("UNSPECIFIED", "UNKNOWN")
+        ],
         help=(
             "The data consent status for ad user data for all members in "
             "the job."
@@ -681,7 +685,11 @@ def normalize_and_hash(s: str, remove_all_whitespace: bool) -> str:
         "-p",
         "--ad_personalization_consent",
         type=str,
-        choices=[e.name for e in googleads_client.enums.ConsentStatusEnum],
+        choices=[
+            e.name
+            for e in googleads_client.enums.ConsentStatusEnum
+            if e.name not in ("UNSPECIFIED", "UNKNOWN")
+        ],
         help=(
             "The personalization consent status for ad user data for all "
             "members in the job."

examples/remarketing/upload_call_conversion.py

@@ -222,7 +222,11 @@ def main(
         "-d",
         "--ad_user_data_consent",
         type=str,
-        choices=[e.name for e in googleads_client.enums.ConsentStatusEnum],
+        choices=[
+            e.name
+            for e in googleads_client.enums.ConsentStatusEnum
+            if e.name not in ("UNSPECIFIED", "UNKNOWN")
+        ],
         help=(
             "The data consent status for ad user data for all members in "
             "the job."

examples/remarketing/upload_conversion_adjustment.py

@@ -173,6 +173,12 @@ def main(
 
 
 if __name__ == "__main__":
+    # GoogleAdsClient will read the google-ads.yaml configuration file in the
+    # home directory if none is specified.
+    googleads_client: GoogleAdsClient = GoogleAdsClient.load_from_storage(
+        version="v20"
+    )
+
     parser: argparse.ArgumentParser = argparse.ArgumentParser(
         description="Uploads a conversion adjustment."
     )
@@ -198,9 +204,8 @@ def main(
         required=True,
         choices=[
             e.name
-            for e in GoogleAdsClient.load_from_storage(
-                version="v20"
-            ).enums.ConversionAdjustmentTypeEnum
+            for e in googleads_client.enums.ConversionAdjustmentTypeEnum
+            if e.name not in ("UNSPECIFIED", "UNKNOWN")
         ],
         help="The adjustment type, e.g. " "RETRACTION, RESTATEMENT",
     )
@@ -236,12 +241,6 @@ def main(
     )
     args: argparse.Namespace = parser.parse_args()
 
-    # GoogleAdsClient will read the google-ads.yaml configuration file in the
-    # home directory if none is specified.
-    googleads_client: GoogleAdsClient = GoogleAdsClient.load_from_storage(
-        version="v20"
-    )
-
     try:
         main(
             googleads_client,

examples/remarketing/upload_enhanced_conversions_for_leads.py

@@ -340,7 +340,11 @@ def normalize_and_hash(s: str) -> str:
         "-n",
         "--ad_user_data_consent",
         type=str,
-        choices=[e.name for e in googleads_client.enums.ConsentStatusEnum],
+        choices=[
+            e.name
+            for e in googleads_client.enums.ConsentStatusEnum
+            if e.name not in ("UNSPECIFIED", "UNKNOWN")
+        ],
         help=(
             "The data consent status for ad user data for all members in "
             "the job."

examples/remarketing/upload_offline_conversion.py

@@ -22,26 +22,40 @@
 
 import argparse
 import sys
+from typing import Optional
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
+from google.ads.googleads.v20.services.services.conversion_action_service import (
+    ConversionActionServiceClient,
+)
+from google.ads.googleads.v20.services.services.conversion_upload_service import (
+    ConversionUploadServiceClient,
+)
+from google.ads.googleads.v20.services.types.conversion_upload_service import (
+    ClickConversion,
+    ClickConversionResult,
+    CustomVariable,
+    UploadClickConversionsRequest,
+    UploadClickConversionsResponse,
+)
 
 
 # [START upload_offline_conversion]
 def main(
-    client,
-    customer_id,
-    conversion_action_id,
-    gclid,
-    conversion_date_time,
-    conversion_value,
-    conversion_custom_variable_id,
-    conversion_custom_variable_value,
-    gbraid,
-    wbraid,
-    order_id,
-    ad_user_data_consent,
-):
+    client: GoogleAdsClient,
+    customer_id: str,
+    conversion_action_id: str,
+    gclid: Optional[str],
+    conversion_date_time: str,
+    conversion_value: str,
+    conversion_custom_variable_id: Optional[str],
+    conversion_custom_variable_value: Optional[str],
+    gbraid: Optional[str],
+    wbraid: Optional[str],
+    order_id: Optional[str],
+    ad_user_data_consent: Optional[str],
+) -> None:
     """Creates a click conversion with a default currency of USD.
 
     Args:
@@ -65,9 +79,13 @@ def main(
         order_id: The order ID for the click conversion.
         ad_user_data_consent: The ad user data consent for the click.
     """
-    click_conversion = client.get_type("ClickConversion")
-    conversion_upload_service = client.get_service("ConversionUploadService")
-    conversion_action_service = client.get_service("ConversionActionService")
+    click_conversion: ClickConversion = client.get_type("ClickConversion")
+    conversion_upload_service: ConversionUploadServiceClient = (
+        client.get_service("ConversionUploadService")
+    )
+    conversion_action_service: ConversionActionServiceClient = (
+        client.get_service("ConversionActionService")
+    )
     click_conversion.conversion_action = (
         conversion_action_service.conversion_action_path(
             customer_id, conversion_action_id
@@ -87,7 +105,9 @@ def main(
     click_conversion.currency_code = "USD"
 
     if conversion_custom_variable_id and conversion_custom_variable_value:
-        conversion_custom_variable = client.get_type("CustomVariable")
+        conversion_custom_variable: CustomVariable = client.get_type(
+            "CustomVariable"
+        )
         conversion_custom_variable.conversion_custom_variable = (
             conversion_upload_service.conversion_custom_variable_path(
                 customer_id, conversion_custom_variable_id
@@ -114,16 +134,20 @@ def main(
     # multiple conversions to upload, it's most efficient to upload them in a
     # single request. See the following for per-request limits for reference:
     # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service
-    request = client.get_type("UploadClickConversionsRequest")
+    request: UploadClickConversionsRequest = client.get_type(
+        "UploadClickConversionsRequest"
+    )
     request.customer_id = customer_id
     request.conversions.append(click_conversion)
     request.partial_failure = True
-    conversion_upload_response = (
+    conversion_upload_response: UploadClickConversionsResponse = (
         conversion_upload_service.upload_click_conversions(
             request=request,
         )
     )
-    uploaded_click_conversion = conversion_upload_response.results[0]
+    uploaded_click_conversion: ClickConversionResult = (
+        conversion_upload_response.results[0]
+    )
     print(
         f"Uploaded conversion that occurred at "
         f'"{uploaded_click_conversion.conversion_date_time}" from '
@@ -136,9 +160,11 @@ def main(
 if __name__ == "__main__":
     # GoogleAdsClient will read the google-ads.yaml configuration file in the
     # home directory if none is specified.
-    googleads_client = GoogleAdsClient.load_from_storage(version="v20")
+    googleads_client: GoogleAdsClient = GoogleAdsClient.load_from_storage(
+        version="v20"
+    )
 
-    parser = argparse.ArgumentParser(
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(
         description="Uploads an offline conversion."
     )
     # The following argument(s) should be provided to run the example.
@@ -224,10 +250,14 @@ def main(
         "-s",
         "--ad_user_data_consent",
         type=str,
-        choices=[e.name for e in GoogleAdsClient.load_from_storage(version="v20").enums.ConsentStatusEnum],
+        choices=[
+            e.name
+            for e in googleads_client.enums.ConsentStatusEnum
+            if e.name not in ("UNSPECIFIED", "UNKNOWN")
+        ],
         help=("The ad user data consent for the click."),
     )
-    args = parser.parse_args()
+    args: argparse.Namespace = parser.parse_args()
 
     try:
         main(

examples/remarketing/upload_store_sales_transactions.py

@@ -812,7 +812,11 @@ def check_job_status(
     parser.add_argument(
         "--ad_user_data_consent",
         type=str,
-        choices=[e.name for e in googleads_client.enums.ConsentStatusEnum],
+        choices=[
+            e.name
+            for e in googleads_client.enums.ConsentStatusEnum
+            if e.name not in ("UNSPECIFIED", "UNKNOWN")
+        ],
         help=(
             "The data consent status for ad user data for all members in "
             "the job."
@@ -821,7 +825,11 @@ def check_job_status(
     parser.add_argument(
         "--ad_personalization_consent",
         type=str,
-        choices=[e.name for e in googleads_client.enums.ConsentStatusEnum],
+        choices=[
+            e.name
+            for e in googleads_client.enums.ConsentStatusEnum
+            if e.name not in ("UNSPECIFIED", "UNKNOWN")
+        ],
         help=(
             "The personalization consent status for ad user data for all "
             "members in the job."