Include the Google parameter ID in the UI for parameter that could be…

… confusing otherwise (#95)
zytedata · Dec 11, 2024 · 1a2c9fc · 1a2c9fc
1 parent 870e7ef
commit 1a2c9fc
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/tests/test_serp.py b/tests/test_serp.py
@@ -361,7 +361,7 @@ def test_metadata():
                         }
                         for code in sorted(GoogleGl)
                     },
-                    "title": "User Country",
+                    "title": "User Country (gl)",
                     "enum": list(
                         sorted(GOOGLE_GL_OPTIONS, key=GOOGLE_GL_OPTIONS.__getitem__)
                     ),
@@ -377,7 +377,7 @@ def test_metadata():
                         "particular countries. See "
                         "https://developers.google.com/custom-search/v1/reference/rest/v1/cse/list#body.QUERY_PARAMETERS.cr"
                     ),
-                    "title": "Content Countries",
+                    "title": "Content Countries (cr)",
                 },
                 "geolocation": {
                     "anyOf": [
@@ -414,7 +414,7 @@ def test_metadata():
                         }
                         for code in sorted(GoogleHl)
                     },
-                    "title": "User Language",
+                    "title": "User Language (hl)",
                     "enum": list(
                         sorted(GOOGLE_HL_OPTIONS, key=GOOGLE_HL_OPTIONS.__getitem__)
                     ),
@@ -430,7 +430,7 @@ def test_metadata():
                         "specified languages. See "
                         "https://developers.google.com/custom-search/v1/reference/rest/v1/cse/list#body.QUERY_PARAMETERS.lr"
                     ),
-                    "title": "Content Languages",
+                    "title": "Content Languages (lr)",
                 },
             },
             "required": ["search_queries"],

diff --git a/zyte_spider_templates/spiders/serp.py b/zyte_spider_templates/spiders/serp.py
@@ -27,7 +27,7 @@
 
 class GoogleCrParam(BaseModel):
     cr: Optional[str] = Field(
-        title="Content Countries",
+        title="Content Countries (cr)",
         description=(
             "Restricts search results to documents originating in "
             "particular countries. See "
@@ -39,7 +39,7 @@ class GoogleCrParam(BaseModel):
 
 class GoogleGlParam(BaseModel):
     gl: Optional[GoogleGl] = Field(
-        title="User Country",
+        title="User Country (gl)",
         description=(
             "Boosts results relevant to this country. See "
             "https://developers.google.com/custom-search/v1/reference/rest/v1/cse/list#body.QUERY_PARAMETERS.gl"
@@ -58,7 +58,7 @@ class GoogleGlParam(BaseModel):
 
 class GoogleHlParam(BaseModel):
     hl: Optional[GoogleHl] = Field(
-        title="User Language",
+        title="User Language (hl)",
         description=(
             "User interface language, which can affect search results. See "
             "https://developers.google.com/custom-search/v1/reference/rest/v1/cse/list#body.QUERY_PARAMETERS.hl"
@@ -77,7 +77,7 @@ class GoogleHlParam(BaseModel):
 
 class GoogleLrParam(BaseModel):
     lr: Optional[str] = Field(
-        title="Content Languages",
+        title="Content Languages (lr)",
         description=(
             "Restricts search results to documents written in the specified "
             "languages. See "