No project description provided
Project description
gaarf exporter
Prometheus exporter for Google Ads metrics with customizable metrics collectors.
Installation and usage
Locally
- Install
gaarf-exporter
from pip:
pip install gaarf-exporter
- Run
gaarf-exporter
:
gaarf-exporter
Docker
docker run --network=host \
-v /path/to/google-ads.yaml:/root/google-ads.yaml \
-v `pwd`/gaarf_exporter.yaml:/app/gaarf_exporter.yaml \
gaarf_exporter
docker run --network=host gaarf_exporter \
--config gs://path/to/gaarf_config.yaml \
--ads-config gs://path/to/google-ads.yaml
--network=host
By default it will start http_server on localhost:8000
and will push some basic metrics to it.
Customization
--ads-config
- path togoogle-ads.yaml
--config
- path togaarf_exporter.yaml
--http_server.address
- address of your http server (localhost
by default)--http_server.port
- port of your http server (8000
by default)--pushgateway.address
- address of your pushgateway service (None
by default)--pushgateway.port
- port of your pushgateway (None
by default)--delay-minutes
- delay in minutes between scrapings (15
by default)
Collectors
You can specify collectors with --collectors <collector_name>
CLI argument. Some collectors available by default, other you need to specify explicitly.
Default collectors
performance
- extractclicks
,impressions
,cost
,conversions
on byad_network
andad_group_id
disapprovals
- extractapproval_status
,review_status
,topic
,topic_type
byad_group_id
andad_id
only for not approved adsconversion_action
- extractall_conversions
byconversion_id
andaccount_id
mapping
- performance mapping betweenad_group_id
,ad_group_name
,campaign_id
,campaign_name,
campaign_status
,account_id
,account_name
Available collectors
search_terms
- extractclicks
,impressions
,cost
,conversions
on bysearch_term
andad_group_id
search_terms_conversion_split
- extractall_conversions
bysearch_term
andconversion_id
onad_group_id
levelplacements
- extractclicks
,impressions
,cost
,conversions
on byplacement_name
andplacement_type
bid_budgets
- extract current values of bid (target_cpa, target_roas) and budget
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gaarf-exporter-0.5.0.tar.gz
(20.0 kB
view hashes)