mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
750 lines
37 KiB
HTML
750 lines
37 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>analytics v3.0.0+20190807</title>
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="./css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="./css/highlight.css">
|
|
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
|
<script type="text/javascript" src="./js/highlight.pack.js"></script>
|
|
<script src="./js/theme.js"></script>
|
|
|
|
<style>
|
|
body {font-size: 90%;}
|
|
pre, code {font-size: 100%;}
|
|
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
|
</style>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href="." class="icon icon-home"> analytics v3.0.0+20190807</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Data</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="data_ga-get/">Ga Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="data_mcf-get/">Mcf Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="data_realtime-get/">Realtime Get</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Management</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_account-summaries-list/">Account Summaries List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_account-user-links-delete/">Account User Links Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_account-user-links-insert/">Account User Links Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_account-user-links-list/">Account User Links List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_account-user-links-update/">Account User Links Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_accounts-list/">Accounts List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_client-id-hash-client-id/">Client Id Hash Client Id</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-data-sources-list/">Custom Data Sources List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-dimensions-get/">Custom Dimensions Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-dimensions-insert/">Custom Dimensions Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-dimensions-list/">Custom Dimensions List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-dimensions-patch/">Custom Dimensions Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-dimensions-update/">Custom Dimensions Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-metrics-get/">Custom Metrics Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-metrics-insert/">Custom Metrics Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-metrics-list/">Custom Metrics List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-metrics-patch/">Custom Metrics Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_custom-metrics-update/">Custom Metrics Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_experiments-delete/">Experiments Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_experiments-get/">Experiments Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_experiments-insert/">Experiments Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_experiments-list/">Experiments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_experiments-patch/">Experiments Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_experiments-update/">Experiments Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_filters-delete/">Filters Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_filters-get/">Filters Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_filters-insert/">Filters Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_filters-list/">Filters List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_filters-patch/">Filters Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_filters-update/">Filters Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_goals-get/">Goals Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_goals-insert/">Goals Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_goals-list/">Goals List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_goals-patch/">Goals Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_goals-update/">Goals Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profile-filter-links-delete/">Profile Filter Links Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profile-filter-links-get/">Profile Filter Links Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profile-filter-links-insert/">Profile Filter Links Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profile-filter-links-list/">Profile Filter Links List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profile-filter-links-patch/">Profile Filter Links Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profile-filter-links-update/">Profile Filter Links Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profile-user-links-delete/">Profile User Links Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profile-user-links-insert/">Profile User Links Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profile-user-links-list/">Profile User Links List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profile-user-links-update/">Profile User Links Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profiles-delete/">Profiles Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profiles-get/">Profiles Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profiles-insert/">Profiles Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profiles-list/">Profiles List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profiles-patch/">Profiles Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_profiles-update/">Profiles Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_remarketing-audience-delete/">Remarketing Audience Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_remarketing-audience-get/">Remarketing Audience Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_remarketing-audience-insert/">Remarketing Audience Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_remarketing-audience-list/">Remarketing Audience List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_remarketing-audience-patch/">Remarketing Audience Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_remarketing-audience-update/">Remarketing Audience Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_segments-list/">Segments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_unsampled-reports-delete/">Unsampled Reports Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_unsampled-reports-get/">Unsampled Reports Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_unsampled-reports-insert/">Unsampled Reports Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_unsampled-reports-list/">Unsampled Reports List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_uploads-delete-upload-data/">Uploads Delete Upload Data</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_uploads-get/">Uploads Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_uploads-list/">Uploads List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_uploads-upload-data/">Uploads Upload Data</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_web-property-ad-words-links-delete/">Web Property Ad Words Links Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_web-property-ad-words-links-get/">Web Property Ad Words Links Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_web-property-ad-words-links-insert/">Web Property Ad Words Links Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_web-property-ad-words-links-list/">Web Property Ad Words Links List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_web-property-ad-words-links-patch/">Web Property Ad Words Links Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_web-property-ad-words-links-update/">Web Property Ad Words Links Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_webproperties-get/">Webproperties Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_webproperties-insert/">Webproperties Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_webproperties-list/">Webproperties List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_webproperties-patch/">Webproperties Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_webproperties-update/">Webproperties Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_webproperty-user-links-delete/">Webproperty User Links Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_webproperty-user-links-insert/">Webproperty User Links Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_webproperty-user-links-list/">Webproperty User Links List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="management_webproperty-user-links-update/">Webproperty User Links Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Metadata</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="metadata_columns-list/">Columns List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Provisioning</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="provisioning_create-account-ticket/">Create Account Ticket</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="provisioning_create-account-tree/">Create Account Tree</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>User Deletion</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="user-deletion_user-deletion-request-upsert/">User Deletion Request Upsert</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href="."></a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".">Docs</a> »</li>
|
|
<li>Home</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/analytics3-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<!---
|
|
DO NOT EDIT !
|
|
This file was generated automatically from 'src/mako/cli/README.md.mako'
|
|
DO NOT EDIT !
|
|
-->
|
|
|
|
<p>The <code>analytics3</code> command-line interface <em>(CLI)</em> allows to use most features of the <em>Google analytics</em> service from the comfort of your terminal.</p>
|
|
<p>By default all output is printed to standard out, but flags can be set to direct it into a file independent of your shell's
|
|
capabilities. Errors will be printed to standard error, and cause the program's exit code to be non-zero.</p>
|
|
<p>If data-structures are requested, these will be returned as pretty-printed JSON, to be useful as input to other tools.</p>
|
|
<p>Everything else about the <em>analytics</em> API can be found at the
|
|
<a href="https://developers.google.com/analytics/">official documentation site</a>.</p>
|
|
<h1 id="installation-and-source-code">Installation and Source Code</h1>
|
|
<p>Install the command-line interface with cargo using:</p>
|
|
<pre><code class="bash">cargo install google-analytics3-cli
|
|
</code></pre>
|
|
|
|
<p>Find the source code <a href="https://github.com/Byron/google-apis-rs/tree/main/gen/analytics3-cli">on github</a>.</p>
|
|
<h1 id="usage">Usage</h1>
|
|
<p>This documentation was generated from the <em>analytics</em> API at revision <em>20190807</em>. The CLI is at version <em>3.0.0</em>.</p>
|
|
<pre><code class="bash">analytics3 [options]
|
|
data
|
|
ga-get <ids> <start-date> <end-date> <metrics> [-p <v>]... [-o <out>]
|
|
mcf-get <ids> <start-date> <end-date> <metrics> [-p <v>]... [-o <out>]
|
|
realtime-get <ids> <metrics> [-p <v>]... [-o <out>]
|
|
management
|
|
account-summaries-list [-p <v>]... [-o <out>]
|
|
account-user-links-delete <account-id> <link-id> [-p <v>]...
|
|
account-user-links-insert <account-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
account-user-links-list <account-id> [-p <v>]... [-o <out>]
|
|
account-user-links-update <account-id> <link-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
accounts-list [-p <v>]... [-o <out>]
|
|
client-id-hash-client-id (-r <kv>)... [-p <v>]... [-o <out>]
|
|
custom-data-sources-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
|
|
custom-dimensions-get <account-id> <web-property-id> <custom-dimension-id> [-p <v>]... [-o <out>]
|
|
custom-dimensions-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
custom-dimensions-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
|
|
custom-dimensions-patch <account-id> <web-property-id> <custom-dimension-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
custom-dimensions-update <account-id> <web-property-id> <custom-dimension-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
custom-metrics-get <account-id> <web-property-id> <custom-metric-id> [-p <v>]... [-o <out>]
|
|
custom-metrics-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
custom-metrics-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
|
|
custom-metrics-patch <account-id> <web-property-id> <custom-metric-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
custom-metrics-update <account-id> <web-property-id> <custom-metric-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
experiments-delete <account-id> <web-property-id> <profile-id> <experiment-id> [-p <v>]...
|
|
experiments-get <account-id> <web-property-id> <profile-id> <experiment-id> [-p <v>]... [-o <out>]
|
|
experiments-insert <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
experiments-list <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
|
|
experiments-patch <account-id> <web-property-id> <profile-id> <experiment-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
experiments-update <account-id> <web-property-id> <profile-id> <experiment-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
filters-delete <account-id> <filter-id> [-p <v>]... [-o <out>]
|
|
filters-get <account-id> <filter-id> [-p <v>]... [-o <out>]
|
|
filters-insert <account-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
filters-list <account-id> [-p <v>]... [-o <out>]
|
|
filters-patch <account-id> <filter-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
filters-update <account-id> <filter-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
goals-get <account-id> <web-property-id> <profile-id> <goal-id> [-p <v>]... [-o <out>]
|
|
goals-insert <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
goals-list <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
|
|
goals-patch <account-id> <web-property-id> <profile-id> <goal-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
goals-update <account-id> <web-property-id> <profile-id> <goal-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
profile-filter-links-delete <account-id> <web-property-id> <profile-id> <link-id> [-p <v>]...
|
|
profile-filter-links-get <account-id> <web-property-id> <profile-id> <link-id> [-p <v>]... [-o <out>]
|
|
profile-filter-links-insert <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
profile-filter-links-list <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
|
|
profile-filter-links-patch <account-id> <web-property-id> <profile-id> <link-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
profile-filter-links-update <account-id> <web-property-id> <profile-id> <link-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
profile-user-links-delete <account-id> <web-property-id> <profile-id> <link-id> [-p <v>]...
|
|
profile-user-links-insert <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
profile-user-links-list <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
|
|
profile-user-links-update <account-id> <web-property-id> <profile-id> <link-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
profiles-delete <account-id> <web-property-id> <profile-id> [-p <v>]...
|
|
profiles-get <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
|
|
profiles-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
profiles-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
|
|
profiles-patch <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
profiles-update <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
remarketing-audience-delete <account-id> <web-property-id> <remarketing-audience-id> [-p <v>]...
|
|
remarketing-audience-get <account-id> <web-property-id> <remarketing-audience-id> [-p <v>]... [-o <out>]
|
|
remarketing-audience-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
remarketing-audience-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
|
|
remarketing-audience-patch <account-id> <web-property-id> <remarketing-audience-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
remarketing-audience-update <account-id> <web-property-id> <remarketing-audience-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
segments-list [-p <v>]... [-o <out>]
|
|
unsampled-reports-delete <account-id> <web-property-id> <profile-id> <unsampled-report-id> [-p <v>]...
|
|
unsampled-reports-get <account-id> <web-property-id> <profile-id> <unsampled-report-id> [-p <v>]... [-o <out>]
|
|
unsampled-reports-insert <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
unsampled-reports-list <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
|
|
uploads-delete-upload-data <account-id> <web-property-id> <custom-data-source-id> (-r <kv>)... [-p <v>]...
|
|
uploads-get <account-id> <web-property-id> <custom-data-source-id> <upload-id> [-p <v>]... [-o <out>]
|
|
uploads-list <account-id> <web-property-id> <custom-data-source-id> [-p <v>]... [-o <out>]
|
|
uploads-upload-data <account-id> <web-property-id> <custom-data-source-id> (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
|
|
web-property-ad-words-links-delete <account-id> <web-property-id> <web-property-ad-words-link-id> [-p <v>]...
|
|
web-property-ad-words-links-get <account-id> <web-property-id> <web-property-ad-words-link-id> [-p <v>]... [-o <out>]
|
|
web-property-ad-words-links-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
web-property-ad-words-links-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
|
|
web-property-ad-words-links-patch <account-id> <web-property-id> <web-property-ad-words-link-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
web-property-ad-words-links-update <account-id> <web-property-id> <web-property-ad-words-link-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
webproperties-get <account-id> <web-property-id> [-p <v>]... [-o <out>]
|
|
webproperties-insert <account-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
webproperties-list <account-id> [-p <v>]... [-o <out>]
|
|
webproperties-patch <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
webproperties-update <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
webproperty-user-links-delete <account-id> <web-property-id> <link-id> [-p <v>]...
|
|
webproperty-user-links-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
webproperty-user-links-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
|
|
webproperty-user-links-update <account-id> <web-property-id> <link-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
metadata
|
|
columns-list <report-type> [-p <v>]... [-o <out>]
|
|
provisioning
|
|
create-account-ticket (-r <kv>)... [-p <v>]... [-o <out>]
|
|
create-account-tree (-r <kv>)... [-p <v>]... [-o <out>]
|
|
user-deletion
|
|
user-deletion-request-upsert (-r <kv>)... [-p <v>]... [-o <out>]
|
|
analytics3 --help
|
|
|
|
Configuration:
|
|
[--scope <url>]...
|
|
Specify the authentication a method should be executed in. Each scope
|
|
requires the user to grant this application permission to use it.
|
|
If unset, it defaults to the shortest scope url for a particular method.
|
|
--config-dir <folder>
|
|
A directory into which we will store our persistent data. Defaults to
|
|
a user-writable directory that we will create during the first invocation.
|
|
[default: ~/.google-service-cli]
|
|
|
|
</code></pre>
|
|
|
|
<h1 id="configuration">Configuration</h1>
|
|
<p>The program will store all persistent data in the <code>~/.google-service-cli</code> directory in <em>JSON</em> files prefixed with <code>analytics3-</code>. You can change the directory used to store configuration with the <code>--config-dir</code> flag on a per-invocation basis.</p>
|
|
<p>More information about the various kinds of persistent data are given in the following paragraphs.</p>
|
|
<h1 id="authentication">Authentication</h1>
|
|
<p>Most APIs require a user to authenticate any request. If this is the case, the <a href="https://developers.google.com/+/api/oauth#scopes">scope</a> determines the
|
|
set of permissions granted. The granularity of these is usually no more than <em>read-only</em> or <em>full-access</em>.</p>
|
|
<p>If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a
|
|
method that is read-only, it will ask only for a read-only scope.
|
|
You may use the <code>--scope</code> flag to specify a scope directly.
|
|
All applicable scopes are documented in the respective method's CLI documentation.</p>
|
|
<p>The first time a scope is used, the user is asked for permission. Follow the instructions given
|
|
by the CLI to grant permissions, or to decline.</p>
|
|
<p>If a scope was authenticated by the user, the respective information will be stored as <em>JSON</em> in the configuration
|
|
directory, e.g. <code>~/.google-service-cli/analytics3-token-<scope-hash>.json</code>. No manual management of these tokens
|
|
is necessary.</p>
|
|
<p>To revoke granted authentication, please refer to the <a href="http://webapps.stackexchange.com/a/30849">official documentation</a>.</p>
|
|
<h1 id="application-secrets">Application Secrets</h1>
|
|
<p>In order to allow any application to use Google services, it will need to be registered using the
|
|
<a href="https://console.developers.google.com/">Google Developer Console</a>. APIs the application may use are then enabled for it
|
|
one by one. Most APIs can be used for free and have a daily quota.</p>
|
|
<p>To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI
|
|
comes with a default application secret that is configured accordingly. This also means that heavy usage
|
|
all around the world may deplete the daily quota.</p>
|
|
<p>You can workaround this limitation by putting your own secrets file at this location:
|
|
<code>~/.google-service-cli/analytics3-secret.json</code>, assuming that the required <em>analytics</em> API
|
|
was enabled for it. Such a secret file can be downloaded in the <em>Google Developer Console</em> at
|
|
<em>APIs & auth -> Credentials -> Download JSON</em> and used as is.</p>
|
|
<p>Learn more about how to setup Google projects and enable APIs using the <a href="https://developers.google.com/console/help/new/">official documentation</a>.</p>
|
|
<h1 id="debugging">Debugging</h1>
|
|
<p>Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know
|
|
what exactly led to a particular issue. This is done by allowing all client-server communication to be
|
|
output to standard error <em>as-is</em>.</p>
|
|
<p>The <code>--debug</code> flag will print errors using the <code>Debug</code> representation to standard error.</p>
|
|
<p>You may consider redirecting standard error into a file for ease of use, e.g. <code>analytics3 --debug <resource> <method> [options] 2>debug.txt</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="data_ga-get/" class="btn btn-neutral float-right" title="Ga Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
<!-- Copyright etc -->
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
<span><a href="" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="data_ga-get/" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |