From 5f128bb3561ec3d704d9c29e519a59103e1daeb2 Mon Sep 17 00:00:00 2001 From: Alex Kort Date: Wed, 7 Dec 2022 16:30:34 +0900 Subject: [PATCH] Added LICENSE file and license to deploy script, reformatted README.md Change-Id: I52dcfa0150adb03cdca9f15478414bb95ca1c760 --- LICENSE | 202 ++++++++++++++++++++++++++++++++ README.md | 97 ++++++++++----- cicd/deploy_saka_cf_to_gcp.yaml | 14 +++ 3 files changed, 282 insertions(+), 31 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7a4a3ea --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. \ No newline at end of file diff --git a/README.md b/README.md index 6ceb47a..aba9e71 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # SAKA (SA360 Keyword Automator) -*Copyright 2019 Google LLC. This solution, including any related sample code or +*Copyright 2022 Google LLC. This solution, including any related sample code or data, is made available on an “as is,” “as available,” and “with all faults” basis, solely for illustrative purposes, and without warranty or representation of any kind. This solution is experimental, unsupported and provided solely for @@ -16,22 +16,35 @@ usage in connection with your business, if at all.* ## Overview -SAKA is a Google Cloud-based packaged solution that automates uploads of keywords to SA360 based on Google Ads search terms report results. Search terms that have been identified to have some level of impact by this solution and that do not yet exist as keywords in the campaign ad group will be added by SAKA with the goal of increasing keyword coverage and ad performance. +SAKA is a Google Cloud-based packaged solution that automates uploads of +keywords to SA360 based on Google Ads search terms report results. Search terms +that have been identified to have some level of impact by this solution and that +do not yet exist as keywords in the campaign ad group will be added by SAKA with +the goal of increasing keyword coverage and ad performance. ## Prerequisites In order to use this solution, you must have the following: -- [ ] A Google Ads Account. -- [ ] A Google Ads API developer token. -- [ ] A Search Ads 360 Account ("SA360"), with FTP server access. See [here](https://support.google.com/searchads/answer/7409125?hl=en) for details. -- [ ] A [Google Cloud Platform ("GCP") project](https://cloud.google.com/resource-manager/docs/creating-managing-projects) with an attached billing account. (If a billing account has not been set on the project, set one by [following these instructions](https://cloud.google.com/billing/docs/how-to/modify-project)) +- [ ] A Google Ads Account. +- [ ] A Google Ads API developer token. +- [ ] A Search Ads 360 Account ("SA360"), with FTP server access. See + [here](https://support.google.com/searchads/answer/7409125?hl=en) for + details. +- [ ] A + [Google Cloud Platform ("GCP") project](https://cloud.google.com/resource-manager/docs/creating-managing-projects) + with an attached billing account. (If a billing account has not been set on + the project, set one by + [following these instructions](https://cloud.google.com/billing/docs/how-to/modify-project)) ***For users not using GCP Cloud Shell, the steps below are also required:*** -- [ ] Have [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed locally on your machine. -- [ ] [Install the Google Cloud SDK](https://cloud.google.com/sdk/) to be able to - run the installation script. Ensure both alpha and beta are installed, and update components to the latest versions: +- [ ] Have + [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) + installed locally on your machine. +- [ ] [Install the Google Cloud SDK](https://cloud.google.com/sdk/) to be able + to run the installation script. Ensure both alpha and beta are installed, + and update components to the latest versions: - `gcloud components install alpha` @@ -61,16 +74,21 @@ This section will explain how to setup SAKA for use in a GCP environment. ### 1. Download / Clone the Repository -In GCP Cloud Shell or your local terminal, either clone this repository using git, or download the code as a tarball by clicking the "tgz" link in the main branch and extract it. +In GCP Cloud Shell or your local terminal, either clone this repository using +git, or download the code as a tarball by clicking the "tgz" link in the main +branch and extract it. ### 2. Generate Google Ads API Credentials The next step ("Configuration") will require several Google Ads API credentials. These can be generated by clicking on the "Instructions" links below. -* Developer Token: [Instructions](https://developers.google.com/google-ads/api/docs/first-call/dev-token) -* Client ID / Secret: [Instructions](https://developers.google.com/google-ads/api/docs/first-call/oauth-cloud-project) -* Refresh Token: [Download Python script](https://github.com/googleads/googleads-python-lib/blob/master/examples/adwords/authentication/generate_refresh_token.py) +* Developer Token: + [Instructions](https://developers.google.com/google-ads/api/docs/first-call/dev-token) +* Client ID / Secret: + [Instructions](https://developers.google.com/google-ads/api/docs/first-call/oauth-cloud-project) +* Refresh Token: + [Download Python script](https://github.com/googleads/googleads-python-lib/blob/master/examples/adwords/authentication/generate_refresh_token.py) To get the refresh token, after downloading the Python script linked above, run it as follows: @@ -79,25 +97,33 @@ it as follows: python generate_refresh_token.py --client_id INSERT_CLIENT_ID --client_secret INSERT_CLIENT_SECRET ``` -When prompted to login to a Google account, select the account that has permission to modify your Google Ads data. +When prompted to login to a Google account, select the account that has +permission to modify your Google Ads data. ### 3. Configuration -- In GCP Cloud Shell or your local terminal, navigate to the root directory of the SAKA repository and edit the environment_variables.sh file. Supply values for the variables, noting the ones that are optional. Explanations of each environment variable are shown next to the respective variable. +- In GCP Cloud Shell or your local terminal, navigate to the root directory of + the SAKA repository and edit the environment_variables.sh file. Supply + values for the variables, noting the ones that are optional. Explanations of + each environment variable are shown next to the respective variable. ### 4. Installation -- In GCP Cloud Shell or your local terminal, run the install script in the repository's root directory using the following command: - `bash install_to_gcp.sh`. +- In GCP Cloud Shell or your local terminal, run the install script in the + repository's root directory using the following command: `bash + install_to_gcp.sh`. - If you see any errors that a resource already exists, it is likely due to the script having been run more than once. In this case these errors can be safely ignored. - After the script completes, in order to deploy the SAKA solution to your GCP project, it is required to perform a git push to the Cloud Source Repository that was created by the install_to_gcp.sh script in the previous step. - (reference: [Cloud Source Repositories](https://cloud.google.com/source-repositories/docs/pushing-code-from-a-repository)). -- Set up authentication to the Cloud Source Repository by following the instructions on [this page]( https://cloud.google.com/source-repositories/docs/authentication). -- Run the following git commands in the same local repository you cloned and + (reference: + [Cloud Source Repositories](https://cloud.google.com/source-repositories/docs/pushing-code-from-a-repository)). +- Set up authentication to the Cloud Source Repository by following the + instructions on + [this page](https://cloud.google.com/source-repositories/docs/authentication). +- Run the following git commands in the same local repository you cloned and ran the initialization script in: 1. `git remote add gcp @@ -110,23 +136,30 @@ When prompted to login to a Google account, select the account that has permissi choose option 1) - Cloud Build will auto-trigger on the git push and deploy the code to GCP. It - should take around 5 minutes. [You can check the status in your GCP Console's Cloud Build dashboard or history tab](https://cloud.google.com/cloud-build/docs/view-build-results#viewing_build_results). + should take around 5 minutes. [You can check the status in your GCP + Console's Cloud Build dashboard or history + tab](https://cloud.google.com/cloud-build/docs/view-build-results#viewing_build_results). - Ensure that the Cloud Build logs show no errors. ## Confirming Installation To confirm that the components were installed to your GCP environment, navigate -to and check each of the following components in your GCP project from its admin console: +to and check each of the following components in your GCP project from its admin +console: - Cloud Functions - - Check that a Cloud Function called "extract_and_upload_keywords" exists and has a green check mark to the left of it. + - Check that a Cloud Function called "extract_and_upload_keywords" exists + and has a green check mark to the left of it. - Cloud Scheduler - - Check that a Cloud Scheduler job called "triggerSakaFunction" exists and has a green check mark to the left of it. + - Check that a Cloud Scheduler job called "triggerSakaFunction" exists and + has a green check mark to the left of it. - Pub/Sub - - Navigate to Topics and check that there is a topic called "trigger-extract-and-upload-keywords-cloud-function" showing in the UI. + - Navigate to Topics and check that there is a topic called + "trigger-extract-and-upload-keywords-cloud-function" showing in the UI. - Security - - Navigate to Secret Manager and verify that there are two secrets created with the names: "google_ads_api_credentials" and "sa360_sftp_password". + - Navigate to Secret Manager and verify that there are two secrets created + with the names: "google_ads_api_credentials" and "sa360_sftp_password". ## Search Term to Keyword Logic @@ -143,7 +176,8 @@ By default, the logic is as follows: CLICKS_THRESHOLD environment variable) * If the number of tokens in the threshold > tokens threshold (default=3, - update via SEARCH_TERM_TOKENS_THRESHOLD environment variable), add the search term as a BROAD keyword + update via SEARCH_TERM_TOKENS_THRESHOLD environment variable), add the + search term as a BROAD keyword * Otherwise, add the search term as an EXACT and PHRASE keyword. @@ -192,11 +226,12 @@ should be added as a keyword. #### Updating the Environment Variables -The `CLICKS_THRESHOLD`, `CONVERSIONS_THRESHOLD`, and `SEARCH_TERM_TOKENS_THRESHOLD` environment variables can be used to tweak the thresholds used in the current filtering logic. +The `CLICKS_THRESHOLD`, `CONVERSIONS_THRESHOLD`, and +`SEARCH_TERM_TOKENS_THRESHOLD` environment variables can be used to tweak the +thresholds used in the current filtering logic. #### Customizing the Code If you want to create totally different logic, update `_get_match_type()` in -`search_term_transformer.py`. This method is responsible for determining if and how a search term should be added as a keyword. - - +`search_term_transformer.py`. This method is responsible for determining if and +how a search term should be added as a keyword. diff --git a/cicd/deploy_saka_cf_to_gcp.yaml b/cicd/deploy_saka_cf_to_gcp.yaml index 5d4b688..da1d029 100644 --- a/cicd/deploy_saka_cf_to_gcp.yaml +++ b/cicd/deploy_saka_cf_to_gcp.yaml @@ -1,3 +1,17 @@ +# Copyright 2022 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. + steps: # Run unit tests - name: python:3.8-slim