adtap/.env.template at main · jwalsh/adtap · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# Google Ads API Environment Variables
# Copy this file to .env and fill in your values
# Reference: https://developers.google.com/google-ads/api/docs/client-libs/python/configuration

# =============================================================================
# CLIENT LIBRARY CONFIGURATION
# =============================================================================

# Path to the configuration file (optional if using env vars)
# GOOGLE_ADS_CONFIGURATION_FILE_PATH=/path/to/google-ads.yaml

# =============================================================================
# OAUTH2 - APPLICATION MODE (Interactive)
# =============================================================================
# Use this mode for manual exploration and development

# OAuth2 client ID from Google Cloud Console
# GOOGLE_ADS_CLIENT_ID=your-client-id.apps.googleusercontent.com

# OAuth2 client secret from Google Cloud Console
# GOOGLE_ADS_CLIENT_SECRET=your-client-secret

# Pre-generated OAuth2 refresh token (optional - for reusing tokens)
# GOOGLE_ADS_REFRESH_TOKEN=your-refresh-token

# =============================================================================
# OAUTH2 - SERVICE ACCOUNT MODE (Automated)
# =============================================================================
# Use this mode for scheduled tasks, vetting, and automation

# Path to OAuth2 JSON key file (service account credentials)
# GOOGLE_ADS_JSON_KEY_FILE_PATH=/path/to/service-account.json

# Email of the account to impersonate (required for domain-wide delegation)
# GOOGLE_ADS_IMPERSONATED_EMAIL=user@yourdomain.com

# =============================================================================
# GOOGLE ADS API SETTINGS
# =============================================================================

# Developer token from Google Ads API Center (REQUIRED)
# Obtain at: https://ads.google.com/aw/apicenter
GOOGLE_ADS_DEVELOPER_TOKEN=YOUR_DEVELOPER_TOKEN

# Customer ID for authorized customer (without hyphens)
# Example: 1234567890 (not 123-456-7890)
GOOGLE_ADS_LOGIN_CUSTOMER_ID=

# Linked customer ID (only for methods updating resources via Linked Accounts)
# Used when data provider updates resources of specified customer
# GOOGLE_ADS_LINKED_CUSTOMER_ID=

# =============================================================================
# GOOGLE CLOUD PROJECT SETTINGS
# =============================================================================

# Path to service account credentials JSON
GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/credentials.json

# Google Cloud project ID
GOOGLE_PROJECT_ID=YOUR_PROJECT_ID

# =============================================================================
# ACCESS LEVELS
# =============================================================================
# Developer token access levels determine rate limits:
#
# | Level        | Description                        | Rate Limits |
# |--------------+------------------------------------+-------------|
# | Test Account | Test accounts only                 | Limited     |
# | Basic        | Standard production access         | ~15k/day    |
# | Standard     | Full capabilities                  | Higher      |
#
# Apply for access at: https://ads.google.com/aw/apicenter

# =============================================================================
# EXAMPLE CONFIGURATIONS
# =============================================================================

# --- Interactive Development (OAuth2 Application Mode) ---
# GOOGLE_ADS_CLIENT_ID=123456789.apps.googleusercontent.com
# GOOGLE_ADS_CLIENT_SECRET=your-secret
# GOOGLE_ADS_DEVELOPER_TOKEN=your-22-char-token
# GOOGLE_ADS_LOGIN_CUSTOMER_ID=1234567890

# --- Automated/Scheduled Tasks (Service Account Mode) ---
# GOOGLE_ADS_JSON_KEY_FILE_PATH=/home/user/.config/adtap/service-account.json
# GOOGLE_ADS_IMPERSONATED_EMAIL=ads-admin@company.com
# GOOGLE_ADS_DEVELOPER_TOKEN=your-22-char-token
# GOOGLE_ADS_LOGIN_CUSTOMER_ID=1234567890

# =============================================================================
# BIGQUERY INTEGRATION (Alternative/Complement for Read-Only Analysis)
# =============================================================================
# For historical data analysis, consider BigQuery Data Transfer Service
# Reference: https://cloud.google.com/bigquery/docs/google-ads-transfer
#
# When to use BigQuery vs adtap:
# - BigQuery: Historical reporting, scheduled transfers, SQL analysis
# - adtap: Real-time exploration, ad-hoc queries, CLI workflows

# BigQuery project for data exports
# ADTAP_BIGQUERY_PROJECT=your-project-id

# Dataset for staging adtap exports
# ADTAP_BIGQUERY_DATASET=google_ads_staging

# BigQuery location (US, EU, etc.)
# ADTAP_BIGQUERY_LOCATION=US

# Auto-load exports to BigQuery after adtap export commands
# ADTAP_BIGQUERY_AUTO_LOAD=false

# =============================================================================
# EXPORT HOOKS
# =============================================================================
# Commands to run after export operations

# Post-export hook (runs after adtap export completes)
# Example: load to BigQuery, sync to S3, notify Slack
# ADTAP_POST_EXPORT_HOOK="bq load --source_format=NEWLINE_DELIMITED_JSON"

# Post-query hook (runs after adtap query with -o output)
# ADTAP_POST_QUERY_HOOK=""