Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minor readme edits for tidiness #1

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 17 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Zombies on Steroïds
# Zombies on Steroids
Zombies on Steroids is a solution that aims to pull out the least viewed
products on Google Shopping in order to drive them in a separate Google Ads
campaign.
Expand All @@ -11,17 +11,17 @@ This solution is perfect for retailers with millions of products in shopping,
as it will help to identify and reactivate products that are not getting the
attention they deserve.

## Prerequisite
- A Google Cloud Platform user with Owner role).
## Prerequisites
- A Google Cloud Platform user with the Owner role.
- Terraform version >=1.3.7
- Python version >=3.8.1
- A Big Query Data Transfer of Google Merchant Center and Google Ads (you can
use [Markup](https://github.com/google/shopping-markup) to set this up)
- The pairs of Merchants IDs and Google Ads IDs you want this project to run
on.
```sql
# To get the pairs, you can run the following query :

#### To get the pairs, you can run the following query:
```sql
SELECT
DISTINCT(MerchantId) AS merchant_id_table_suffix,
_TABLE_SUFFIX AS gads_id_table_suffix
Expand All @@ -31,34 +31,28 @@ GROUP BY 1,_TABLE_SUFFIX
```
## How to deploy
- Clone this repository onto your local machine
by running ```git clone http://github.com/google/zombies-on-steroids.```
- Navigate to the project folder ```cd zombies_on_steroids/```
by running ```git clone https://github.com/google/zombies-on-steroids```
- Navigate to the project folder by running ```cd zombies_on_steroids/```
- Make sure you edit the ```variables.tf``` file with all the relevant values.
- Run ```terraform init``` to initialize the working directory.
- Then run ```terraform plan``` to view the execution plan that Terraform will
- Then, run ```terraform plan``` to view the execution plan that Terraform will
execute.
- Finally, run ```terraform apply``` to execute the action from the plan
- Finally, run ```terraform apply``` to execute the action from the plan.

## Generated Artefacts
### BigQuery Scheduled Query:

- One BigQuery scheduled query will be created for each pair with the following
naming convention: Zombie_<MC_ACCOUNT_ID>_<GADS_ACCOUNT_ID>
- The schedule is set by the config variable “zombies_schedule”
- Pubsusb topic specified by the variable “zombies_pubsub_topic” to notify
scheduled query completion
- One BigQuery scheduled query will be created for each pair with the following naming convention: `Zombie_<MC_ACCOUNT_ID>_<GADS_ACCOUNT_ID>`
- The schedule is set by the config variable `zombies_schedule`
- The PubSub topic is specified by the variable `zombies_pubsub_topic` to notify scheduled query completion

If the config ```variable generate_feed_files``` is set to ```true```, the
following artefacts will be generated:
If the config ```variable generate_feed_files``` is set to ```true```, the following artefacts will be generated:

- __Cloud Function:__ ```zombies_feed_generation_trigger```. Triggered by a
PubSub message on the topic ```zombies_pubsub_topic```. The message is sent
upon scheduled query completion.
- __Dataflow:__ a job with the following naming convention will be executed
- __Cloud Function:__ ```zombies_feed_generation_trigger```. Triggered by a PubSub message on the topic ```zombies_pubsub_topic```. The message is sent upon scheduled query completion.
- __Dataflow:__ a job with the following naming convention will be executed:
```zb-<MC_ACCOUNT_ID>-<GADS_ACCOUNT_ID>```
- __CSV files:__ will be stored in the corresponding GCS location indicated by
- the ```accounts_table``` variable and with the following naming convention
- __CSV files:__ will be stored in the corresponding GCS location indicated by the ```accounts_table``` variable and with the following naming convention
```zombies_feed_<MC_ACCOUNT_ID>-<GADS_ACCOUNT_ID>.csv```

## Author
- Jaime Martinez (jaimemm@)
- Jaime Martinez (jaimemm@)