Embulk input plugin for Google Analytics reports.
- json_key_content: See example config.
- view_id: View ID for target data. You can find it on Google Analytics page (you need a permission to access Admin page (string, required)
- time_series: Only
ga:dateHour
orga:date
(string, required) - dimensions: Target dimensions (array, default:
[]
) - metrics: Target metrics (array, default:
[]
) - start_date: Target report start date. Valid format is "YYYY-MM-DD". (string, default: 7 days ago)
- end_date: Target report end date. Valid format is "YYYY-MM-DD". (string, default: 1 day ago)
- incremental:
true
for generate "config_diff" withembulk run -c config.diff
(bool, default: true) - last_record_time: Ignore fetched records until this time. Mainly for incremental:true. (string, default: nil)
- retry_limit: Try to retry this times (integer, default: 5)
- retry_initial_wait_sec: Wait seconds for exponential backoff initial value (integer, default: 2)
You need a service account on Google.
- Open the Service accounts page. If prompted, select a project.
- Click Create service account.
-
In the <b>Create service account</b> window, type a name for the service account, and select <b>Furnish a new private key</b>. If you want to <a href="https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority">grant Google Apps domain-wide authority</a> to the service account, also select <b>Enable Google Apps Domain-wide Delegation</b>. Then click <b>Create</b>.</li>
Google Reporting API uses "sampling" data.
- https://developers.google.com/analytics/devguides/reporting/core/v4/basics#sampling
- https://support.google.com/analytics/answer/2637192
That means sometimes result will be unmatched with Google Analytics web interface, and the result is based on sampled data, not all of raw data. This is a Google API's limitation.
Currently a sampling level supported by this plugin is DEFAULT only. Let us know if you want to use other sampling level (SMALL or LARGE).
in:
type: google_analytics
json_key_content: |
{
"type": "service_account",
"project_id": "....",
"private_key_id": "....",
"private_key": "-----BEGIN PRIVATE KEY-----\n..........................\n-----END PRIVATE KEY-----\n",
"client_email": ".....",
"client_id": ".........",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://accounts.google.com/o/oauth2/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": ".........."
}
view_id: 123111111
time_series: "ga:dateHour" # hourly basis
# https://developers.google.com/analytics/devguides/reporting/core/dimsmets
dimensions:
- "ga:browser"
metrics:
- "ga:visits"
- "ga:pageviews"
start_date: "2016-06-27"
end_date: "2016-06-28"
$ rake