Skip to content

Commit

Permalink
fix(version-up): code updated to v0.1.6, latest CLI
Browse files Browse the repository at this point in the history
* also includes publishing tag files
  • Loading branch information
Byron committed Apr 26, 2015
1 parent 4e275ea commit c2dd9c7
Show file tree
Hide file tree
Showing 770 changed files with 62,766 additions and 30,853 deletions.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
2 changes: 1 addition & 1 deletion gen/adexchangebuyer1d3-cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[package]

name = "google-adexchangebuyer1d3-cli"
version = "0.0.1+20150326"
version = "0.1.0+20150326"
authors = ["Sebastian Thiel <[email protected]>"]
description = "A complete library to interact with Ad Exchange Buyer (protocol v1.3)"
repository = "https://github.com/Byron/google-apis-rs/tree/master/gen/adexchangebuyer1d3-cli"
Expand Down
122 changes: 120 additions & 2 deletions gen/adexchangebuyer1d3-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,122 @@
# HELLO ADEXCHANGEBUYER:V1.3
<!---
DO NOT EDIT !
This file was generated automatically from 'src/mako/cli/README.md.mako'
DO NOT EDIT !
-->
The `adexchangebuyer1d3` command-line interface *(CLI)* allows to use most features of the *Google Ad Exchange Buyer* 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.

Include information about application secret files, and how we automatically write a default one.
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 *Ad Exchange Buyer* API at revision *20150326*. The CLI is at version *0.1.0*.

```bash
adexchangebuyer1d3 [options] accounts get <id> [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] accounts list [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] accounts patch <id> -r <kv>... [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] accounts update <id> -r <kv>... [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] billing-info get <account-id> [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] billing-info list [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] budget get <account-id> <billing-id> [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] budget patch <account-id> <billing-id> -r <kv>... [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] budget update <account-id> <billing-id> -r <kv>... [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] creatives get <account-id> <buyer-creative-id> [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] creatives insert -r <kv>... [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] creatives list [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] direct-deals get <id> [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] direct-deals list [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] performance-report list <account-id> <end-date-time> <start-date-time> [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] pretargeting-config delete <account-id> <config-id> [-p <v>...]
adexchangebuyer1d3 [options] pretargeting-config get <account-id> <config-id> [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] pretargeting-config insert <account-id> -r <kv>... [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] pretargeting-config list <account-id> [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] pretargeting-config patch <account-id> <config-id> -r <kv>... [-p <v>...] [-o <out>]
adexchangebuyer1d3 [options] pretargeting-config update <account-id> <config-id> -r <kv>... [-p <v>...] [-o <out>]
adexchangebuyer1d3 --help

All documentation details can be found at
http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3_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 `adexchangebuyer1d3-`. 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/adexchangebuyer1d3-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/adexchangebuyer1d3-secret.json`, assuming that the required *adexchangebuyer* 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. `adexchangebuyer1d3 --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/
2 changes: 1 addition & 1 deletion gen/adexchangebuyer1d3-cli/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: Ad Exchange Buyer v0.0.1+20150326
site_name: Ad Exchange Buyer v0.1.0+20150326
site_url: http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3-cli
site_description: Write integrating applications with bcore

Expand Down
2 changes: 1 addition & 1 deletion gen/adexchangebuyer1d3-cli/src/cmn.rs
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ pub fn parse_kv_arg<'a>(kv: &'a str, err: &mut InvalidOptionsError, for_hashmap:
let key = &kv[..pos];
if kv.len() <= pos + 1 {
add_err();
return (key, None)
return (key, Some(""))
}
(key, Some(&kv[pos+1..]))
}
Expand Down
Loading

0 comments on commit c2dd9c7

Please sign in to comment.