Merge pull request #11 from google-marketing-solutions/dev

Add Glossary Functionality and UI updates

Author: maximilianw-google

README.md

@@ -110,7 +110,8 @@ directly. Instead, running the workers creates prefilled [Google Ads Editor
 Templates](https://support.google.com/google-ads/answer/10702525?hl=en) for Ads,
 Keywords, Ad Groups and Campaign for download as CSV files.
 
-> NOTE: After running a worker the produced download URLs have an expiration of
+> [!NOTE]
+> After running a worker the produced download URLs have an expiration of
 > 1 hour for security purposes as those links are universally accessible. If you
 > need to retrieve the generated CSVs after the link expiration you can still
 > download them but you have to do so directly from the Cloud Storage Bucket you
@@ -159,6 +160,66 @@ Costs depend on the size of the translation requests, see
 [Cloud Translation Pricing](https://cloud.google.com/translate/pricing) for
 details.
 
+## FAQs & Troubleshooting
+
+1.  **How do I stop certain terms (e.g., brand terms) from being translated?**
+
+    This can be avoided by using Glossaries, which are supported by Keyword
+    Platform. During installation a dedicated bucket for glossary files is
+    generated to which you can upload [unidirectional glossary files](https://cloud.google.com/translate/docs/advanced/glossary#unidirectional_glossaries). They will
+    automatically be picked up by a pub/sub subscription and processed, which
+    creates a glossary entry in your Google Cloud project. When running
+    translations you can select the glossary you want to apply from an optional
+    dropdown.
+
+1.  **How can I add terms to a glossary via the UI?**
+
+    This functionality is currently not available, but glossary entries are
+    overwritten by default. To update a previously generated glossary, simply
+    upload a new file with the same name containing previous and newly added
+    terms.
+
+1.  **Why are there no accounts in the account dropdown?**
+
+    This is likely due to credentials not being valid. To get more details, you
+    can check the logs by going to `Logs Explorer` in the Google Cloud Console.
+    To generate new credentials you can either run the installation again
+    (`./setup/install.sh`) or manually create new credentials using the [oauth
+    playground](https://developers.google.com/oauthplayground/). To do that, you
+    need to:
+    *   Add `https://developers.google.com/oauthplayground`` to the `Authorized
+        redirect URIs` in your OAuth2.0 client in the Google Cloud Console under
+        `APIs & Services > Credentials`.
+    *   On the [oauth playground page](https://developers.google.com/oauthplayground/)
+        add the client id and secret under `Settings > Use your own OAuth
+        credentials`.
+    *   Select all the [required scopes](https://github.com/google-marketing-solutions/keyword_platform/blob/main/setup/utils/oauth_flow.py#L41).
+    *   Hit `Authorize APIs` and exchange the access token for a refresh token.
+    *   In Google Cloud Console head to `Secret Manager` and update the secrets
+        accordingly.
+
+1.  **Why am I getting a `Http failure …/proxy: 500 OK` response after hitting
+    the RUN button?**
+
+    There can be various reasons for this and the logs will give you more
+    details as to what happened. Head to your Cloud Console `Logs Explorer`
+    and investigate any errors.
+
+1.  **When logging into my Google Account during installation I get "Access
+    blocked: This app's request is invalid".**
+
+    Make sure to have added http://localhost:8080 to the `Authorized redirect
+    URIs`` in your OAuth2.0 client in the Google Cloud Console under `APIs &
+    Services > Credentials`.
+
+1.  **During installation terraform command fails with `error creating Brand:
+    googleapi: Error 409: Requested entity already exists`.**
+
+    We use terraform for installation and setting up the Google Cloud resources.
+    Terraform only supports internal OAuth Consent Screens. Before installing
+    Keyword Platform, ensure that your OAuth Consent Screen is set to `internal`.
+
+
 ## Privacy Notice
 
 > [!NOTE]

py/common/api_utils.py

@@ -76,9 +76,10 @@ def validate_credentials(
 
 def send_api_request(
     url: str,
-    params: dict[str, Any],
+    params: dict[str, Any] | None,
     http_header: dict[str, str],
-    method: str = 'POST') -> Any:
+    method: str = 'POST',
+) -> Any:
   """Call the requested API endpoint with the given parameters.
 
   Args:

py/common/cloud_translation_client.py

@@ -73,6 +73,7 @@ class Glossary:
 
   id: str = dataclasses.field(default_factory=str)
   name: str = dataclasses.field(default_factory=str)
+  display_name: str = dataclasses.field(default_factory=str)
 
 
 class GlossaryError(Exception):
@@ -376,16 +377,17 @@ def list_glossaries(self) -> list[Glossary]:
         gcp_region=self._gcp_region,
     )
     try:
-      response = api_utils.send_api_request(url, {}, self._get_http_header())
+      response = api_utils.send_api_request(
+          url, None, self._get_http_header(), method='GET'
+      )
     except requests.exceptions.HTTPError as http_error:
       logging.exception(
           'Encountered error during calls to Translation API: %s', http_error
       )
       raise
     for glossary in response['glossaries']:
-      glossaries.append(
-          Glossary(id=glossary['name'].split('/')[-1], name=glossary['name'])
-      )
+      id = glossary['name'].split('/')[-1]
+      glossaries.append(Glossary(id=id, name=glossary['name'], display_name=id))
     return glossaries
 
   def get_glossary_info_from_cloud_event_data(
@@ -455,7 +457,6 @@ def create_or_replace_glossary(
 
     try:
       self._delete_glossary(glossary_id)
-      logging.info('Deleted glossary with id %s', glossary_id)
     except google.api_core.exceptions.NotFound:
       logging.info('Creating glossary with id %s', glossary_id)
 
@@ -525,6 +526,7 @@ def _create_glossary(
       finished_operation = api_utils.send_api_request(
           url, params, self._get_http_header()
       )
+      logging.info('Finished glossary operation: %s.', finished_operation)
     except requests.exceptions.HTTPError as http_error:
       logging.exception(
           'Encountered error during calls to Translation API: %s', http_error
@@ -551,7 +553,8 @@ def _delete_glossary(self, glossary_id: str) -> None:
     )
 
     try:
-      api_utils.send_api_request(url, {}, self._get_http_header(), 'DELETE')
+      api_utils.send_api_request(url, None, self._get_http_header(), 'DELETE')
+      logging.info('Deleted glossary with id %s', glossary_id)
     except requests.exceptions.HTTPError as http_error:
       if http_error.response.status_code == 404:
         logging.info('Glossary with id %s not found.', glossary_id)

py/common/cloud_translation_client_test.py

@@ -488,10 +488,12 @@ def test_shorten_text_to_char_limit_not_called_unsupported_language(
               cloud_translation_client_lib.Glossary(
                   id='fake-glossary-1',
                   name='projects/fake-project-id/locations/fake-region/glossaries/fake-glossary-1',
+                  display_name='fake-glossary-1',
               ),
               cloud_translation_client_lib.Glossary(
                   id='fake-glossary-2',
                   name='projects/fake-project-id/locations/fake-region/glossaries/fake-glossary-2',
+                  display_name='fake-glossary-2',
               ),
           ],
       },
@@ -608,13 +610,15 @@ def test_create_or_replace_glossary(self):
         # First call will be to try and delete the glossary if it exists.
         mock.call(
             expected_delete_url,
-            {},  # Parameters are empty for a delete request.
+            None,  # Parameters are empty for a delete request.
             expected_header,
             'DELETE',
         ),
         mock.call(expected_create_url, expected_create_params, expected_header),
         mock.call(
-            expected_operation_url, expected_operation_params, expected_header
+            expected_operation_url,
+            expected_operation_params,
+            expected_header,
         ),
     ])
 

ui/package-lock.json

@@ -0,0 +1,32 @@
+<!--
+ Copyright 2023 Google LLC.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<div class="position">
+  <div *ngIf="showSpinner" class="spinner">
+    <mat-spinner></mat-spinner>
+  </div>
+  <form [formGroup]="form">
+    <app-multi-select
+        #control
+        [controllerName]="'accounts'"
+        [className]="'responsive'"
+        [values]="accounts"
+        [label]="'Select accounts'"
+        [isRequired]=true
+        (selectionEvent)="accountSelection($event)">
+    </app-multi-select>
+  </form>
+</div>