mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2025-12-30 16:18:49 +01:00
178 lines
11 KiB
Markdown
178 lines
11 KiB
Markdown
<!---
|
|
DO NOT EDIT !
|
|
This file was generated automatically from 'src/mako/cli/README.md.mako'
|
|
DO NOT EDIT !
|
|
-->
|
|
The `mapsengine1` command-line interface *(CLI)* allows to use most features of the *Google Maps Engine* service from the comfort of your terminal.
|
|
|
|
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.
|
|
|
|
If data-structures are requested, these will be returned as pretty-printed JSON, to be useful as input to other tools.
|
|
|
|
# Usage
|
|
|
|
This documentation was generated from the *Maps Engine* API at revision *20150414*. The CLI is at version *0.1.0*.
|
|
|
|
```bash
|
|
mapsengine1 [options] assets get <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] assets list [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] assets parents-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] assets permissions-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers cancel-processing <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers create -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers delete <id> [-p <v>...]
|
|
mapsengine1 [options] layers get <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers get-published <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers list [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers list-published [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers parents-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers patch <id> -r <kv>... [-p <v>...]
|
|
mapsengine1 [options] layers permissions-batch-delete <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers permissions-batch-update <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers permissions-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers process <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers publish <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] layers unpublish <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] maps create -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] maps delete <id> [-p <v>...]
|
|
mapsengine1 [options] maps get <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] maps get-published <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] maps list [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] maps list-published [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] maps patch <id> -r <kv>... [-p <v>...]
|
|
mapsengine1 [options] maps permissions-batch-delete <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] maps permissions-batch-update <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] maps permissions-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] maps publish <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] maps unpublish <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] projects icons-create <project-id> -r <kv>... -u (simple|resumable) <file> <mime> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] projects icons-get <project-id> <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] projects icons-list <project-id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] projects list [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections cancel-processing <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections create -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections delete <id> [-p <v>...]
|
|
mapsengine1 [options] raster-collections get <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections list [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections parents-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections patch <id> -r <kv>... [-p <v>...]
|
|
mapsengine1 [options] raster-collections permissions-batch-delete <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections permissions-batch-update <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections permissions-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections process <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections rasters-batch-delete <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections rasters-batch-insert <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] raster-collections rasters-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] rasters delete <id> [-p <v>...]
|
|
mapsengine1 [options] rasters files-insert <id> <filename> -u (simple|resumable) <file> <mime> [-p <v>...]
|
|
mapsengine1 [options] rasters get <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] rasters list <project-id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] rasters parents-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] rasters patch <id> -r <kv>... [-p <v>...]
|
|
mapsengine1 [options] rasters permissions-batch-delete <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] rasters permissions-batch-update <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] rasters permissions-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] rasters process <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] rasters upload -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables create -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables delete <id> [-p <v>...]
|
|
mapsengine1 [options] tables features-batch-delete <id> -r <kv>... [-p <v>...]
|
|
mapsengine1 [options] tables features-batch-insert <id> -r <kv>... [-p <v>...]
|
|
mapsengine1 [options] tables features-batch-patch <id> -r <kv>... [-p <v>...]
|
|
mapsengine1 [options] tables features-get <table-id> <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables features-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables files-insert <id> <filename> -u (simple|resumable) <file> <mime> [-p <v>...]
|
|
mapsengine1 [options] tables get <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables list [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables parents-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables patch <id> -r <kv>... [-p <v>...]
|
|
mapsengine1 [options] tables permissions-batch-delete <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables permissions-batch-update <id> -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables permissions-list <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables process <id> [-p <v>...] [-o <out>]
|
|
mapsengine1 [options] tables upload -r <kv>... [-p <v>...] [-o <out>]
|
|
mapsengine1 --help
|
|
|
|
All documentation details can be found at
|
|
http://byron.github.io/google-apis-rs/google_mapsengine1_cli/index.html
|
|
|
|
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]
|
|
--debug
|
|
Output all server communication to standard error. `tx` and `rx` are placed
|
|
into the same stream.
|
|
--debug-auth
|
|
Output all communication related to authentication to standard error. `tx`
|
|
and `rx` are placed into the same stream.
|
|
|
|
```
|
|
|
|
# Configuration
|
|
|
|
The program will store all persistent data in the `~/.google-service-cli` directory in *JSON* files prefixed with `mapsengine1-`. You can change the directory used to store configuration with the `--config-dir` flag on a per-invocation basis.
|
|
|
|
More information about the various kinds of persistent data are given in the following paragraphs.
|
|
|
|
# Authentication
|
|
|
|
Most APIs require a user to authenticate any request. If this is the case, the [scope][scopes] determines the
|
|
set of permissions granted. The granularity of these is usually no more than *read-only* or *full-access*.
|
|
|
|
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 `--scope` flag to specify a scope directly.
|
|
All applicable scopes are documented in the respective method's CLI documentation.
|
|
|
|
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.
|
|
|
|
If a scope was authenticated by the user, the respective information will be stored as *JSON* in the configuration
|
|
directory, e.g. `~/.google-service-cli/mapsengine1-token-<scope-hash>.json`. No manual management of these tokens
|
|
is necessary.
|
|
|
|
To revoke granted authentication, please refer to the [official documentation][revoke-access].
|
|
|
|
# Application Secrets
|
|
|
|
In order to allow any application to use Google services, it will need to be registered using the
|
|
[Google Developer Console][google-dev-console]. 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.
|
|
|
|
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.
|
|
|
|
You can workaround this limitation by putting your own secrets file at this location:
|
|
`~/.google-service-cli/mapsengine1-secret.json`, assuming that the required *mapsengine* API
|
|
was enabled for it. Such a secret file can be downloaded in the *Google Developer Console* at
|
|
*APIs & auth -> Credentials -> Download JSON* and used as is.
|
|
|
|
Learn more about how to setup Google projects and enable APIs using the [official documentation][google-project-new].
|
|
|
|
|
|
# Debugging
|
|
|
|
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 *as-is*.
|
|
|
|
The `--debug` flag will print all client-server communication to standard error, whereas the `--debug-auth` flag
|
|
will cause all communication related to authentication to standard error.
|
|
If the `--debug` flag is set, error-results will be debug-printed, possibly yielding more information about the
|
|
issue at hand.
|
|
|
|
You may consider redirecting standard error into a file for ease of use, e.g. `mapsengine1 --debug <resource> <method> [options] 2>debug.txt`.
|
|
|
|
|
|
[scopes]: https://developers.google.com/+/api/oauth#scopes
|
|
[revoke-access]: http://webapps.stackexchange.com/a/30849
|
|
[google-dev-console]: https://console.developers.google.com/
|
|
[google-project-new]: https://developers.google.com/console/help/new/ |