Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/getyourguide/sem-emergency-stop

Quickly stop all Google Ads advertising
https://github.com/getyourguide/sem-emergency-stop

google-ads google-ads-api incident-management incident-response search-engine-marketing sem team-ps uses-google-ads-library

Last synced: 1 day ago
JSON representation

Quickly stop all Google Ads advertising

Host: GitHub
URL: https://github.com/getyourguide/sem-emergency-stop
Owner: getyourguide
License: apache-2.0
Created: 2020-09-07T15:14:35.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-07-09T08:06:20.000Z (4 months ago)
Last Synced: 2024-10-11T14:20:06.670Z (about 1 month ago)
Topics: google-ads, google-ads-api, incident-management, incident-response, search-engine-marketing, sem, team-ps, uses-google-ads-library
Language: Python
Homepage: https://pypi.org/project/sem-emergency-stop/
Size: 338 KB
Stars: 2
Watchers: 58
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

# sem-emergency-stop

![Logo](doc/sem-emergency-stop.svg)

Stop all Google Ads marketing. This utility will pause all marketing campaigns on Google Ads (presumably across many accounts) as fast as possible. The main use case is emergency response during incidents where all landing pages are temporarily unavailable, thereby incurring cost without revenue. Unpausing the paused campaigns (and only those) is also supported.

## Usage

In case of emergency, do this:

```shell
sem-emergency-stop pause --no-dry-run
```

A hash will be printed at the end of the process. Use this hash to unpause when the incident is over (the exact instructions are displayed when you run.)

## One-time setup (for end users)

Install the tool (requires Python 3.7 or higher; on Ubuntu 18.04 install `python3.7-minimal`):

```shell
pip3 install --user sem-emergency-stop
```

You can then run `sem-emergency-stop setup` to authenticate the tool against the API using your Google account. This will request two pieces of information from you:

1. An organization token. How you get this token depends on your organization's process. See the next section if you are the person to set this up for your organization.
2. A token specific to your Google account. Follow instructions on screen. Note that you need to have access to your Ads accounts with your Google account.

## Deployment at organizations

Authentication uses Google's OAuth2 flow. This app does _not_ come with client secrets, so you will have to generate these and distribute them in your organization through a suitable channel (e.g. using password manager). The client id/secret together with your login customer id and your developer token are packaged in a compact _organization token_ for distribution purposes.

After installing the app, you can generate a token by running `ses-create-org-token`. It will ask the following information:

* Login customer id - this is the customer id (without dashes) of your root Google Ads account.
* Developer token - find it in your root account under "API Center".
* Client id/secret - follow [this guide](https://developers.google.com/google-ads/api/docs/oauth/cloud-project) how to obtain a pair.

## Development and contributing

For development [pipenv](https://pipenv.kennethreitz.org/en/latest/) is required on your system. Set up the development environment with `make develop`, run with `pipenv run sem-emergency-stop ...` as needed.

We welcome pull requests; if you are planning to perform bigger changes then it makes sense to file an issue first. Make sure `make lint` comes back clean.

## Security

For sensitive security matters please contact [[email protected]](mailto:[email protected]).

## Legal

sem-emergency-stop is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full text.